UpdateProjectProfileCommand

Updates a project profile.

Example Syntax

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

import { DataZoneClient, UpdateProjectProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateProjectProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateProjectProfileInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  name: "STRING_VALUE",
  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"),
    },
  ],
  domainUnitIdentifier: "STRING_VALUE",
};
const command = new UpdateProjectProfileCommand(input);
const response = await client.send(command);
// { // UpdateProjectProfileOutput
//   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",
// };

UpdateProjectProfileCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where a project profile is to be updated.

identifier
Required
string | undefined

The ID of a project profile that is to be updated.

description
string | undefined

The description of a project profile.

domainUnitIdentifier
string | undefined

The ID of the domain unit where a project profile is to be updated.

environmentConfigurations
EnvironmentConfiguration[] | undefined

The environment configurations of a project profile.

name
string | undefined

The name of a project profile.

status
Status | undefined

The status of a project profile.

UpdateProjectProfileCommand Output

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

The user who created a project profile.

domainId
Required
string | undefined

The ID of the domain where project profile is to be updated.

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 at which a project profile is created.

description
string | undefined

The description of a project profile.

domainUnitId
string | undefined

The domain unit ID of the project profile to be updated.

environmentConfigurations
EnvironmentConfiguration[] | undefined

The environment configurations of a project profile.

lastUpdatedAt
Date | undefined

The timestamp at which a 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.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

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.