| 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.Glue.ListCrawls
Description
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
- Retrive all the crawls of a specified crawler.
- Retrieve all the crawls of a specified crawler within a limited count.
- Retrieve all the crawls of a specified crawler in a specific time range.
- Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Synopsis
- data ListCrawls = ListCrawls' {
- filters :: Maybe [CrawlsFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- crawlerName :: Text
- newListCrawls :: Text -> ListCrawls
- listCrawls_filters :: Lens' ListCrawls (Maybe [CrawlsFilter])
- listCrawls_maxResults :: Lens' ListCrawls (Maybe Natural)
- listCrawls_nextToken :: Lens' ListCrawls (Maybe Text)
- listCrawls_crawlerName :: Lens' ListCrawls Text
- data ListCrawlsResponse = ListCrawlsResponse' {
- crawls :: Maybe [CrawlerHistory]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListCrawlsResponse :: Int -> ListCrawlsResponse
- listCrawlsResponse_crawls :: Lens' ListCrawlsResponse (Maybe [CrawlerHistory])
- listCrawlsResponse_nextToken :: Lens' ListCrawlsResponse (Maybe Text)
- listCrawlsResponse_httpStatus :: Lens' ListCrawlsResponse Int
Creating a Request
data ListCrawls Source #
See: newListCrawls smart constructor.
Constructors
| ListCrawls' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListCrawls |
Create a value of ListCrawls 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:
ListCrawls, listCrawls_filters - Filters the crawls by the criteria you specify in a list of
CrawlsFilter objects.
$sel:maxResults:ListCrawls', listCrawls_maxResults - The maximum number of results to return. The default is 20, and maximum
is 100.
ListCrawls, listCrawls_nextToken - A continuation token, if this is a continuation call.
ListCrawls, listCrawls_crawlerName - The name of the crawler whose runs you want to retrieve.
Request Lenses
listCrawls_filters :: Lens' ListCrawls (Maybe [CrawlsFilter]) Source #
Filters the crawls by the criteria you specify in a list of
CrawlsFilter objects.
listCrawls_maxResults :: Lens' ListCrawls (Maybe Natural) Source #
The maximum number of results to return. The default is 20, and maximum is 100.
listCrawls_nextToken :: Lens' ListCrawls (Maybe Text) Source #
A continuation token, if this is a continuation call.
listCrawls_crawlerName :: Lens' ListCrawls Text Source #
The name of the crawler whose runs you want to retrieve.
Destructuring the Response
data ListCrawlsResponse Source #
See: newListCrawlsResponse smart constructor.
Constructors
| ListCrawlsResponse' | |
Fields
| |
Instances
newListCrawlsResponse Source #
Arguments
| :: Int | |
| -> ListCrawlsResponse |
Create a value of ListCrawlsResponse 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:
ListCrawlsResponse, listCrawlsResponse_crawls - A list of CrawlerHistory objects representing the crawl runs that meet
your criteria.
ListCrawls, listCrawlsResponse_nextToken - A continuation token for paginating the returned list of tokens,
returned if the current segment of the list is not the last.
$sel:httpStatus:ListCrawlsResponse', listCrawlsResponse_httpStatus - The response's http status code.
Response Lenses
listCrawlsResponse_crawls :: Lens' ListCrawlsResponse (Maybe [CrawlerHistory]) Source #
A list of CrawlerHistory objects representing the crawl runs that meet
your criteria.
listCrawlsResponse_nextToken :: Lens' ListCrawlsResponse (Maybe Text) Source #
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
listCrawlsResponse_httpStatus :: Lens' ListCrawlsResponse Int Source #
The response's http status code.