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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

This operation requires permissions to perform the rekognition:DescribeDataset action.

Creating a Request

data DescribeDataset Source #

See: newDescribeDataset smart constructor.

Constructors

DescribeDataset'
Fields datasetArn :: Text The Amazon Resource Name (ARN) of the dataset that you want to describe.

Instances

Instances details

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

newDescribeDataset Source #

Arguments

:: Text	`DescribeDataset`
-> DescribeDataset

Create a value of DescribeDataset 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:

DescribeDataset, describeDataset_datasetArn - The Amazon Resource Name (ARN) of the dataset that you want to describe.

Request Lenses

describeDataset_datasetArn :: Lens' DescribeDataset Text Source #

The Amazon Resource Name (ARN) of the dataset that you want to describe.

Destructuring the Response

data DescribeDatasetResponse Source #

See: newDescribeDatasetResponse smart constructor.

Constructors

DescribeDatasetResponse'
Fields datasetDescription :: Maybe DatasetDescription The description for the dataset. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDatasetResponse Source #

Arguments

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

Create a value of DescribeDatasetResponse 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:datasetDescription:DescribeDatasetResponse', describeDatasetResponse_datasetDescription - The description for the dataset.

$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.

Response Lenses

describeDatasetResponse_datasetDescription :: Lens' DescribeDatasetResponse (Maybe DatasetDescription) Source #

The description for the dataset.

describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #

The response's http status code.