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 |
Retrieves a list of vector enrichment jobs.
This operation returns paginated results.
Synopsis
- data ListVectorEnrichmentJobs = ListVectorEnrichmentJobs' {}
- newListVectorEnrichmentJobs :: ListVectorEnrichmentJobs
- listVectorEnrichmentJobs_maxResults :: Lens' ListVectorEnrichmentJobs (Maybe Natural)
- listVectorEnrichmentJobs_nextToken :: Lens' ListVectorEnrichmentJobs (Maybe Text)
- listVectorEnrichmentJobs_sortBy :: Lens' ListVectorEnrichmentJobs (Maybe Text)
- listVectorEnrichmentJobs_sortOrder :: Lens' ListVectorEnrichmentJobs (Maybe SortOrder)
- listVectorEnrichmentJobs_statusEquals :: Lens' ListVectorEnrichmentJobs (Maybe Text)
- data ListVectorEnrichmentJobsResponse = ListVectorEnrichmentJobsResponse' {}
- newListVectorEnrichmentJobsResponse :: Int -> ListVectorEnrichmentJobsResponse
- listVectorEnrichmentJobsResponse_nextToken :: Lens' ListVectorEnrichmentJobsResponse (Maybe Text)
- listVectorEnrichmentJobsResponse_httpStatus :: Lens' ListVectorEnrichmentJobsResponse Int
- listVectorEnrichmentJobsResponse_vectorEnrichmentJobSummaries :: Lens' ListVectorEnrichmentJobsResponse [ListVectorEnrichmentJobOutputConfig]
Creating a Request
data ListVectorEnrichmentJobs Source #
See: newListVectorEnrichmentJobs
smart constructor.
ListVectorEnrichmentJobs' | |
|
Instances
newListVectorEnrichmentJobs :: ListVectorEnrichmentJobs Source #
Create a value of ListVectorEnrichmentJobs
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:maxResults:ListVectorEnrichmentJobs'
, listVectorEnrichmentJobs_maxResults
- The maximum number of items to return.
ListVectorEnrichmentJobs
, listVectorEnrichmentJobs_nextToken
- If the previous response was truncated, you receive this token. Use it
in your next request to receive the next set of results.
$sel:sortBy:ListVectorEnrichmentJobs'
, listVectorEnrichmentJobs_sortBy
- The parameter by which to sort the results.
$sel:sortOrder:ListVectorEnrichmentJobs'
, listVectorEnrichmentJobs_sortOrder
- An optional value that specifies whether you want the results sorted in
Ascending
or Descending
order.
$sel:statusEquals:ListVectorEnrichmentJobs'
, listVectorEnrichmentJobs_statusEquals
- A filter that retrieves only jobs with a specific status.
Request Lenses
listVectorEnrichmentJobs_maxResults :: Lens' ListVectorEnrichmentJobs (Maybe Natural) Source #
The maximum number of items to return.
listVectorEnrichmentJobs_nextToken :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
listVectorEnrichmentJobs_sortBy :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #
The parameter by which to sort the results.
listVectorEnrichmentJobs_sortOrder :: Lens' ListVectorEnrichmentJobs (Maybe SortOrder) Source #
An optional value that specifies whether you want the results sorted in
Ascending
or Descending
order.
listVectorEnrichmentJobs_statusEquals :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #
A filter that retrieves only jobs with a specific status.
Destructuring the Response
data ListVectorEnrichmentJobsResponse Source #
See: newListVectorEnrichmentJobsResponse
smart constructor.
ListVectorEnrichmentJobsResponse' | |
|
Instances
newListVectorEnrichmentJobsResponse Source #
Create a value of ListVectorEnrichmentJobsResponse
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:
ListVectorEnrichmentJobs
, listVectorEnrichmentJobsResponse_nextToken
- If the previous response was truncated, you receive this token. Use it
in your next request to receive the next set of results.
$sel:httpStatus:ListVectorEnrichmentJobsResponse'
, listVectorEnrichmentJobsResponse_httpStatus
- The response's http status code.
$sel:vectorEnrichmentJobSummaries:ListVectorEnrichmentJobsResponse'
, listVectorEnrichmentJobsResponse_vectorEnrichmentJobSummaries
- Contains summary information about the Vector Enrichment jobs.
Response Lenses
listVectorEnrichmentJobsResponse_nextToken :: Lens' ListVectorEnrichmentJobsResponse (Maybe Text) Source #
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
listVectorEnrichmentJobsResponse_httpStatus :: Lens' ListVectorEnrichmentJobsResponse Int Source #
The response's http status code.
listVectorEnrichmentJobsResponse_vectorEnrichmentJobSummaries :: Lens' ListVectorEnrichmentJobsResponse [ListVectorEnrichmentJobOutputConfig] Source #
Contains summary information about the Vector Enrichment jobs.