| 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
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' {}
- 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
| |
Instances
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
| |
Instances
newDescribeProjectsResponse Source #
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.