ListProjects
Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in
which you call ListProjects
.
The ListProjects
operation is eventually consistent.
Recent calls to CreateProject
and DeleteProject
might
take a while to appear in the response from ListProjects
.
This operation requires permissions to perform the
lookoutvision:ListProjects
operation.
Request Syntax
GET /2020-11-20/projects?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- 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.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.
Length Constraints: Maximum length of 2048.
Pattern:
^[a-zA-Z0-9\/\+\=]{0,2048}$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Projects": [
{
"CreationTimestamp": number,
"ProjectArn": "string",
"ProjectName": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[a-zA-Z0-9\/\+\=]{0,2048}$
- Projects
-
A list of projects in your AWS account.
Type: Array of ProjectMetadata objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 403
- ConflictException
-
The update or deletion of a resource caused an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Amazon Lookout for Vision experienced a service issue. Try your call again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
HTTP Status Code: 429
- ValidationException
-
An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: