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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about your Amazon Rekognition Custom Labels projects.

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

This operation returns paginated results.

Synopsis

data DescribeProjects = DescribeProjects' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- projectNames :: Maybe (NonEmpty Text)
}
newDescribeProjects :: DescribeProjects
describeProjects_maxResults :: Lens' DescribeProjects (Maybe Natural)
describeProjects_nextToken :: Lens' DescribeProjects (Maybe Text)
describeProjects_projectNames :: Lens' DescribeProjects (Maybe (NonEmpty Text))
data DescribeProjectsResponse = DescribeProjectsResponse' {
- nextToken :: Maybe Text
- projectDescriptions :: Maybe [ProjectDescription]
- httpStatus :: Int
}
newDescribeProjectsResponse :: Int -> DescribeProjectsResponse
describeProjectsResponse_nextToken :: Lens' DescribeProjectsResponse (Maybe Text)
describeProjectsResponse_projectDescriptions :: Lens' DescribeProjectsResponse (Maybe [ProjectDescription])
describeProjectsResponse_httpStatus :: Lens' DescribeProjectsResponse Int

Creating a Request

data DescribeProjects Source #

See: newDescribeProjects smart constructor.

Constructors

DescribeProjects'

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.
projectNames :: Maybe (NonEmpty Text)
A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Instances

Instances details

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

newDescribeProjects :: DescribeProjects Source #

Create a value of DescribeProjects 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:DescribeProjects', describeProjects_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.

DescribeProjects, describeProjects_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:projectNames:DescribeProjects', describeProjects_projectNames - A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Request Lenses

describeProjects_maxResults :: Lens' DescribeProjects (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.

describeProjects_nextToken :: Lens' DescribeProjects (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.

describeProjects_projectNames :: Lens' DescribeProjects (Maybe (NonEmpty Text)) Source #

A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Destructuring the Response

data DescribeProjectsResponse Source #

See: newDescribeProjectsResponse smart constructor.

Constructors

DescribeProjectsResponse'

Fields

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.
projectDescriptions :: Maybe [ProjectDescription]
A list of project descriptions. The list is sorted by the date and time the projects are created.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeProjectsResponse Source #

Arguments

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

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

DescribeProjects, describeProjectsResponse_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:projectDescriptions:DescribeProjectsResponse', describeProjectsResponse_projectDescriptions - A list of project descriptions. The list is sorted by the date and time the projects are created.

$sel:httpStatus:DescribeProjectsResponse', describeProjectsResponse_httpStatus - The response's http status code.

Response Lenses

describeProjectsResponse_nextToken :: Lens' DescribeProjectsResponse (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.

describeProjectsResponse_projectDescriptions :: Lens' DescribeProjectsResponse (Maybe [ProjectDescription]) Source #

A list of project descriptions. The list is sorted by the date and time the projects are created.

describeProjectsResponse_httpStatus :: Lens' DescribeProjectsResponse Int Source #

The response's http status code.