ListProjectsCommand

Suggest an Edit

Lists Amazon DataZone projects.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, ListProjectsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListProjectsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListProjectsInput
  domainIdentifier: "STRING_VALUE", // required
  userIdentifier: "STRING_VALUE",
  groupIdentifier: "STRING_VALUE",
  name: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListProjectsCommand(input);
const response = await client.send(command);
// { // ListProjectsOutput
//   items: [ // ProjectSummaries
//     { // ProjectSummary
//       domainId: "STRING_VALUE", // required
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       projectStatus: "ACTIVE" || "DELETING" || "DELETE_FAILED" || "UPDATING" || "UPDATE_FAILED",
//       failureReasons: [ // FailureReasons
//         { // ProjectDeletionError
//           code: "STRING_VALUE",
//           message: "STRING_VALUE",
//         },
//       ],
//       createdBy: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//       domainUnitId: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListProjectsCommand Input

See ListProjectsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

groupIdentifier
string | undefined

The identifier of a group.

maxResults
number | undefined

The maximum number of projects to return in a single call to ListProjects. 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 ListProjects to list the next set of projects.

name
string | undefined

The name of the project.

nextToken
string | undefined

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 ListProjects to list the next set of projects.

userIdentifier
string | undefined

The identifier of the Amazon DataZone user.

ListProjectsCommand Output

See ListProjectsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
ProjectSummary[] | undefined

The results of the ListProjects action.

nextToken
string | undefined

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 ListProjects to list the next set of projects.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.