Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.DescribeMonitoringSchedule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the schedule for a monitoring job.

Synopsis

Creating a Request

data DescribeMonitoringSchedule Source #

See: newDescribeMonitoringSchedule smart constructor.

Constructors

DescribeMonitoringSchedule'
Fields monitoringScheduleName :: Text Name of a previously created monitoring schedule.

Instances

Instances details

Eq DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods (==) :: DescribeMonitoringSchedule -> DescribeMonitoringSchedule -> Bool # (/=) :: DescribeMonitoringSchedule -> DescribeMonitoringSchedule -> Bool #
Read DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods readsPrec :: Int -> ReadS DescribeMonitoringSchedule # readList :: ReadS [DescribeMonitoringSchedule] # readPrec :: ReadPrec DescribeMonitoringSchedule # readListPrec :: ReadPrec [DescribeMonitoringSchedule] #
Show DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods showsPrec :: Int -> DescribeMonitoringSchedule -> ShowS # show :: DescribeMonitoringSchedule -> String # showList :: [DescribeMonitoringSchedule] -> ShowS #
Generic DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Associated Types type Rep DescribeMonitoringSchedule :: Type -> Type # Methods from :: DescribeMonitoringSchedule -> Rep DescribeMonitoringSchedule x # to :: Rep DescribeMonitoringSchedule x -> DescribeMonitoringSchedule #
NFData DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods rnf :: DescribeMonitoringSchedule -> () #
Hashable DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods hashWithSalt :: Int -> DescribeMonitoringSchedule -> Int # hash :: DescribeMonitoringSchedule -> Int #
ToJSON DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods toJSON :: DescribeMonitoringSchedule -> Value # toEncoding :: DescribeMonitoringSchedule -> Encoding # toJSONList :: [DescribeMonitoringSchedule] -> Value # toEncodingList :: [DescribeMonitoringSchedule] -> Encoding #
AWSRequest DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Associated Types type AWSResponse DescribeMonitoringSchedule # Methods request :: DescribeMonitoringSchedule -> Request DescribeMonitoringSchedule # response :: MonadResource m => Logger -> Service -> Proxy DescribeMonitoringSchedule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMonitoringSchedule))) #
ToHeaders DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods toHeaders :: DescribeMonitoringSchedule -> [Header] #
ToPath DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods toPath :: DescribeMonitoringSchedule -> ByteString #
ToQuery DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods toQuery :: DescribeMonitoringSchedule -> QueryString #
type Rep DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule type Rep DescribeMonitoringSchedule = D1 ('MetaData "DescribeMonitoringSchedule" "Amazonka.SageMaker.DescribeMonitoringSchedule" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeMonitoringSchedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitoringScheduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeMonitoringSchedule Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule type AWSResponse DescribeMonitoringSchedule = DescribeMonitoringScheduleResponse

newDescribeMonitoringSchedule Source #

Arguments

:: Text	`$sel:monitoringScheduleName: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:

$sel:monitoringScheduleName:DescribeMonitoringSchedule', describeMonitoringSchedule_monitoringScheduleName - Name of a previously created monitoring schedule.

Request Lenses

describeMonitoringSchedule_monitoringScheduleName :: Lens' DescribeMonitoringSchedule Text Source #

Name of a previously created monitoring schedule.

Destructuring the Response

data DescribeMonitoringScheduleResponse Source #

See: newDescribeMonitoringScheduleResponse smart constructor.

Constructors

DescribeMonitoringScheduleResponse'

Fields

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.
failureReason :: Maybe Text
A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
endpointName :: Maybe Text
The name of the endpoint for the monitoring job.
lastMonitoringExecutionSummary :: Maybe MonitoringExecutionSummary
Describes metadata on the last execution to run, if there was one.
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

Instances details

Eq DescribeMonitoringScheduleResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods (==) :: DescribeMonitoringScheduleResponse -> DescribeMonitoringScheduleResponse -> Bool # (/=) :: DescribeMonitoringScheduleResponse -> DescribeMonitoringScheduleResponse -> Bool #
Read DescribeMonitoringScheduleResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods readsPrec :: Int -> ReadS DescribeMonitoringScheduleResponse # readList :: ReadS [DescribeMonitoringScheduleResponse] # readPrec :: ReadPrec DescribeMonitoringScheduleResponse # readListPrec :: ReadPrec [DescribeMonitoringScheduleResponse] #
Show DescribeMonitoringScheduleResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods showsPrec :: Int -> DescribeMonitoringScheduleResponse -> ShowS # show :: DescribeMonitoringScheduleResponse -> String # showList :: [DescribeMonitoringScheduleResponse] -> ShowS #
Generic DescribeMonitoringScheduleResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Associated Types type Rep DescribeMonitoringScheduleResponse :: Type -> Type # Methods from :: DescribeMonitoringScheduleResponse -> Rep DescribeMonitoringScheduleResponse x # to :: Rep DescribeMonitoringScheduleResponse x -> DescribeMonitoringScheduleResponse #
NFData DescribeMonitoringScheduleResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule Methods rnf :: DescribeMonitoringScheduleResponse -> () #
type Rep DescribeMonitoringScheduleResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeMonitoringSchedule type Rep DescribeMonitoringScheduleResponse = D1 ('MetaData "DescribeMonitoringScheduleResponse" "Amazonka.SageMaker.DescribeMonitoringSchedule" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeMonitoringScheduleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "monitoringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringType)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastMonitoringExecutionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringExecutionSummary)) :: 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 Source #

Arguments

:: Int	`$sel:httpStatus:DescribeMonitoringScheduleResponse'`
-> Text	`$sel:monitoringScheduleArn:DescribeMonitoringScheduleResponse'`
-> Text	`$sel:monitoringScheduleName:DescribeMonitoringSchedule'`
-> ScheduleStatus	`$sel:monitoringScheduleStatus:DescribeMonitoringScheduleResponse'`
-> UTCTime	`$sel:creationTime:DescribeMonitoringScheduleResponse'`
-> UTCTime	`$sel:lastModifiedTime:DescribeMonitoringScheduleResponse'`
-> MonitoringScheduleConfig	`$sel: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:

$sel:monitoringType: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:failureReason:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_failureReason - A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

$sel:endpointName:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_endpointName - The name of the endpoint for the monitoring job.

$sel:lastMonitoringExecutionSummary:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_lastMonitoringExecutionSummary - Describes metadata on the last execution to run, if there was one.

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

$sel:monitoringScheduleArn:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_monitoringScheduleArn - The Amazon Resource Name (ARN) of the monitoring schedule.

$sel:monitoringScheduleName:DescribeMonitoringSchedule', describeMonitoringScheduleResponse_monitoringScheduleName - Name of the monitoring schedule.

$sel:monitoringScheduleStatus:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_monitoringScheduleStatus - The status of an monitoring job.

$sel:creationTime:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_creationTime - The time at which the monitoring job was created.

$sel:lastModifiedTime:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_lastModifiedTime - The time at which the monitoring job was last modified.

$sel:monitoringScheduleConfig:DescribeMonitoringScheduleResponse', describeMonitoringScheduleResponse_monitoringScheduleConfig - The configuration object that specifies the monitoring schedule and defines the monitoring job.

Response Lenses

describeMonitoringScheduleResponse_monitoringType :: Lens' DescribeMonitoringScheduleResponse (Maybe MonitoringType) Source #

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_failureReason :: Lens' DescribeMonitoringScheduleResponse (Maybe Text) Source #

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

describeMonitoringScheduleResponse_endpointName :: Lens' DescribeMonitoringScheduleResponse (Maybe Text) Source #

The name of the endpoint for the monitoring job.

describeMonitoringScheduleResponse_lastMonitoringExecutionSummary :: Lens' DescribeMonitoringScheduleResponse (Maybe MonitoringExecutionSummary) Source #

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

describeMonitoringScheduleResponse_httpStatus :: Lens' DescribeMonitoringScheduleResponse Int Source #

The response's http status code.

describeMonitoringScheduleResponse_monitoringScheduleArn :: Lens' DescribeMonitoringScheduleResponse Text Source #

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

describeMonitoringScheduleResponse_monitoringScheduleName :: Lens' DescribeMonitoringScheduleResponse Text Source #

Name of the monitoring schedule.

describeMonitoringScheduleResponse_monitoringScheduleStatus :: Lens' DescribeMonitoringScheduleResponse ScheduleStatus Source #

The status of an monitoring job.

describeMonitoringScheduleResponse_creationTime :: Lens' DescribeMonitoringScheduleResponse UTCTime Source #

The time at which the monitoring job was created.

describeMonitoringScheduleResponse_lastModifiedTime :: Lens' DescribeMonitoringScheduleResponse UTCTime Source #

The time at which the monitoring job was last modified.

describeMonitoringScheduleResponse_monitoringScheduleConfig :: Lens' DescribeMonitoringScheduleResponse MonitoringScheduleConfig Source #

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