UpdateEnvironmentProfileCommand

Suggest an Edit

Updates the specified environment profile in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, UpdateEnvironmentProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateEnvironmentProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateEnvironmentProfileInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  name: "STRING_VALUE",
  description: "STRING_VALUE",
  userParameters: [ // EnvironmentParametersList
    { // EnvironmentParameter
      name: "STRING_VALUE",
      value: "STRING_VALUE",
    },
  ],
  awsAccountId: "STRING_VALUE",
  awsAccountRegion: "STRING_VALUE",
};
const command = new UpdateEnvironmentProfileCommand(input);
const response = await client.send(command);
// { // UpdateEnvironmentProfileOutput
//   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,
//     },
//   ],
// };

UpdateEnvironmentProfileCommand Input

See UpdateEnvironmentProfileCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

identifier
Required
string | undefined

The identifier of the environment profile that is to be updated.

awsAccountId
string | undefined

The Amazon Web Services account in which a specified environment profile is to be udpated.

awsAccountRegion
string | undefined

The Amazon Web Services Region in which a specified environment profile is to be updated.

description
string | undefined

The description to be updated as part of the UpdateEnvironmentProfile action.

name
string | undefined

The name to be updated as part of the UpdateEnvironmentProfile action.

userParameters
EnvironmentParameter[] | undefined

The user parameters to be updated as part of the UpdateEnvironmentProfile action.

UpdateEnvironmentProfileCommand Output

See UpdateEnvironmentProfileCommandOutput for details

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

The Amazon DataZone user who created the environment profile.

domainId
Required
string | undefined

The identifier of the Amazon DataZone domain in which the environment profile is to be updated.

environmentBlueprintId
Required
string | undefined

The identifier of the blueprint of the environment profile that is to be updated.

id
Required
string | undefined

The identifier of the environment profile that is to be udpated.

name
Required
string | undefined

The name to be updated as part of the UpdateEnvironmentProfile action.

awsAccountId
string | undefined

The Amazon Web Services account in which a specified environment profile is to be udpated.

awsAccountRegion
string | undefined

The Amazon Web Services Region in which a specified environment profile is to be updated.

createdAt
Date | undefined

The timestamp of when the environment profile was created.

description
string | undefined

The description to be updated as part of the UpdateEnvironmentProfile action.

projectId
string | undefined

The identifier of the project of the environment profile that is to be updated.

updatedAt
Date | undefined

The timestamp of when the environment profile was updated.

userParameters
CustomParameter[] | undefined

The user parameters to be updated as part of the UpdateEnvironmentProfile action.

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.