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.ListDatasetLabels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- datasetLabelDescriptions :: Maybe [DatasetLabelDescription]
- nextToken :: Maybe Text
- httpStatus :: Int
}
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.

Constructors

ListDatasetLabels'

Fields

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.
datasetArn :: Text
The Amazon Resource Name (ARN) of the dataset that you want to use.

Instances

Instances details

ToJSON ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods toJSON :: ListDatasetLabels -> Value # toEncoding :: ListDatasetLabels -> Encoding # toJSONList :: [ListDatasetLabels] -> Value # toEncodingList :: [ListDatasetLabels] -> Encoding #
ToHeaders ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods toHeaders :: ListDatasetLabels -> [Header] #
ToPath ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods toPath :: ListDatasetLabels -> ByteString #
ToQuery ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods toQuery :: ListDatasetLabels -> QueryString #
AWSPager ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods page :: ListDatasetLabels -> AWSResponse ListDatasetLabels -> Maybe ListDatasetLabels #
AWSRequest ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Associated Types type AWSResponse ListDatasetLabels # Methods request :: (Service -> Service) -> ListDatasetLabels -> Request ListDatasetLabels # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDatasetLabels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDatasetLabels))) #
Generic ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Associated Types type Rep ListDatasetLabels :: Type -> Type # Methods from :: ListDatasetLabels -> Rep ListDatasetLabels x # to :: Rep ListDatasetLabels x -> ListDatasetLabels #
Read ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods readsPrec :: Int -> ReadS ListDatasetLabels # readList :: ReadS [ListDatasetLabels] # readPrec :: ReadPrec ListDatasetLabels # readListPrec :: ReadPrec [ListDatasetLabels] #
Show ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods showsPrec :: Int -> ListDatasetLabels -> ShowS # show :: ListDatasetLabels -> String # showList :: [ListDatasetLabels] -> ShowS #
NFData ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods rnf :: ListDatasetLabels -> () #
Eq ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods (==) :: ListDatasetLabels -> ListDatasetLabels -> Bool # (/=) :: ListDatasetLabels -> ListDatasetLabels -> Bool #
Hashable ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods hashWithSalt :: Int -> ListDatasetLabels -> Int # hash :: ListDatasetLabels -> Int #
type AWSResponse ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels type AWSResponse ListDatasetLabels = ListDatasetLabelsResponse
type Rep ListDatasetLabels Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels type Rep ListDatasetLabels = D1 ('MetaData "ListDatasetLabels" "Amazonka.Rekognition.ListDatasetLabels" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListDatasetLabels'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDatasetLabels Source #

Arguments

:: Text	`ListDatasetLabels`
-> ListDatasetLabels

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.

Constructors

ListDatasetLabelsResponse'

Fields

datasetLabelDescriptions :: Maybe [DatasetLabelDescription]
A list of the labels 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

Instances details

Generic ListDatasetLabelsResponse Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Associated Types type Rep ListDatasetLabelsResponse :: Type -> Type # Methods from :: ListDatasetLabelsResponse -> Rep ListDatasetLabelsResponse x # to :: Rep ListDatasetLabelsResponse x -> ListDatasetLabelsResponse #
Read ListDatasetLabelsResponse Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods readsPrec :: Int -> ReadS ListDatasetLabelsResponse # readList :: ReadS [ListDatasetLabelsResponse] # readPrec :: ReadPrec ListDatasetLabelsResponse # readListPrec :: ReadPrec [ListDatasetLabelsResponse] #
Show ListDatasetLabelsResponse Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods showsPrec :: Int -> ListDatasetLabelsResponse -> ShowS # show :: ListDatasetLabelsResponse -> String # showList :: [ListDatasetLabelsResponse] -> ShowS #
NFData ListDatasetLabelsResponse Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods rnf :: ListDatasetLabelsResponse -> () #
Eq ListDatasetLabelsResponse Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels Methods (==) :: ListDatasetLabelsResponse -> ListDatasetLabelsResponse -> Bool # (/=) :: ListDatasetLabelsResponse -> ListDatasetLabelsResponse -> Bool #
type Rep ListDatasetLabelsResponse Source #
Instance details Defined in Amazonka.Rekognition.ListDatasetLabels type Rep ListDatasetLabelsResponse = D1 ('MetaData "ListDatasetLabelsResponse" "Amazonka.Rekognition.ListDatasetLabels" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListDatasetLabelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetLabelDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatasetLabelDescription])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDatasetLabelsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDatasetLabelsResponse'`
-> ListDatasetLabelsResponse

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.