ListEnvironmentsCommand

Suggest an Edit

Lists Amazon DataZone environments.

Example Syntax

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

import { DataZoneClient, ListEnvironmentsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListEnvironmentsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListEnvironmentsInput
  domainIdentifier: "STRING_VALUE", // required
  awsAccountId: "STRING_VALUE",
  status: "ACTIVE" || "CREATING" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED" || "VALIDATION_FAILED" || "SUSPENDED" || "DISABLED" || "EXPIRED" || "DELETED" || "INACCESSIBLE",
  awsAccountRegion: "STRING_VALUE",
  projectIdentifier: "STRING_VALUE", // required
  environmentProfileIdentifier: "STRING_VALUE",
  environmentBlueprintIdentifier: "STRING_VALUE",
  provider: "STRING_VALUE",
  name: "STRING_VALUE",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListEnvironmentsCommand(input);
const response = await client.send(command);
// { // ListEnvironmentsOutput
//   items: [ // EnvironmentSummaries // required
//     { // EnvironmentSummary
//       projectId: "STRING_VALUE", // required
//       id: "STRING_VALUE",
//       domainId: "STRING_VALUE", // required
//       createdBy: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       environmentProfileId: "STRING_VALUE",
//       awsAccountId: "STRING_VALUE",
//       awsAccountRegion: "STRING_VALUE",
//       provider: "STRING_VALUE", // required
//       status: "ACTIVE" || "CREATING" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED" || "VALIDATION_FAILED" || "SUSPENDED" || "DISABLED" || "EXPIRED" || "DELETED" || "INACCESSIBLE",
//       environmentConfigurationId: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListEnvironmentsCommand Input

See ListEnvironmentsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

projectIdentifier
Required
string | undefined

The identifier of the Amazon DataZone project.

awsAccountId
string | undefined

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

awsAccountRegion
string | undefined

The Amazon Web Services region where you want to list environments.

environmentBlueprintIdentifier
string | undefined

The identifier of the Amazon DataZone blueprint.

environmentProfileIdentifier
string | undefined

The identifier of the environment profile.

maxResults
number | undefined

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

name
string | undefined

The name of the environment.

nextToken
string | undefined

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

provider
string | undefined

The provider of the environment.

status
EnvironmentStatus | undefined

The status of the environments that you want to list.

ListEnvironmentsCommand Output

See ListEnvironmentsCommandOutput for details

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

The results of the ListEnvironments action.

nextToken
string | undefined

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

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.