| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.DescribeProjectVersions
Description
Lists and describes the models in an Amazon Rekognition Custom Labels
project. You can specify up to 10 model versions in
ProjectVersionArns. If you don't specify a value, descriptions for
all models are returned.
This operation requires permissions to perform the
rekognition:DescribeProjectVersions action.
This operation returns paginated results.
Synopsis
- data DescribeProjectVersions = DescribeProjectVersions' {
- nextToken :: Maybe Text
- versionNames :: Maybe (NonEmpty Text)
- maxResults :: Maybe Natural
- projectArn :: Text
- newDescribeProjectVersions :: Text -> DescribeProjectVersions
- describeProjectVersions_nextToken :: Lens' DescribeProjectVersions (Maybe Text)
- describeProjectVersions_versionNames :: Lens' DescribeProjectVersions (Maybe (NonEmpty Text))
- describeProjectVersions_maxResults :: Lens' DescribeProjectVersions (Maybe Natural)
- describeProjectVersions_projectArn :: Lens' DescribeProjectVersions Text
- data DescribeProjectVersionsResponse = DescribeProjectVersionsResponse' {}
- newDescribeProjectVersionsResponse :: Int -> DescribeProjectVersionsResponse
- describeProjectVersionsResponse_nextToken :: Lens' DescribeProjectVersionsResponse (Maybe Text)
- describeProjectVersionsResponse_projectVersionDescriptions :: Lens' DescribeProjectVersionsResponse (Maybe [ProjectVersionDescription])
- describeProjectVersionsResponse_httpStatus :: Lens' DescribeProjectVersionsResponse Int
Creating a Request
data DescribeProjectVersions Source #
See: newDescribeProjectVersions smart constructor.
Constructors
| DescribeProjectVersions' | |
Fields
| |
Instances
newDescribeProjectVersions Source #
Create a value of DescribeProjectVersions 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:nextToken:DescribeProjectVersions', describeProjectVersions_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:versionNames:DescribeProjectVersions', describeProjectVersions_versionNames - A list of model version names that you want to describe. You can add up
to 10 model version names to the list. If you don't specify a value,
all model descriptions are returned. A version name is part of a model
(ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the
version name in the following ARN.
arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.
$sel:maxResults:DescribeProjectVersions', describeProjectVersions_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.
$sel:projectArn:DescribeProjectVersions', describeProjectVersions_projectArn - The Amazon Resource Name (ARN) of the project that contains the models
you want to describe.
Request Lenses
describeProjectVersions_nextToken :: Lens' DescribeProjectVersions (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.
describeProjectVersions_versionNames :: Lens' DescribeProjectVersions (Maybe (NonEmpty Text)) Source #
A list of model version names that you want to describe. You can add up
to 10 model version names to the list. If you don't specify a value,
all model descriptions are returned. A version name is part of a model
(ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the
version name in the following ARN.
arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.
describeProjectVersions_maxResults :: Lens' DescribeProjectVersions (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.
describeProjectVersions_projectArn :: Lens' DescribeProjectVersions Text Source #
The Amazon Resource Name (ARN) of the project that contains the models you want to describe.
Destructuring the Response
data DescribeProjectVersionsResponse Source #
See: newDescribeProjectVersionsResponse smart constructor.
Constructors
| DescribeProjectVersionsResponse' | |
Fields
| |
Instances
newDescribeProjectVersionsResponse Source #
Create a value of DescribeProjectVersionsResponse 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:nextToken:DescribeProjectVersions', describeProjectVersionsResponse_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:projectVersionDescriptions:DescribeProjectVersionsResponse', describeProjectVersionsResponse_projectVersionDescriptions - A list of model descriptions. The list is sorted by the creation date
and time of the model versions, latest to earliest.
$sel:httpStatus:DescribeProjectVersionsResponse', describeProjectVersionsResponse_httpStatus - The response's http status code.
Response Lenses
describeProjectVersionsResponse_nextToken :: Lens' DescribeProjectVersionsResponse (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.
describeProjectVersionsResponse_projectVersionDescriptions :: Lens' DescribeProjectVersionsResponse (Maybe [ProjectVersionDescription]) Source #
A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.
describeProjectVersionsResponse_httpStatus :: Lens' DescribeProjectVersionsResponse Int Source #
The response's http status code.