Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.ListMonitoringSchedules

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns list of all monitoring schedules.

This operation returns paginated results.

Synopsis

Creating a Request

data ListMonitoringSchedules Source #

See: newListMonitoringSchedules smart constructor.

Constructors

ListMonitoringSchedules'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only monitoring schedules created after a specified time.
creationTimeBefore :: Maybe POSIX
A filter that returns only monitoring schedules created before a specified time.
endpointName :: Maybe Text
Name of a specific endpoint to fetch schedules for.
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only monitoring schedules modified after a specified time.
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only monitoring schedules modified before a specified time.
maxResults :: Maybe Natural
The maximum number of jobs to return in the response. The default value is 10.
monitoringJobDefinitionName :: Maybe Text
Gets a list of the monitoring schedules for the specified monitoring job definition.
monitoringTypeEquals :: Maybe MonitoringType
A filter that returns only the monitoring schedules for the specified monitoring type.
nameContains :: Maybe Text
Filter for monitoring schedules whose name contains a specified string.
nextToken :: Maybe Text
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
sortBy :: Maybe MonitoringScheduleSortKey
Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
sortOrder :: Maybe SortOrder
Whether to sort the results in Ascending or Descending order. The default is Descending.
statusEquals :: Maybe ScheduleStatus
A filter that returns only monitoring schedules modified before a specified time.

Instances

Instances details

ToJSON ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods toJSON :: ListMonitoringSchedules -> Value # toEncoding :: ListMonitoringSchedules -> Encoding # toJSONList :: [ListMonitoringSchedules] -> Value # toEncodingList :: [ListMonitoringSchedules] -> Encoding #
ToHeaders ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods toHeaders :: ListMonitoringSchedules -> [Header] #
ToPath ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods toPath :: ListMonitoringSchedules -> ByteString #
ToQuery ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods toQuery :: ListMonitoringSchedules -> QueryString #
AWSPager ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods page :: ListMonitoringSchedules -> AWSResponse ListMonitoringSchedules -> Maybe ListMonitoringSchedules #
AWSRequest ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Associated Types type AWSResponse ListMonitoringSchedules # Methods request :: (Service -> Service) -> ListMonitoringSchedules -> Request ListMonitoringSchedules # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMonitoringSchedules -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMonitoringSchedules))) #
Generic ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Associated Types type Rep ListMonitoringSchedules :: Type -> Type # Methods from :: ListMonitoringSchedules -> Rep ListMonitoringSchedules x # to :: Rep ListMonitoringSchedules x -> ListMonitoringSchedules #
Read ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods readsPrec :: Int -> ReadS ListMonitoringSchedules # readList :: ReadS [ListMonitoringSchedules] # readPrec :: ReadPrec ListMonitoringSchedules # readListPrec :: ReadPrec [ListMonitoringSchedules] #
Show ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods showsPrec :: Int -> ListMonitoringSchedules -> ShowS # show :: ListMonitoringSchedules -> String # showList :: [ListMonitoringSchedules] -> ShowS #
NFData ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods rnf :: ListMonitoringSchedules -> () #
Eq ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods (==) :: ListMonitoringSchedules -> ListMonitoringSchedules -> Bool # (/=) :: ListMonitoringSchedules -> ListMonitoringSchedules -> Bool #
Hashable ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods hashWithSalt :: Int -> ListMonitoringSchedules -> Int # hash :: ListMonitoringSchedules -> Int #
type AWSResponse ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules type AWSResponse ListMonitoringSchedules = ListMonitoringSchedulesResponse
type Rep ListMonitoringSchedules Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules type Rep ListMonitoringSchedules = D1 ('MetaData "ListMonitoringSchedules" "Amazonka.SageMaker.ListMonitoringSchedules" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListMonitoringSchedules'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "lastModifiedTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "lastModifiedTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "monitoringJobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "monitoringTypeEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringType)) :: S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringScheduleSortKey))) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduleStatus)))))))

newListMonitoringSchedules :: ListMonitoringSchedules Source #

Create a value of ListMonitoringSchedules 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:creationTimeAfter:ListMonitoringSchedules', listMonitoringSchedules_creationTimeAfter - A filter that returns only monitoring schedules created after a specified time.

$sel:creationTimeBefore:ListMonitoringSchedules', listMonitoringSchedules_creationTimeBefore - A filter that returns only monitoring schedules created before a specified time.

ListMonitoringSchedules, listMonitoringSchedules_endpointName - Name of a specific endpoint to fetch schedules for.

$sel:lastModifiedTimeAfter:ListMonitoringSchedules', listMonitoringSchedules_lastModifiedTimeAfter - A filter that returns only monitoring schedules modified after a specified time.

$sel:lastModifiedTimeBefore:ListMonitoringSchedules', listMonitoringSchedules_lastModifiedTimeBefore - A filter that returns only monitoring schedules modified before a specified time.

$sel:maxResults:ListMonitoringSchedules', listMonitoringSchedules_maxResults - The maximum number of jobs to return in the response. The default value is 10.

ListMonitoringSchedules, listMonitoringSchedules_monitoringJobDefinitionName - Gets a list of the monitoring schedules for the specified monitoring job definition.

$sel:monitoringTypeEquals:ListMonitoringSchedules', listMonitoringSchedules_monitoringTypeEquals - A filter that returns only the monitoring schedules for the specified monitoring type.

$sel:nameContains:ListMonitoringSchedules', listMonitoringSchedules_nameContains - Filter for monitoring schedules whose name contains a specified string.

ListMonitoringSchedules, listMonitoringSchedules_nextToken - The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

$sel:sortBy:ListMonitoringSchedules', listMonitoringSchedules_sortBy - Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.

$sel:sortOrder:ListMonitoringSchedules', listMonitoringSchedules_sortOrder - Whether to sort the results in Ascending or Descending order. The default is Descending.

$sel:statusEquals:ListMonitoringSchedules', listMonitoringSchedules_statusEquals - A filter that returns only monitoring schedules modified before a specified time.

Request Lenses

listMonitoringSchedules_creationTimeAfter :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules created after a specified time.

listMonitoringSchedules_creationTimeBefore :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules created before a specified time.

listMonitoringSchedules_endpointName :: Lens' ListMonitoringSchedules (Maybe Text) Source #

Name of a specific endpoint to fetch schedules for.

listMonitoringSchedules_lastModifiedTimeAfter :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules modified after a specified time.

listMonitoringSchedules_lastModifiedTimeBefore :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules modified before a specified time.

listMonitoringSchedules_maxResults :: Lens' ListMonitoringSchedules (Maybe Natural) Source #

The maximum number of jobs to return in the response. The default value is 10.

listMonitoringSchedules_monitoringJobDefinitionName :: Lens' ListMonitoringSchedules (Maybe Text) Source #

Gets a list of the monitoring schedules for the specified monitoring job definition.

listMonitoringSchedules_monitoringTypeEquals :: Lens' ListMonitoringSchedules (Maybe MonitoringType) Source #

A filter that returns only the monitoring schedules for the specified monitoring type.

listMonitoringSchedules_nameContains :: Lens' ListMonitoringSchedules (Maybe Text) Source #

Filter for monitoring schedules whose name contains a specified string.

listMonitoringSchedules_nextToken :: Lens' ListMonitoringSchedules (Maybe Text) Source #

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

listMonitoringSchedules_sortBy :: Lens' ListMonitoringSchedules (Maybe MonitoringScheduleSortKey) Source #

Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.

listMonitoringSchedules_sortOrder :: Lens' ListMonitoringSchedules (Maybe SortOrder) Source #

Whether to sort the results in Ascending or Descending order. The default is Descending.

listMonitoringSchedules_statusEquals :: Lens' ListMonitoringSchedules (Maybe ScheduleStatus) Source #

A filter that returns only monitoring schedules modified before a specified time.

Destructuring the Response

data ListMonitoringSchedulesResponse Source #

See: newListMonitoringSchedulesResponse smart constructor.

Constructors

ListMonitoringSchedulesResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request. httpStatus :: Int The response's http status code. monitoringScheduleSummaries :: [MonitoringScheduleSummary] A JSON array in which each element is a summary for a monitoring schedule.

Instances

Instances details

Generic ListMonitoringSchedulesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Associated Types type Rep ListMonitoringSchedulesResponse :: Type -> Type # Methods from :: ListMonitoringSchedulesResponse -> Rep ListMonitoringSchedulesResponse x # to :: Rep ListMonitoringSchedulesResponse x -> ListMonitoringSchedulesResponse #
Read ListMonitoringSchedulesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods readsPrec :: Int -> ReadS ListMonitoringSchedulesResponse # readList :: ReadS [ListMonitoringSchedulesResponse] # readPrec :: ReadPrec ListMonitoringSchedulesResponse # readListPrec :: ReadPrec [ListMonitoringSchedulesResponse] #
Show ListMonitoringSchedulesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods showsPrec :: Int -> ListMonitoringSchedulesResponse -> ShowS # show :: ListMonitoringSchedulesResponse -> String # showList :: [ListMonitoringSchedulesResponse] -> ShowS #
NFData ListMonitoringSchedulesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods rnf :: ListMonitoringSchedulesResponse -> () #
Eq ListMonitoringSchedulesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules Methods (==) :: ListMonitoringSchedulesResponse -> ListMonitoringSchedulesResponse -> Bool # (/=) :: ListMonitoringSchedulesResponse -> ListMonitoringSchedulesResponse -> Bool #
type Rep ListMonitoringSchedulesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringSchedules type Rep ListMonitoringSchedulesResponse = D1 ('MetaData "ListMonitoringSchedulesResponse" "Amazonka.SageMaker.ListMonitoringSchedules" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListMonitoringSchedulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "monitoringScheduleSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MonitoringScheduleSummary]))))

newListMonitoringSchedulesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListMonitoringSchedulesResponse'`
-> ListMonitoringSchedulesResponse

Create a value of ListMonitoringSchedulesResponse 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:

ListMonitoringSchedules, listMonitoringSchedulesResponse_nextToken - If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

$sel:httpStatus:ListMonitoringSchedulesResponse', listMonitoringSchedulesResponse_httpStatus - The response's http status code.

$sel:monitoringScheduleSummaries:ListMonitoringSchedulesResponse', listMonitoringSchedulesResponse_monitoringScheduleSummaries - A JSON array in which each element is a summary for a monitoring schedule.

Response Lenses

listMonitoringSchedulesResponse_nextToken :: Lens' ListMonitoringSchedulesResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

listMonitoringSchedulesResponse_httpStatus :: Lens' ListMonitoringSchedulesResponse Int Source #

The response's http status code.

listMonitoringSchedulesResponse_monitoringScheduleSummaries :: Lens' ListMonitoringSchedulesResponse [MonitoringScheduleSummary] Source #

A JSON array in which each element is a summary for a monitoring schedule.