Skip to content

List Projects

datazone_list_projects R Documentation

Lists Amazon DataZone projects

Description

Lists Amazon DataZone projects.

Usage

datazone_list_projects(domainIdentifier, userIdentifier,
  groupIdentifier, name, projectCategory, nextToken, maxResults)

Arguments

domainIdentifier

[required] The identifier of the Amazon DataZone domain.

userIdentifier

The identifier of the Amazon DataZone user.

groupIdentifier

The identifier of a group.

name

The name of the project.

projectCategory

A parameter to filter projects by their category.

nextToken

When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to list_projects to list the next set of projects.

maxResults

The maximum number of projects to return in a single call to list_projects. When the number of projects to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to list_projects to list the next set of projects.

Value

A list with the following syntax:

list(
  items = list(
    list(
      domainId = "string",
      id = "string",
      name = "string",
      description = "string",
      projectStatus = "ACTIVE"|"DELETING"|"DELETE_FAILED"|"UPDATING"|"UPDATE_FAILED"|"MOVING",
      failureReasons = list(
        list(
          code = "string",
          message = "string"
        )
      ),
      createdBy = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      domainUnitId = "string",
      projectCategory = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_projects(
  domainIdentifier = "string",
  userIdentifier = "string",
  groupIdentifier = "string",
  name = "string",
  projectCategory = "string",
  nextToken = "string",
  maxResults = 123
)