AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeProjects operation. Gets information about your Rekognition projects.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.DescribeProjectsRequest

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeProjectsRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The DescribeProjectsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeProjectsRequest()

Properties

NameTypeDescription
Public Property Features System.Collections.Generic.List<System.String>

Gets and sets the property Features.

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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.

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Public Property ProjectNames System.Collections.Generic.List<System.String>

Gets and sets the property ProjectNames.

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

Examples

Describes an Amazon Rekognition Custom Labels projects.

To describe an Amazon Rekognition Custom Labels project.


var client = new AmazonRekognitionClient();
var response = client.DescribeProjects(new DescribeProjectsRequest 
{
    ProjectNames = new List<string> {
        "my-project"
    }
});

List<ProjectDescription> projectDescriptions = response.ProjectDescriptions;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5