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.ListMonitoringExecutions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns list of all monitoring job executions.

This operation returns paginated results.

Synopsis

Creating a Request

data ListMonitoringExecutions Source #

See: newListMonitoringExecutions smart constructor.

Constructors

ListMonitoringExecutions'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only jobs created after a specified time.
creationTimeBefore :: Maybe POSIX
A filter that returns only jobs created before a specified time.
endpointName :: Maybe Text
Name of a specific endpoint to fetch jobs for.
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only jobs modified before a specified time.
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only jobs modified after 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 job runs of the specified monitoring job definitions.
monitoringScheduleName :: Maybe Text
Name of a specific schedule to fetch jobs for.
monitoringTypeEquals :: Maybe MonitoringType
A filter that returns only the monitoring job runs of the specified monitoring type.
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.
scheduledTimeAfter :: Maybe POSIX
Filter for jobs scheduled after a specified time.
scheduledTimeBefore :: Maybe POSIX
Filter for jobs scheduled before a specified time.
sortBy :: Maybe MonitoringExecutionSortKey
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 ExecutionStatus
A filter that retrieves only jobs with a specific status.

Instances

Instances details

ToJSON ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods toJSON :: ListMonitoringExecutions -> Value # toEncoding :: ListMonitoringExecutions -> Encoding # toJSONList :: [ListMonitoringExecutions] -> Value # toEncodingList :: [ListMonitoringExecutions] -> Encoding #
ToHeaders ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods toHeaders :: ListMonitoringExecutions -> [Header] #
ToPath ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods toPath :: ListMonitoringExecutions -> ByteString #
ToQuery ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods toQuery :: ListMonitoringExecutions -> QueryString #
AWSPager ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods page :: ListMonitoringExecutions -> AWSResponse ListMonitoringExecutions -> Maybe ListMonitoringExecutions #
AWSRequest ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Associated Types type AWSResponse ListMonitoringExecutions # Methods request :: (Service -> Service) -> ListMonitoringExecutions -> Request ListMonitoringExecutions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMonitoringExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMonitoringExecutions))) #
Generic ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Associated Types type Rep ListMonitoringExecutions :: Type -> Type # Methods from :: ListMonitoringExecutions -> Rep ListMonitoringExecutions x # to :: Rep ListMonitoringExecutions x -> ListMonitoringExecutions #
Read ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods readsPrec :: Int -> ReadS ListMonitoringExecutions # readList :: ReadS [ListMonitoringExecutions] # readPrec :: ReadPrec ListMonitoringExecutions # readListPrec :: ReadPrec [ListMonitoringExecutions] #
Show ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods showsPrec :: Int -> ListMonitoringExecutions -> ShowS # show :: ListMonitoringExecutions -> String # showList :: [ListMonitoringExecutions] -> ShowS #
NFData ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods rnf :: ListMonitoringExecutions -> () #
Eq ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods (==) :: ListMonitoringExecutions -> ListMonitoringExecutions -> Bool # (/=) :: ListMonitoringExecutions -> ListMonitoringExecutions -> Bool #
Hashable ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions Methods hashWithSalt :: Int -> ListMonitoringExecutions -> Int # hash :: ListMonitoringExecutions -> Int #
type AWSResponse ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions type AWSResponse ListMonitoringExecutions = ListMonitoringExecutionsResponse
type Rep ListMonitoringExecutions Source #
Instance details Defined in Amazonka.SageMaker.ListMonitoringExecutions type Rep ListMonitoringExecutions = D1 ('MetaData "ListMonitoringExecutions" "Amazonka.SageMaker.ListMonitoringExecutions" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListMonitoringExecutions'" '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 "monitoringScheduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "monitoringTypeEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringType))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scheduledTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "scheduledTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitoringExecutionSortKey))) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)))))))

newListMonitoringExecutions :: ListMonitoringExecutions Source #

Create a value of ListMonitoringExecutions 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:ListMonitoringExecutions', listMonitoringExecutions_creationTimeAfter - A filter that returns only jobs created after a specified time.

$sel:creationTimeBefore:ListMonitoringExecutions', listMonitoringExecutions_creationTimeBefore - A filter that returns only jobs created before a specified time.

ListMonitoringExecutions, listMonitoringExecutions_endpointName - Name of a specific endpoint to fetch jobs for.

$sel:lastModifiedTimeAfter:ListMonitoringExecutions', listMonitoringExecutions_lastModifiedTimeAfter - A filter that returns only jobs modified before a specified time.

$sel:lastModifiedTimeBefore:ListMonitoringExecutions', listMonitoringExecutions_lastModifiedTimeBefore - A filter that returns only jobs modified after a specified time.

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

ListMonitoringExecutions, listMonitoringExecutions_monitoringJobDefinitionName - Gets a list of the monitoring job runs of the specified monitoring job definitions.

ListMonitoringExecutions, listMonitoringExecutions_monitoringScheduleName - Name of a specific schedule to fetch jobs for.

$sel:monitoringTypeEquals:ListMonitoringExecutions', listMonitoringExecutions_monitoringTypeEquals - A filter that returns only the monitoring job runs of the specified monitoring type.

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

$sel:scheduledTimeAfter:ListMonitoringExecutions', listMonitoringExecutions_scheduledTimeAfter - Filter for jobs scheduled after a specified time.

$sel:scheduledTimeBefore:ListMonitoringExecutions', listMonitoringExecutions_scheduledTimeBefore - Filter for jobs scheduled before a specified time.

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

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

$sel:statusEquals:ListMonitoringExecutions', listMonitoringExecutions_statusEquals - A filter that retrieves only jobs with a specific status.

Request Lenses

listMonitoringExecutions_creationTimeAfter :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs created after a specified time.

listMonitoringExecutions_creationTimeBefore :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs created before a specified time.

listMonitoringExecutions_endpointName :: Lens' ListMonitoringExecutions (Maybe Text) Source #

Name of a specific endpoint to fetch jobs for.

listMonitoringExecutions_lastModifiedTimeAfter :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs modified before a specified time.

listMonitoringExecutions_lastModifiedTimeBefore :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs modified after a specified time.

listMonitoringExecutions_maxResults :: Lens' ListMonitoringExecutions (Maybe Natural) Source #

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

listMonitoringExecutions_monitoringJobDefinitionName :: Lens' ListMonitoringExecutions (Maybe Text) Source #

Gets a list of the monitoring job runs of the specified monitoring job definitions.

listMonitoringExecutions_monitoringScheduleName :: Lens' ListMonitoringExecutions (Maybe Text) Source #

Name of a specific schedule to fetch jobs for.

listMonitoringExecutions_monitoringTypeEquals :: Lens' ListMonitoringExecutions (Maybe MonitoringType) Source #

A filter that returns only the monitoring job runs of the specified monitoring type.

listMonitoringExecutions_nextToken :: Lens' ListMonitoringExecutions (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.

listMonitoringExecutions_scheduledTimeAfter :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

Filter for jobs scheduled after a specified time.

listMonitoringExecutions_scheduledTimeBefore :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

Filter for jobs scheduled before a specified time.

listMonitoringExecutions_sortBy :: Lens' ListMonitoringExecutions (Maybe MonitoringExecutionSortKey) Source #

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

listMonitoringExecutions_sortOrder :: Lens' ListMonitoringExecutions (Maybe SortOrder) Source #

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

listMonitoringExecutions_statusEquals :: Lens' ListMonitoringExecutions (Maybe ExecutionStatus) Source #

A filter that retrieves only jobs with a specific status.

Destructuring the Response

data ListMonitoringExecutionsResponse Source #

See: newListMonitoringExecutionsResponse smart constructor.

Constructors

ListMonitoringExecutionsResponse'
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 reques httpStatus :: Int The response's http status code. monitoringExecutionSummaries :: [MonitoringExecutionSummary] A JSON array in which each element is a summary for a monitoring execution.

Instances

Instances details

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

newListMonitoringExecutionsResponse Source #

Arguments

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

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

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

$sel:httpStatus:ListMonitoringExecutionsResponse', listMonitoringExecutionsResponse_httpStatus - The response's http status code.

$sel:monitoringExecutionSummaries:ListMonitoringExecutionsResponse', listMonitoringExecutionsResponse_monitoringExecutionSummaries - A JSON array in which each element is a summary for a monitoring execution.

Response Lenses

listMonitoringExecutionsResponse_nextToken :: Lens' ListMonitoringExecutionsResponse (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 reques

listMonitoringExecutionsResponse_httpStatus :: Lens' ListMonitoringExecutionsResponse Int Source #

The response's http status code.

listMonitoringExecutionsResponse_monitoringExecutionSummaries :: Lens' ListMonitoringExecutionsResponse [MonitoringExecutionSummary] Source #

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