Skip to content

Describe Projects

rekognition_describe_projects R Documentation

Gets information about your Rekognition projects

Description

Gets information about your Rekognition projects.

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

Usage

rekognition_describe_projects(NextToken, MaxResults, ProjectNames,
  Features)

Arguments

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.

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.

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.

Features

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

Value

A list with the following syntax: 

list(
  ProjectDescriptions = list(
    list(
      ProjectArn = "string",
      CreationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Status = "CREATING"|"CREATED"|"DELETING",
      Datasets = list(
        list(
          CreationTimestamp = as.POSIXct(
            "2015-01-01"
          ),
          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"
        )
      ),
      Feature = "CONTENT_MODERATION"|"CUSTOM_LABELS",
      AutoUpdate = "ENABLED"|"DISABLED"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_projects(
  NextToken = "string",
  MaxResults = 123,
  ProjectNames = list(
    "string"
  ),
  Features = list(
    "CONTENT_MODERATION"|"CUSTOM_LABELS"
  )
)

Examples

## Not run: 
# Describes an Amazon Rekognition Custom Labels projects.
svc$describe_projects(
  ProjectNames = list(
    "my-project"
  )
)

## End(Not run)