ListEnvironmentBlueprintConfigurationsCommand

Suggest an Edit

Lists blueprint configurations for a Amazon DataZone environment.

Example Syntax

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

import { DataZoneClient, ListEnvironmentBlueprintConfigurationsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListEnvironmentBlueprintConfigurationsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListEnvironmentBlueprintConfigurationsInput
  domainIdentifier: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListEnvironmentBlueprintConfigurationsCommand(input);
const response = await client.send(command);
// { // ListEnvironmentBlueprintConfigurationsOutput
//   items: [ // EnvironmentBlueprintConfigurations
//     { // EnvironmentBlueprintConfigurationItem
//       domainId: "STRING_VALUE", // required
//       environmentBlueprintId: "STRING_VALUE", // required
//       provisioningRoleArn: "STRING_VALUE",
//       environmentRolePermissionBoundary: "STRING_VALUE",
//       manageAccessRoleArn: "STRING_VALUE",
//       enabledRegions: [ // EnabledRegionList
//         "STRING_VALUE",
//       ],
//       regionalParameters: { // RegionalParameterMap
//         "<keys>": { // RegionalParameter
//           "<keys>": "STRING_VALUE",
//         },
//       },
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//       provisioningConfigurations: [ // ProvisioningConfigurationList
//         { // ProvisioningConfiguration Union: only one key present
//           lakeFormationConfiguration: { // LakeFormationConfiguration
//             locationRegistrationRole: "STRING_VALUE",
//             locationRegistrationExcludeS3Locations: [ // S3LocationList
//               "STRING_VALUE",
//             ],
//           },
//         },
//       ],
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListEnvironmentBlueprintConfigurationsCommand Input

See ListEnvironmentBlueprintConfigurationsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

maxResults
number | undefined

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

nextToken
string | undefined

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

ListEnvironmentBlueprintConfigurationsCommand Output

See ListEnvironmentBlueprintConfigurationsCommandOutput for details

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

The results of the ListEnvironmentBlueprintConfigurations action.

nextToken
string | undefined

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

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.

ValidationException
client

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

ThrottlingException
client

The request was denied due to request throttling.

UnauthorizedException
client

You do not have permission to perform this action.

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