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.LookoutVision.ListDatasetEntries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.

This operation requires permissions to perform the lookoutvision:ListDatasetEntries operation.

This operation returns paginated results.

Synopsis

data ListDatasetEntries = ListDatasetEntries' {
- afterCreationDate :: Maybe POSIX
- anomalyClass :: Maybe Text
- beforeCreationDate :: Maybe POSIX
- labeled :: Maybe Bool
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sourceRefContains :: Maybe Text
- projectName :: Text
- datasetType :: Text
}
newListDatasetEntries :: Text -> Text -> ListDatasetEntries
listDatasetEntries_afterCreationDate :: Lens' ListDatasetEntries (Maybe UTCTime)
listDatasetEntries_anomalyClass :: Lens' ListDatasetEntries (Maybe Text)
listDatasetEntries_beforeCreationDate :: Lens' ListDatasetEntries (Maybe UTCTime)
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_projectName :: Lens' ListDatasetEntries Text
listDatasetEntries_datasetType :: 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

afterCreationDate :: Maybe POSIX
Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.
anomalyClass :: Maybe Text
Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.
beforeCreationDate :: Maybe POSIX
Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.
labeled :: Maybe Bool
Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.
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 data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.
sourceRefContains :: Maybe Text
Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches *IMG_17*.
projectName :: Text
The name of the project that contains the dataset that you want to list.
datasetType :: Text
The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

Instances

Instances details

ToHeaders ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods toHeaders :: ListDatasetEntries -> [Header] #
ToPath ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods toPath :: ListDatasetEntries -> ByteString #
ToQuery ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods toQuery :: ListDatasetEntries -> QueryString #
AWSPager ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods page :: ListDatasetEntries -> AWSResponse ListDatasetEntries -> Maybe ListDatasetEntries #
AWSRequest ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.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 Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Associated Types type Rep ListDatasetEntries :: Type -> Type # Methods from :: ListDatasetEntries -> Rep ListDatasetEntries x # to :: Rep ListDatasetEntries x -> ListDatasetEntries #
Read ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods readsPrec :: Int -> ReadS ListDatasetEntries # readList :: ReadS [ListDatasetEntries] # readPrec :: ReadPrec ListDatasetEntries # readListPrec :: ReadPrec [ListDatasetEntries] #
Show ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods showsPrec :: Int -> ListDatasetEntries -> ShowS # show :: ListDatasetEntries -> String # showList :: [ListDatasetEntries] -> ShowS #
NFData ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods rnf :: ListDatasetEntries -> () #
Eq ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods (==) :: ListDatasetEntries -> ListDatasetEntries -> Bool # (/=) :: ListDatasetEntries -> ListDatasetEntries -> Bool #
Hashable ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods hashWithSalt :: Int -> ListDatasetEntries -> Int # hash :: ListDatasetEntries -> Int #
type AWSResponse ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries type AWSResponse ListDatasetEntries = ListDatasetEntriesResponse
type Rep ListDatasetEntries Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries type Rep ListDatasetEntries = D1 ('MetaData "ListDatasetEntries" "Amazonka.LookoutVision.ListDatasetEntries" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "ListDatasetEntries'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "afterCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "anomalyClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "beforeCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: 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 "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "datasetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newListDatasetEntries Source #

Arguments

:: Text	`ListDatasetEntries`
-> 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:afterCreationDate:ListDatasetEntries', listDatasetEntries_afterCreationDate - Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

$sel:anomalyClass:ListDatasetEntries', listDatasetEntries_anomalyClass - Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

$sel:beforeCreationDate:ListDatasetEntries', listDatasetEntries_beforeCreationDate - Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

ListDatasetEntries, listDatasetEntries_labeled - Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.

$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 data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

$sel:sourceRefContains:ListDatasetEntries', listDatasetEntries_sourceRefContains - Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches *IMG_17*.

ListDatasetEntries, listDatasetEntries_projectName - The name of the project that contains the dataset that you want to list.

ListDatasetEntries, listDatasetEntries_datasetType - The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

Request Lenses

listDatasetEntries_afterCreationDate :: Lens' ListDatasetEntries (Maybe UTCTime) Source #

Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

listDatasetEntries_anomalyClass :: Lens' ListDatasetEntries (Maybe Text) Source #

Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

listDatasetEntries_beforeCreationDate :: Lens' ListDatasetEntries (Maybe UTCTime) Source #

Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

listDatasetEntries_labeled :: Lens' ListDatasetEntries (Maybe Bool) Source #

Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.

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 data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

listDatasetEntries_sourceRefContains :: Lens' ListDatasetEntries (Maybe Text) Source #

Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches *IMG_17*.

listDatasetEntries_projectName :: Lens' ListDatasetEntries Text Source #

The name of the project that contains the dataset that you want to list.

listDatasetEntries_datasetType :: Lens' ListDatasetEntries Text Source #

The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

Destructuring the Response

data ListDatasetEntriesResponse Source #

See: newListDatasetEntriesResponse smart constructor.

Constructors

ListDatasetEntriesResponse'
Fields datasetEntries :: Maybe [Text] A list of the entries (JSON Lines) within the dataset. nextToken :: Maybe Text If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListDatasetEntriesResponse Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Associated Types type Rep ListDatasetEntriesResponse :: Type -> Type # Methods from :: ListDatasetEntriesResponse -> Rep ListDatasetEntriesResponse x # to :: Rep ListDatasetEntriesResponse x -> ListDatasetEntriesResponse #
Read ListDatasetEntriesResponse Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods readsPrec :: Int -> ReadS ListDatasetEntriesResponse # readList :: ReadS [ListDatasetEntriesResponse] # readPrec :: ReadPrec ListDatasetEntriesResponse # readListPrec :: ReadPrec [ListDatasetEntriesResponse] #
Show ListDatasetEntriesResponse Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods showsPrec :: Int -> ListDatasetEntriesResponse -> ShowS # show :: ListDatasetEntriesResponse -> String # showList :: [ListDatasetEntriesResponse] -> ShowS #
NFData ListDatasetEntriesResponse Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods rnf :: ListDatasetEntriesResponse -> () #
Eq ListDatasetEntriesResponse Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries Methods (==) :: ListDatasetEntriesResponse -> ListDatasetEntriesResponse -> Bool # (/=) :: ListDatasetEntriesResponse -> ListDatasetEntriesResponse -> Bool #
type Rep ListDatasetEntriesResponse Source #
Instance details Defined in Amazonka.LookoutVision.ListDatasetEntries type Rep ListDatasetEntriesResponse = D1 ('MetaData "ListDatasetEntriesResponse" "Amazonka.LookoutVision.ListDatasetEntries" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" '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 Source #

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 the entries (JSON Lines) within the dataset.

ListDatasetEntries, listDatasetEntriesResponse_nextToken - If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.

$sel:httpStatus:ListDatasetEntriesResponse', listDatasetEntriesResponse_httpStatus - The response's http status code.

Response Lenses

listDatasetEntriesResponse_datasetEntries :: Lens' ListDatasetEntriesResponse (Maybe [Text]) Source #

A list of the entries (JSON Lines) within the dataset.

listDatasetEntriesResponse_nextToken :: Lens' ListDatasetEntriesResponse (Maybe Text) Source #

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.

listDatasetEntriesResponse_httpStatus :: Lens' ListDatasetEntriesResponse Int Source #

The response's http status code.