We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:DescribeProject operation.
lookoutvision:DescribeProject
Use a bare-bones client and the command you need to make an API call.
import { LookoutVisionClient, DescribeProjectCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import// const { LookoutVisionClient, DescribeProjectCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS importconst client = new LookoutVisionClient(config);const input = { // DescribeProjectRequest ProjectName: "STRING_VALUE", // required};const command = new DescribeProjectCommand(input);const response = await client.send(command);// { // DescribeProjectResponse// ProjectDescription: { // ProjectDescription// ProjectArn: "STRING_VALUE",// ProjectName: "STRING_VALUE",// CreationTimestamp: new Date("TIMESTAMP"),// Datasets: [ // DatasetMetadataList// { // DatasetMetadata// DatasetType: "STRING_VALUE",// CreationTimestamp: new Date("TIMESTAMP"),// Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_COMPLETE" || "UPDATE_FAILED_ROLLBACK_IN_PROGRESS" || "UPDATE_FAILED_ROLLBACK_COMPLETE" || "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED",// StatusMessage: "STRING_VALUE",// },// ],// },// };
DescribeProjectCommandInput
DescribeProjectCommandOutput
input
response
config
AccessDeniedException (client fault)
You are not authorized to perform the action.
ConflictException (client fault)
The update or deletion of a resource caused an inconsistent state.
InternalServerException (server fault)
Amazon Lookout for Vision experienced a service issue. Try your call again.
ResourceNotFoundException (client fault)
The resource could not be found.
ThrottlingException (client fault)
Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
ValidationException (client fault)
An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
LookoutVisionServiceException
Base exception class for all service exceptions from LookoutVision service.
Readonly
Static
Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the
lookoutvision:DescribeProject
operation.Example
Use a bare-bones client and the command you need to make an API call.
Param
DescribeProjectCommandInput
Returns
DescribeProjectCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
You are not authorized to perform the action.
Throws
ConflictException (client fault)
The update or deletion of a resource caused an inconsistent state.
Throws
InternalServerException (server fault)
Amazon Lookout for Vision experienced a service issue. Try your call again.
Throws
ResourceNotFoundException (client fault)
The resource could not be found.
Throws
ThrottlingException (client fault)
Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
Throws
ValidationException (client fault)
An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
Throws
LookoutVisionServiceException
Base exception class for all service exceptions from LookoutVision service.