/AWS1/CL_REK=>LISTDATASETENTRIES()¶
About ListDatasetEntries¶
This operation applies only to Amazon Rekognition Custom Labels.
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DATASETARN TYPE /AWS1/REKDATASETARN /AWS1/REKDATASETARN¶
The Amazon Resource Name (ARN) for the dataset that you want to use.
Optional arguments:¶
IT_CONTAINSLABELS TYPE /AWS1/CL_REKDATASETLABELS_W=>TT_DATASETLABELS TT_DATASETLABELS¶
Specifies a label filter for the response. The response includes an entry only if one or more of the labels in
ContainsLabelsexist in the entry.
IV_LABELED TYPE /AWS1/REKISLABELED /AWS1/REKISLABELED¶
Specify
trueto get only the JSON Lines where the image is labeled. Specifyfalseto get only the JSON Lines where the image isn't labeled. If you don't specifyLabeled,ListDatasetEntriesreturns JSON Lines for labeled and unlabeled images.
IV_SOURCEREFCONTAINS TYPE /AWS1/REKQUERYSTRING /AWS1/REKQUERYSTRING¶
If specified,
ListDatasetEntriesonly returns JSON Lines where the value ofSourceRefContainsis part of thesource-reffield. Thesource-reffield contains the Amazon S3 location of the image. You can useSouceRefContainsfor tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.
IV_HASERRORS TYPE /AWS1/REKHASERRORS /AWS1/REKHASERRORS¶
Specifies an error filter for the response. Specify
Trueto only include entries that have errors.
IV_NEXTTOKEN TYPE /AWS1/REKEXTENDEDPAGINATIONTOK /AWS1/REKEXTENDEDPAGINATIONTOK¶
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.
IV_MAXRESULTS TYPE /AWS1/REKLISTDSENTRIESPAGESIZE /AWS1/REKLISTDSENTRIESPAGESIZE¶
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.