ListEnvironmentProfilesCommand

Lists Amazon DataZone environment profiles.

Example Syntax

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

import { DataZoneClient, ListEnvironmentProfilesCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListEnvironmentProfilesCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListEnvironmentProfilesInput
  domainIdentifier: "STRING_VALUE", // required
  awsAccountId: "STRING_VALUE",
  awsAccountRegion: "STRING_VALUE",
  environmentBlueprintIdentifier: "STRING_VALUE",
  projectIdentifier: "STRING_VALUE",
  name: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListEnvironmentProfilesCommand(input);
const response = await client.send(command);
// { // ListEnvironmentProfilesOutput
//   items: [ // EnvironmentProfileSummaries // required
//     { // EnvironmentProfileSummary
//       id: "STRING_VALUE", // required
//       domainId: "STRING_VALUE", // required
//       awsAccountId: "STRING_VALUE",
//       awsAccountRegion: "STRING_VALUE",
//       createdBy: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       environmentBlueprintId: "STRING_VALUE", // required
//       projectId: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListEnvironmentProfilesCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

awsAccountId
string | undefined

The identifier of the Amazon Web Services account where you want to list environment profiles.

awsAccountRegion
string | undefined

The Amazon Web Services region where you want to list environment profiles.

environmentBlueprintIdentifier
string | undefined

The identifier of the blueprint that was used to create the environment profiles that you want to list.

maxResults
number | undefined

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

name
string | undefined
<p/>
nextToken
string | undefined

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

projectIdentifier
string | undefined

The identifier of the Amazon DataZone project.

ListEnvironmentProfilesCommand Output

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

The results of the ListEnvironmentProfiles action.

nextToken
string | undefined

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