CreateProject
Important
End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Lookout for Vision. After October 31, 2025, you will no longer be able to access the Lookout for Vision console or Lookout for Vision resources. For more information, visit this blog post.
Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset.
This operation requires permissions to perform the
lookoutvision:CreateProject
operation.
Request Syntax
POST /2020-11-20/projects HTTP/1.1
X-Amzn-Client-Token: ClientToken
Content-type: application/json
{
"ProjectName": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- ClientToken
-
ClientToken is an idempotency token that ensures a call to
CreateProject
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response fromCreateProject
. In this case, safely retry your call toCreateProject
by using the sameClientToken
parameter value.If you don't supply a value for
ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project creation requests. You'll need to provide your own value for other use cases.An error occurs if the other input parameters are not the same as in the first request. Using a different value for
ClientToken
is considered a new call toCreateProject
. An idempotency token is active for 8 hours.Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-]+$
Request Body
The request accepts the following data in JSON format.
- ProjectName
-
The name for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_\-]*
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ProjectMetadata": {
"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.
- ProjectMetadata
-
Information about the project.
Type: ProjectMetadata object
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
- ServiceQuotaExceededException
-
A service quota exceeded the allowed limit. For more information, see Quotas in Amazon Lookout for Vision.
HTTP Status Code: 402
- 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: