Amazonka.SageMaker.DescribeMonitoringSchedule

Describes the schedule for a monitoring job.

Creating a Request

data DescribeMonitoringSchedule

See: newDescribeMonitoringSchedule smart constructor.

Constructors

DescribeMonitoringSchedule'

Fields

• monitoringScheduleName :: Text

  Name of a previously created monitoring schedule.

Instances

ToJSON DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

toJSON :: DescribeMonitoringSchedule -> Value

toEncoding :: DescribeMonitoringSchedule -> Encoding

toJSONList :: [DescribeMonitoringSchedule] -> Value

toEncodingList :: [DescribeMonitoringSchedule] -> Encoding

ToHeaders DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

toHeaders :: DescribeMonitoringSchedule -> [Header]

ToPath DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

toPath :: DescribeMonitoringSchedule -> ByteString

ToQuery DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

toQuery :: DescribeMonitoringSchedule -> QueryString

AWSRequest DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Associated Types

type AWSResponse DescribeMonitoringSchedule

Methods

request :: (Service -> Service) -> DescribeMonitoringSchedule -> Request DescribeMonitoringSchedule

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeMonitoringSchedule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMonitoringSchedule)))

Generic DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Associated Types

type Rep DescribeMonitoringSchedule :: Type -> Type

Methods

from :: DescribeMonitoringSchedule -> Rep DescribeMonitoringSchedule x

to :: Rep DescribeMonitoringSchedule x -> DescribeMonitoringSchedule

Read DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

readsPrec :: Int -> ReadS DescribeMonitoringSchedule

readList :: ReadS [DescribeMonitoringSchedule]

readPrec :: ReadPrec DescribeMonitoringSchedule

readListPrec :: ReadPrec [DescribeMonitoringSchedule]

Show DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

showsPrec :: Int -> DescribeMonitoringSchedule -> ShowS

show :: DescribeMonitoringSchedule -> String

showList :: [DescribeMonitoringSchedule] -> ShowS

NFData DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

rnf :: DescribeMonitoringSchedule -> ()

Eq DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

(==) :: DescribeMonitoringSchedule -> DescribeMonitoringSchedule -> Bool

(/=) :: DescribeMonitoringSchedule -> DescribeMonitoringSchedule -> Bool

Hashable DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

hashWithSalt :: Int -> DescribeMonitoringSchedule -> Int

hash :: DescribeMonitoringSchedule -> Int

type AWSResponse DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

type AWSResponse DescribeMonitoringSchedule = DescribeMonitoringScheduleResponse

type Rep DescribeMonitoringSchedule

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

type Rep DescribeMonitoringSchedule = D1 ('MetaData "DescribeMonitoringSchedule" "Amazonka.SageMaker.DescribeMonitoringSchedule" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeMonitoringSchedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitoringScheduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeMonitoringSchedule

Arguments

:: Text

DescribeMonitoringSchedule

-> DescribeMonitoringSchedule

Create a value of DescribeMonitoringSchedule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeMonitoringSchedule, describeMonitoringSchedule_monitoringScheduleName - Name of a previously created monitoring schedule.

Request Lenses

describeMonitoringSchedule_monitoringScheduleName :: Lens' DescribeMonitoringSchedule Text

Name of a previously created monitoring schedule.

Destructuring the Response

data DescribeMonitoringScheduleResponse

See: newDescribeMonitoringScheduleResponse smart constructor.

Constructors

DescribeMonitoringScheduleResponse'

Fields

• endpointName :: Maybe Text

  The name of the endpoint for the monitoring job.

• failureReason :: Maybe Text

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

• lastMonitoringExecutionSummary :: Maybe MonitoringExecutionSummary

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

• monitoringType :: Maybe MonitoringType

  The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.
  • MODEL_QUALITY - The schedule is for a model quality monitoring job.
  • MODEL_BIAS - The schedule is for a bias monitoring job.
  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.
• httpStatus :: Int

  The response's http status code.

• monitoringScheduleArn :: Text

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

• monitoringScheduleName :: Text

  Name of the monitoring schedule.

• monitoringScheduleStatus :: ScheduleStatus

  The status of an monitoring job.

• creationTime :: POSIX

  The time at which the monitoring job was created.

• lastModifiedTime :: POSIX

  The time at which the monitoring job was last modified.

• monitoringScheduleConfig :: MonitoringScheduleConfig

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

Instances

Generic DescribeMonitoringScheduleResponse

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Associated Types

type Rep DescribeMonitoringScheduleResponse :: Type -> Type

Methods

from :: DescribeMonitoringScheduleResponse -> Rep DescribeMonitoringScheduleResponse x

to :: Rep DescribeMonitoringScheduleResponse x -> DescribeMonitoringScheduleResponse

Read DescribeMonitoringScheduleResponse

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

readsPrec :: Int -> ReadS DescribeMonitoringScheduleResponse

readList :: ReadS [DescribeMonitoringScheduleResponse]

readPrec :: ReadPrec DescribeMonitoringScheduleResponse

readListPrec :: ReadPrec [DescribeMonitoringScheduleResponse]

Show DescribeMonitoringScheduleResponse

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

showsPrec :: Int -> DescribeMonitoringScheduleResponse -> ShowS

show :: DescribeMonitoringScheduleResponse -> String

showList :: [DescribeMonitoringScheduleResponse] -> ShowS

NFData DescribeMonitoringScheduleResponse

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

rnf :: DescribeMonitoringScheduleResponse -> ()

Eq DescribeMonitoringScheduleResponse

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

Methods

(==) :: DescribeMonitoringScheduleResponse -> DescribeMonitoringScheduleResponse -> Bool

(/=) :: DescribeMonitoringScheduleResponse -> DescribeMonitoringScheduleResponse -> Bool

type Rep DescribeMonitoringScheduleResponse

Defined in Amazonka.SageMaker.DescribeMonitoringSchedule

type Rep DescribeMonitoringScheduleResponse = D1 ('MetaData "DescribeMonitoringScheduleResponse" "Amazonka.SageMaker.DescribeMonitoringSchedule" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeMonitoringScheduleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastMonitoringExecutionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringExecutionSummary)) :*: (S1 ('MetaSel ('Just "monitoringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "monitoringScheduleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "monitoringScheduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "monitoringScheduleStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduleStatus))) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "monitoringScheduleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MonitoringScheduleConfig))))))

newDescribeMonitoringScheduleResponse

Arguments

:: Int

$sel:httpStatus:DescribeMonitoringScheduleResponse'

-> Text

DescribeMonitoringScheduleResponse

-> Text

DescribeMonitoringSchedule

-> ScheduleStatus

DescribeMonitoringScheduleResponse

-> UTCTime

DescribeMonitoringScheduleResponse

-> UTCTime

DescribeMonitoringScheduleResponse

-> MonitoringScheduleConfig

DescribeMonitoringScheduleResponse

-> DescribeMonitoringScheduleResponse

Create a value of DescribeMonitoringScheduleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_endpointName - The name of the endpoint for the monitoring job.

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

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

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_monitoringType - The type of the monitoring job that this schedule runs. This is one of the following values.

• DATA_QUALITY - The schedule is for a data quality monitoring job.
• MODEL_QUALITY - The schedule is for a model quality monitoring job.
• MODEL_BIAS - The schedule is for a bias monitoring job.
• MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

$sel:httpStatus:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_httpStatus - The response's http status code.

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_monitoringScheduleArn - The Amazon Resource Name (ARN) of the monitoring schedule.

DescribeMonitoringSchedule, describeMonitoringScheduleResponse_monitoringScheduleName - Name of the monitoring schedule.

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_monitoringScheduleStatus - The status of an monitoring job.

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_creationTime - The time at which the monitoring job was created.

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_lastModifiedTime - The time at which the monitoring job was last modified.

DescribeMonitoringScheduleResponse, describeMonitoringScheduleResponse_monitoringScheduleConfig - The configuration object that specifies the monitoring schedule and defines the monitoring job.

Response Lenses

describeMonitoringScheduleResponse_endpointName :: Lens' DescribeMonitoringScheduleResponse (Maybe Text)

The name of the endpoint for the monitoring job.

describeMonitoringScheduleResponse_failureReason :: Lens' DescribeMonitoringScheduleResponse (Maybe Text)

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

describeMonitoringScheduleResponse_lastMonitoringExecutionSummary :: Lens' DescribeMonitoringScheduleResponse (Maybe MonitoringExecutionSummary)

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

describeMonitoringScheduleResponse_monitoringType :: Lens' DescribeMonitoringScheduleResponse (Maybe MonitoringType)

The type of the monitoring job that this schedule runs. This is one of the following values.

• DATA_QUALITY - The schedule is for a data quality monitoring job.
• MODEL_QUALITY - The schedule is for a model quality monitoring job.
• MODEL_BIAS - The schedule is for a bias monitoring job.
• MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

describeMonitoringScheduleResponse_httpStatus :: Lens' DescribeMonitoringScheduleResponse Int

The response's http status code.

describeMonitoringScheduleResponse_monitoringScheduleArn :: Lens' DescribeMonitoringScheduleResponse Text

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

describeMonitoringScheduleResponse_monitoringScheduleName :: Lens' DescribeMonitoringScheduleResponse Text

Name of the monitoring schedule.

describeMonitoringScheduleResponse_monitoringScheduleStatus :: Lens' DescribeMonitoringScheduleResponse ScheduleStatus

The status of an monitoring job.

describeMonitoringScheduleResponse_creationTime :: Lens' DescribeMonitoringScheduleResponse UTCTime

The time at which the monitoring job was created.

describeMonitoringScheduleResponse_lastModifiedTime :: Lens' DescribeMonitoringScheduleResponse UTCTime

The time at which the monitoring job was last modified.

describeMonitoringScheduleResponse_monitoringScheduleConfig :: Lens' DescribeMonitoringScheduleResponse MonitoringScheduleConfig

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