ListProjectProfilesCommand

Lists project profiles.

Example Syntax

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

import { DataZoneClient, ListProjectProfilesCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListProjectProfilesCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListProjectProfilesInput
  domainIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE",
  sortBy: "NAME",
  sortOrder: "ASCENDING" || "DESCENDING",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListProjectProfilesCommand(input);
const response = await client.send(command);
// { // ListProjectProfilesOutput
//   items: [ // ProjectProfileSummaries
//     { // ProjectProfileSummary
//       domainId: "STRING_VALUE", // required
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       status: "ENABLED" || "DISABLED",
//       createdBy: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"),
//       lastUpdatedAt: new Date("TIMESTAMP"),
//       domainUnitId: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListProjectProfilesCommand Input

See ListProjectProfilesCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where you want to list project profiles.

maxResults
number | undefined

The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project profiles 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 ListProjectProfiles to list the next set of project profiles.

name
string | undefined

The name of a project profile.

nextToken
string | undefined

When the number of project profiles 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 project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.

sortBy
SortFieldProject | undefined

Specifies by what to sort project profiles.

sortOrder
SortOrder | undefined

Specifies the sort order of the project profiles.

ListProjectProfilesCommand Output

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

The results of the ListProjectProfiles action.

nextToken
string | undefined

When the number of project profiles 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 project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.

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.