GetEnvironmentProfileCommand

Gets an evinronment profile in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, GetEnvironmentProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetEnvironmentProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetEnvironmentProfileInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetEnvironmentProfileCommand(input);
const response = await client.send(command);
// { // GetEnvironmentProfileOutput
//   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",
//   userParameters: [ // CustomParameterList
//     { // CustomParameter
//       keyName: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       fieldType: "STRING_VALUE", // required
//       defaultValue: "STRING_VALUE",
//       isEditable: true || false,
//       isOptional: true || false,
//     },
//   ],
// };

GetEnvironmentProfileCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which this environment profile exists.

identifier
Required
string | undefined

The ID of the environment profile.

GetEnvironmentProfileCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
createdBy
Required
string | undefined

The Amazon DataZone user who created this environment profile.

domainId
Required
string | undefined

The ID of the Amazon DataZone domain in which this environment profile exists.

environmentBlueprintId
Required
string | undefined

The ID of the blueprint with which this environment profile is created.

id
Required
string | undefined

The ID of the environment profile.

name
Required
string | undefined

The name of the environment profile.

awsAccountId
string | undefined

The ID of the Amazon Web Services account where this environment profile exists.

awsAccountRegion
string | undefined

The Amazon Web Services region where this environment profile exists.

createdAt
Date | undefined

The timestamp of when this environment profile was created.

description
string | undefined

The description of the environment profile.

projectId
string | undefined

The ID of the Amazon DataZone project in which this environment profile is created.

updatedAt
Date | undefined

The timestamp of when this environment profile was upated.

userParameters
CustomParameter[] | undefined

The user parameters of the environment profile.

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.