- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeProjectCommand
Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:DescribeProject operation.
Example Syntax
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 import
const 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",
// },
// ],
// },
// };
DescribeProjectCommand Input
See DescribeProjectCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ProjectNameRequired | string | undefined | The name of the project that you want to describe. |
DescribeProjectCommand Output
See DescribeProjectCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ProjectDescription | ProjectDescription | undefined | The description of the project. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You are not authorized to perform the action. |
| ConflictException | client | The update or deletion of a resource caused an inconsistent state. |
| InternalServerException | server | Amazon Lookout for Vision experienced a service issue. Try your call again. |
| ResourceNotFoundException | client | The resource could not be found. |
| ThrottlingException | client | Amazon Lookout for Vision is temporarily unable to process the request. Try your call again. |
| ValidationException | client | 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. |