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 |
Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images.
Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.
This operation returns paginated results.
Synopsis
- data ListDatasetLabels = ListDatasetLabels' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- datasetArn :: Text
- newListDatasetLabels :: Text -> ListDatasetLabels
- listDatasetLabels_maxResults :: Lens' ListDatasetLabels (Maybe Natural)
- listDatasetLabels_nextToken :: Lens' ListDatasetLabels (Maybe Text)
- listDatasetLabels_datasetArn :: Lens' ListDatasetLabels Text
- data ListDatasetLabelsResponse = ListDatasetLabelsResponse' {}
- newListDatasetLabelsResponse :: Int -> ListDatasetLabelsResponse
- listDatasetLabelsResponse_datasetLabelDescriptions :: Lens' ListDatasetLabelsResponse (Maybe [DatasetLabelDescription])
- listDatasetLabelsResponse_nextToken :: Lens' ListDatasetLabelsResponse (Maybe Text)
- listDatasetLabelsResponse_httpStatus :: Lens' ListDatasetLabelsResponse Int
Creating a Request
data ListDatasetLabels Source #
See: newListDatasetLabels
smart constructor.
ListDatasetLabels' | |
|
Instances
Create a value of ListDatasetLabels
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:ListDatasetLabels'
, listDatasetLabels_maxResults
- The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
ListDatasetLabels
, listDatasetLabels_nextToken
- If the previous response was incomplete (because there is more results
to retrieve), Amazon Rekognition Custom Labels returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of results.
ListDatasetLabels
, listDatasetLabels_datasetArn
- The Amazon Resource Name (ARN) of the dataset that you want to use.
Request Lenses
listDatasetLabels_maxResults :: Lens' ListDatasetLabels (Maybe Natural) Source #
The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
listDatasetLabels_nextToken :: Lens' ListDatasetLabels (Maybe Text) Source #
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
listDatasetLabels_datasetArn :: Lens' ListDatasetLabels Text Source #
The Amazon Resource Name (ARN) of the dataset that you want to use.
Destructuring the Response
data ListDatasetLabelsResponse Source #
See: newListDatasetLabelsResponse
smart constructor.
ListDatasetLabelsResponse' | |
|
Instances
newListDatasetLabelsResponse Source #
Create a value of ListDatasetLabelsResponse
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:datasetLabelDescriptions:ListDatasetLabelsResponse'
, listDatasetLabelsResponse_datasetLabelDescriptions
- A list of the labels in the dataset.
ListDatasetLabels
, listDatasetLabelsResponse_nextToken
- If the previous response was incomplete (because there is more results
to retrieve), Amazon Rekognition Custom Labels returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of results.
$sel:httpStatus:ListDatasetLabelsResponse'
, listDatasetLabelsResponse_httpStatus
- The response's http status code.
Response Lenses
listDatasetLabelsResponse_datasetLabelDescriptions :: Lens' ListDatasetLabelsResponse (Maybe [DatasetLabelDescription]) Source #
A list of the labels in the dataset.
listDatasetLabelsResponse_nextToken :: Lens' ListDatasetLabelsResponse (Maybe Text) Source #
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
listDatasetLabelsResponse_httpStatus :: Lens' ListDatasetLabelsResponse Int Source #
The response's http status code.