ListEnvironmentBlueprintsCommand

Suggest an Edit

Lists blueprints in an Amazon DataZone environment.

Example Syntax

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

import { DataZoneClient, ListEnvironmentBlueprintsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListEnvironmentBlueprintsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListEnvironmentBlueprintsInput
  domainIdentifier: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  name: "STRING_VALUE",
  managed: true || false,
};
const command = new ListEnvironmentBlueprintsCommand(input);
const response = await client.send(command);
// { // ListEnvironmentBlueprintsOutput
//   items: [ // EnvironmentBlueprintSummaries // required
//     { // EnvironmentBlueprintSummary
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       provider: "STRING_VALUE", // required
//       provisioningProperties: { // ProvisioningProperties Union: only one key present
//         cloudFormation: { // CloudFormationProperties
//           templateUrl: "STRING_VALUE", // required
//         },
//       },
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListEnvironmentBlueprintsCommand Input

See ListEnvironmentBlueprintsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

managed
boolean | undefined

Specifies whether the environment blueprint is managed by Amazon DataZone.

maxResults
number | undefined

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

name
string | undefined

The name of the Amazon DataZone environment.

nextToken
string | undefined

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

ListEnvironmentBlueprintsCommand Output

See ListEnvironmentBlueprintsCommandOutput for details

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

The results of the ListEnvironmentBlueprints action.

nextToken
string | undefined

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

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.

ResourceNotFoundException
client

The specified resource cannot be found.

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.