describe_project

LookoutforVision.Client.describe_project(**kwargs)

Describes an Amazon Lookout for Vision project.

This operation requires permissions to perform the lookoutvision:DescribeProject operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    ProjectName='string'
)

Parameters

ProjectName (string) --

[REQUIRED]

The name of the project that you want to describe.

Return type

dict

Returns

Response Syntax

{
    'ProjectDescription': {
        'ProjectArn': 'string',
        'ProjectName': 'string',
        'CreationTimestamp': datetime(2015, 1, 1),
        'Datasets': [
            {
                'DatasetType': 'string',
                'CreationTimestamp': datetime(2015, 1, 1),
                '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'
            },
        ]
    }
}

Response Structure

• (dict) --
  • ProjectDescription (dict) --

    The description of the project.

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project.

    • ProjectName (string) --

      The name of the project.

    • CreationTimestamp (datetime) --

      The unix timestamp for the date and time that the project was created.

    • Datasets (list) --

      A list of datasets in the project.

      • (dict) --

        Summary information for an Amazon Lookout for Vision dataset. For more information, see DescribeDataset and ProjectDescription.

        • DatasetType (string) --

          The type of the dataset.

        • CreationTimestamp (datetime) --

          The Unix timestamp for the date and time that the dataset was created.

        • Status (string) --

          The status for the dataset.

        • StatusMessage (string) --

          The status message for the dataset.

Exceptions

• LookoutforVision.Client.exceptions.AccessDeniedException
• LookoutforVision.Client.exceptions.InternalServerException
• LookoutforVision.Client.exceptions.ValidationException
• LookoutforVision.Client.exceptions.ConflictException
• LookoutforVision.Client.exceptions.ResourceNotFoundException
• LookoutforVision.Client.exceptions.ThrottlingException