Amazonka.Rekognition.ListDatasetEntries

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.

Creating a Request

data ListDatasetEntries

See: newListDatasetEntries smart constructor.

Constructors

ListDatasetEntries'

Fields

• containsLabels :: Maybe (NonEmpty Text)

  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.

• hasErrors :: Maybe Bool

  Specifies an error filter for the response. Specify True to only include entries that have errors.

• labeled :: Maybe Bool

  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.

• maxResults :: Maybe Natural

  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.

• nextToken :: Maybe Text

  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.

• sourceRefContains :: Maybe Text

  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.

• datasetArn :: Text

  The Amazon Resource Name (ARN) for the dataset that you want to use.

Instances

ToJSON ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

toJSON :: ListDatasetEntries -> Value

toEncoding :: ListDatasetEntries -> Encoding

toJSONList :: [ListDatasetEntries] -> Value

toEncodingList :: [ListDatasetEntries] -> Encoding

ToHeaders ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

toHeaders :: ListDatasetEntries -> [Header]

ToPath ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

toPath :: ListDatasetEntries -> ByteString

ToQuery ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

toQuery :: ListDatasetEntries -> QueryString

AWSPager ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

page :: ListDatasetEntries -> AWSResponse ListDatasetEntries -> Maybe ListDatasetEntries

AWSRequest ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Associated Types

type AWSResponse ListDatasetEntries

Methods

request :: (Service -> Service) -> ListDatasetEntries -> Request ListDatasetEntries

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDatasetEntries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDatasetEntries)))

Generic ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Associated Types

type Rep ListDatasetEntries :: Type -> Type

Methods

from :: ListDatasetEntries -> Rep ListDatasetEntries x

to :: Rep ListDatasetEntries x -> ListDatasetEntries

Read ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

readsPrec :: Int -> ReadS ListDatasetEntries

readList :: ReadS [ListDatasetEntries]

readPrec :: ReadPrec ListDatasetEntries

readListPrec :: ReadPrec [ListDatasetEntries]

Show ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

showsPrec :: Int -> ListDatasetEntries -> ShowS

show :: ListDatasetEntries -> String

showList :: [ListDatasetEntries] -> ShowS

NFData ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

rnf :: ListDatasetEntries -> ()

Eq ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

(==) :: ListDatasetEntries -> ListDatasetEntries -> Bool

(/=) :: ListDatasetEntries -> ListDatasetEntries -> Bool

Hashable ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

hashWithSalt :: Int -> ListDatasetEntries -> Int

hash :: ListDatasetEntries -> Int

type AWSResponse ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

type AWSResponse ListDatasetEntries = ListDatasetEntriesResponse

type Rep ListDatasetEntries

Defined in Amazonka.Rekognition.ListDatasetEntries

type Rep ListDatasetEntries = D1 ('MetaData "ListDatasetEntries" "Amazonka.Rekognition.ListDatasetEntries" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListDatasetEntries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containsLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "hasErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "labeled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sourceRefContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListDatasetEntries

Arguments

:: Text

ListDatasetEntries

-> 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))

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)

Specifies an error filter for the response. Specify True to only include entries that have errors.

listDatasetEntries_labeled :: Lens' ListDatasetEntries (Maybe Bool)

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)

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)

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)

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

The Amazon Resource Name (ARN) for the dataset that you want to use.

Destructuring the Response

data ListDatasetEntriesResponse

See: newListDatasetEntriesResponse smart constructor.

Constructors

ListDatasetEntriesResponse'

Fields

• datasetEntries :: Maybe [Text]

  A list of entries (images) in the dataset.

• nextToken :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListDatasetEntriesResponse

Defined in Amazonka.Rekognition.ListDatasetEntries

Associated Types

type Rep ListDatasetEntriesResponse :: Type -> Type

Methods

from :: ListDatasetEntriesResponse -> Rep ListDatasetEntriesResponse x

to :: Rep ListDatasetEntriesResponse x -> ListDatasetEntriesResponse

Read ListDatasetEntriesResponse

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

readsPrec :: Int -> ReadS ListDatasetEntriesResponse

readList :: ReadS [ListDatasetEntriesResponse]

readPrec :: ReadPrec ListDatasetEntriesResponse

readListPrec :: ReadPrec [ListDatasetEntriesResponse]

Show ListDatasetEntriesResponse

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

showsPrec :: Int -> ListDatasetEntriesResponse -> ShowS

show :: ListDatasetEntriesResponse -> String

showList :: [ListDatasetEntriesResponse] -> ShowS

NFData ListDatasetEntriesResponse

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

rnf :: ListDatasetEntriesResponse -> ()

Eq ListDatasetEntriesResponse

Defined in Amazonka.Rekognition.ListDatasetEntries

Methods

(==) :: ListDatasetEntriesResponse -> ListDatasetEntriesResponse -> Bool

(/=) :: ListDatasetEntriesResponse -> ListDatasetEntriesResponse -> Bool

type Rep ListDatasetEntriesResponse

Defined in Amazonka.Rekognition.ListDatasetEntries

type Rep ListDatasetEntriesResponse = D1 ('MetaData "ListDatasetEntriesResponse" "Amazonka.Rekognition.ListDatasetEntries" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListDatasetEntriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDatasetEntriesResponse

Arguments

:: Int

$sel:httpStatus:ListDatasetEntriesResponse'

-> ListDatasetEntriesResponse

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])

A list of entries (images) in the dataset.

listDatasetEntriesResponse_nextToken :: Lens' ListDatasetEntriesResponse (Maybe Text)

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

The response's http status code.