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.ListExperiments
Description
Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
This operation returns paginated results.
Synopsis
- data ListExperiments = ListExperiments' {}
- newListExperiments :: ListExperiments
- listExperiments_createdAfter :: Lens' ListExperiments (Maybe UTCTime)
- listExperiments_nextToken :: Lens' ListExperiments (Maybe Text)
- listExperiments_sortOrder :: Lens' ListExperiments (Maybe SortOrder)
- listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural)
- listExperiments_createdBefore :: Lens' ListExperiments (Maybe UTCTime)
- listExperiments_sortBy :: Lens' ListExperiments (Maybe SortExperimentsBy)
- data ListExperimentsResponse = ListExperimentsResponse' {}
- newListExperimentsResponse :: Int -> ListExperimentsResponse
- listExperimentsResponse_experimentSummaries :: Lens' ListExperimentsResponse (Maybe [ExperimentSummary])
- listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text)
- listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int
Creating a Request
data ListExperiments Source #
See: newListExperiments
smart constructor.
Constructors
ListExperiments' | |
Fields
|
Instances
newListExperiments :: ListExperiments Source #
Create a value of ListExperiments
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:createdAfter:ListExperiments'
, listExperiments_createdAfter
- A filter that returns only experiments created after the specified time.
$sel:nextToken:ListExperiments'
, listExperiments_nextToken
- If the previous call to ListExperiments
didn't return the full set of
experiments, the call returns a token for getting the next set of
experiments.
$sel:sortOrder:ListExperiments'
, listExperiments_sortOrder
- The sort order. The default value is Descending
.
$sel:maxResults:ListExperiments'
, listExperiments_maxResults
- The maximum number of experiments to return in the response. The default
value is 10.
$sel:createdBefore:ListExperiments'
, listExperiments_createdBefore
- A filter that returns only experiments created before the specified
time.
$sel:sortBy:ListExperiments'
, listExperiments_sortBy
- The property used to sort results. The default value is CreationTime
.
Request Lenses
listExperiments_createdAfter :: Lens' ListExperiments (Maybe UTCTime) Source #
A filter that returns only experiments created after the specified time.
listExperiments_nextToken :: Lens' ListExperiments (Maybe Text) Source #
If the previous call to ListExperiments
didn't return the full set of
experiments, the call returns a token for getting the next set of
experiments.
listExperiments_sortOrder :: Lens' ListExperiments (Maybe SortOrder) Source #
The sort order. The default value is Descending
.
listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural) Source #
The maximum number of experiments to return in the response. The default value is 10.
listExperiments_createdBefore :: Lens' ListExperiments (Maybe UTCTime) Source #
A filter that returns only experiments created before the specified time.
listExperiments_sortBy :: Lens' ListExperiments (Maybe SortExperimentsBy) Source #
The property used to sort results. The default value is CreationTime
.
Destructuring the Response
data ListExperimentsResponse Source #
See: newListExperimentsResponse
smart constructor.
Constructors
ListExperimentsResponse' | |
Fields
|
Instances
newListExperimentsResponse Source #
Create a value of ListExperimentsResponse
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:experimentSummaries:ListExperimentsResponse'
, listExperimentsResponse_experimentSummaries
- A list of the summaries of your experiments.
$sel:nextToken:ListExperiments'
, listExperimentsResponse_nextToken
- A token for getting the next set of experiments, if there are any.
$sel:httpStatus:ListExperimentsResponse'
, listExperimentsResponse_httpStatus
- The response's http status code.
Response Lenses
listExperimentsResponse_experimentSummaries :: Lens' ListExperimentsResponse (Maybe [ExperimentSummary]) Source #
A list of the summaries of your experiments.
listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text) Source #
A token for getting the next set of experiments, if there are any.
listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int Source #
The response's http status code.