| 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.Rekognition.ListDatasetEntries
Description
Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.
JSON Lines in the response include information about non-terminal errors
found in the dataset. Non terminal errors are reported in errors lists
within each JSON Line. The same information is reported in the training
and testing validation result manifests that Amazon Rekognition Custom
Labels creates during model training.
You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.
This operation requires permissions to perform the
rekognition:ListDatasetEntries action.
This operation returns paginated results.
Synopsis
- data ListDatasetEntries = ListDatasetEntries' {}
- newListDatasetEntries :: Text -> ListDatasetEntries
- listDatasetEntries_containsLabels :: Lens' ListDatasetEntries (Maybe (NonEmpty Text))
- listDatasetEntries_hasErrors :: Lens' ListDatasetEntries (Maybe Bool)
- listDatasetEntries_labeled :: Lens' ListDatasetEntries (Maybe Bool)
- listDatasetEntries_maxResults :: Lens' ListDatasetEntries (Maybe Natural)
- listDatasetEntries_nextToken :: Lens' ListDatasetEntries (Maybe Text)
- listDatasetEntries_sourceRefContains :: Lens' ListDatasetEntries (Maybe Text)
- listDatasetEntries_datasetArn :: Lens' ListDatasetEntries Text
- data ListDatasetEntriesResponse = ListDatasetEntriesResponse' {
- datasetEntries :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListDatasetEntriesResponse :: Int -> ListDatasetEntriesResponse
- listDatasetEntriesResponse_datasetEntries :: Lens' ListDatasetEntriesResponse (Maybe [Text])
- listDatasetEntriesResponse_nextToken :: Lens' ListDatasetEntriesResponse (Maybe Text)
- listDatasetEntriesResponse_httpStatus :: Lens' ListDatasetEntriesResponse Int
Creating a Request
data ListDatasetEntries Source #
See: newListDatasetEntries smart constructor.
Constructors
| ListDatasetEntries' | |
Fields
| |
Instances
newListDatasetEntries Source #
Arguments
| :: Text | |
| -> ListDatasetEntries |
Create a value of ListDatasetEntries 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:containsLabels:ListDatasetEntries', listDatasetEntries_containsLabels - Specifies a label filter for the response. The response includes an
entry only if one or more of the labels in ContainsLabels exist in the
entry.
$sel:hasErrors:ListDatasetEntries', listDatasetEntries_hasErrors - Specifies an error filter for the response. Specify True to only
include entries that have errors.
$sel:labeled:ListDatasetEntries', listDatasetEntries_labeled - Specify true to get only the JSON Lines where the image is labeled.
Specify false to get only the JSON Lines where the image isn't
labeled. If you don't specify Labeled, ListDatasetEntries returns
JSON Lines for labeled and unlabeled images.
$sel:maxResults:ListDatasetEntries', listDatasetEntries_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.
ListDatasetEntries, listDatasetEntries_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:sourceRefContains:ListDatasetEntries', listDatasetEntries_sourceRefContains - If specified, ListDatasetEntries only returns JSON Lines where the
value of SourceRefContains is part of the source-ref field. The
source-ref field contains the Amazon S3 location of the image. You can
use SouceRefContains for tasks such as getting the JSON Line for a
single image, or gettting JSON Lines for all images within a specific
folder.
ListDatasetEntries, listDatasetEntries_datasetArn - The Amazon Resource Name (ARN) for the dataset that you want to use.
Request Lenses
listDatasetEntries_containsLabels :: Lens' ListDatasetEntries (Maybe (NonEmpty Text)) Source #
Specifies a label filter for the response. The response includes an
entry only if one or more of the labels in ContainsLabels exist in the
entry.
listDatasetEntries_hasErrors :: Lens' ListDatasetEntries (Maybe Bool) Source #
Specifies an error filter for the response. Specify True to only
include entries that have errors.
listDatasetEntries_labeled :: Lens' ListDatasetEntries (Maybe Bool) Source #
Specify true to get only the JSON Lines where the image is labeled.
Specify false to get only the JSON Lines where the image isn't
labeled. If you don't specify Labeled, ListDatasetEntries returns
JSON Lines for labeled and unlabeled images.
listDatasetEntries_maxResults :: Lens' ListDatasetEntries (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.
listDatasetEntries_nextToken :: Lens' ListDatasetEntries (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.
listDatasetEntries_sourceRefContains :: Lens' ListDatasetEntries (Maybe Text) Source #
If specified, ListDatasetEntries only returns JSON Lines where the
value of SourceRefContains is part of the source-ref field. The
source-ref field contains the Amazon S3 location of the image. You can
use SouceRefContains for tasks such as getting the JSON Line for a
single image, or gettting JSON Lines for all images within a specific
folder.
listDatasetEntries_datasetArn :: Lens' ListDatasetEntries Text Source #
The Amazon Resource Name (ARN) for the dataset that you want to use.
Destructuring the Response
data ListDatasetEntriesResponse Source #
See: newListDatasetEntriesResponse smart constructor.
Constructors
| ListDatasetEntriesResponse' | |
Fields
| |
Instances
newListDatasetEntriesResponse Source #
Create a value of ListDatasetEntriesResponse 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:datasetEntries:ListDatasetEntriesResponse', listDatasetEntriesResponse_datasetEntries - A list of entries (images) in the dataset.
ListDatasetEntries, listDatasetEntriesResponse_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:ListDatasetEntriesResponse', listDatasetEntriesResponse_httpStatus - The response's http status code.
Response Lenses
listDatasetEntriesResponse_datasetEntries :: Lens' ListDatasetEntriesResponse (Maybe [Text]) Source #
A list of entries (images) in the dataset.
listDatasetEntriesResponse_nextToken :: Lens' ListDatasetEntriesResponse (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.
listDatasetEntriesResponse_httpStatus :: Lens' ListDatasetEntriesResponse Int Source #
The response's http status code.