Rekognition / Client / describe_projects

describe_projects

Rekognition.Client.describe_projects(**kwargs)

Gets information about your Amazon Rekognition Custom Labels projects.

This operation requires permissions to perform the rekognition:DescribeProjects action.

See also: AWS API Documentation

Request Syntax

response = client.describe_projects(
    NextToken='string',
    MaxResults=123,
    ProjectNames=[
        'string',
    ]
)

Parameters:

• NextToken (string) – If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

• MaxResults (integer) – 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.

• ProjectNames (list) –

  A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don’t specify a value, the response includes descriptions for all the projects in your AWS account.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ProjectDescriptions': [
        {
            'ProjectArn': 'string',
            'CreationTimestamp': datetime(2015, 1, 1),
            'Status': 'CREATING'|'CREATED'|'DELETING',
            'Datasets': [
                {
                    'CreationTimestamp': datetime(2015, 1, 1),
                    'DatasetType': 'TRAIN'|'TEST',
                    'DatasetArn': 'string',
                    'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS',
                    'StatusMessage': 'string',
                    'StatusMessageCode': 'SUCCESS'|'SERVICE_ERROR'|'CLIENT_ERROR'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ProjectDescriptions (list) –

    A list of project descriptions. The list is sorted by the date and time the projects are created.

    • (dict) –

      A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects.

      • ProjectArn (string) –

        The Amazon Resource Name (ARN) of the project.

      • CreationTimestamp (datetime) –

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

      • Status (string) –

        The current status of the project.

      • Datasets (list) –

        Information about the training and test datasets in the project.

        • (dict) –

          Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see ProjectDescription.

          • CreationTimestamp (datetime) –

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

          • DatasetType (string) –

            The type of the dataset.

          • DatasetArn (string) –

            The Amazon Resource Name (ARN) for the dataset.

          • Status (string) –

            The status for the dataset.

          • StatusMessage (string) –

            The status message for the dataset.

          • StatusMessageCode (string) –

            The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

  • NextToken (string) –

    If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Exceptions

• Rekognition.Client.exceptions.InvalidPaginationTokenException

• Rekognition.Client.exceptions.InvalidParameterException

• Rekognition.Client.exceptions.AccessDeniedException

• Rekognition.Client.exceptions.InternalServerError

• Rekognition.Client.exceptions.ThrottlingException

• Rekognition.Client.exceptions.ProvisionedThroughputExceededException