GetProjectProfileCommand

Suggest an Edit

The details of the project profile.

Example Syntax

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

import { DataZoneClient, GetProjectProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetProjectProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetProjectProfileInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetProjectProfileCommand(input);
const response = await client.send(command);
// { // GetProjectProfileOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   status: "ENABLED" || "DISABLED",
//   environmentConfigurations: [ // EnvironmentConfigurationsList
//     { // EnvironmentConfiguration
//       name: "STRING_VALUE", // required
//       id: "STRING_VALUE",
//       environmentBlueprintId: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       deploymentMode: "ON_CREATE" || "ON_DEMAND",
//       configurationParameters: { // EnvironmentConfigurationParametersDetails
//         ssmPath: "STRING_VALUE",
//         parameterOverrides: [ // EnvironmentConfigurationParametersList
//           { // EnvironmentConfigurationParameter
//             name: "STRING_VALUE",
//             value: "STRING_VALUE",
//             isEditable: true || false,
//           },
//         ],
//         resolvedParameters: [
//           {
//             name: "STRING_VALUE",
//             value: "STRING_VALUE",
//             isEditable: true || false,
//           },
//         ],
//       },
//       awsAccount: { // AwsAccount Union: only one key present
//         awsAccountId: "STRING_VALUE",
//         awsAccountIdPath: "STRING_VALUE",
//       },
//       awsRegion: { // Region Union: only one key present
//         regionName: "STRING_VALUE",
//         regionNamePath: "STRING_VALUE",
//       },
//       deploymentOrder: Number("int"),
//     },
//   ],
//   createdBy: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"),
//   lastUpdatedAt: new Date("TIMESTAMP"),
//   domainUnitId: "STRING_VALUE",
// };

GetProjectProfileCommand Input

See GetProjectProfileCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain.

identifier
Required
string | undefined

The ID of the project profile.

GetProjectProfileCommand Output

See GetProjectProfileCommandOutput for details

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

The user who created the project profile.

domainId
Required
string | undefined

The ID of the domain of the project profile.

id
Required
string | undefined

The ID of the project profile.

name
Required
string | undefined

The name of the project profile.

createdAt
Date | undefined

The timestamp of when the project profile was created.

description
string | undefined

The description of the project profile.

domainUnitId
string | undefined

The ID of the domain unit of the project profile.

environmentConfigurations
EnvironmentConfiguration[] | undefined

The environment configurations of the project profile.

lastUpdatedAt
Date | undefined

The timestamp of when project profile was last updated.

status
Status | undefined

The status of the project 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.