UpdateEnvironmentCommand

Suggest an Edit

Updates the specified environment in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, UpdateEnvironmentCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateEnvironmentCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateEnvironmentInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  name: "STRING_VALUE",
  description: "STRING_VALUE",
  glossaryTerms: [ // GlossaryTerms
    "STRING_VALUE",
  ],
  blueprintVersion: "STRING_VALUE",
  userParameters: [ // EnvironmentParametersList
    { // EnvironmentParameter
      name: "STRING_VALUE",
      value: "STRING_VALUE",
    },
  ],
};
const command = new UpdateEnvironmentCommand(input);
const response = await client.send(command);
// { // UpdateEnvironmentOutput
//   projectId: "STRING_VALUE", // required
//   id: "STRING_VALUE",
//   domainId: "STRING_VALUE", // required
//   createdBy: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   environmentProfileId: "STRING_VALUE",
//   awsAccountId: "STRING_VALUE",
//   awsAccountRegion: "STRING_VALUE",
//   provider: "STRING_VALUE", // required
//   provisionedResources: [ // ResourceList
//     { // Resource
//       provider: "STRING_VALUE",
//       name: "STRING_VALUE",
//       value: "STRING_VALUE", // required
//       type: "STRING_VALUE", // required
//     },
//   ],
//   status: "ACTIVE" || "CREATING" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED" || "VALIDATION_FAILED" || "SUSPENDED" || "DISABLED" || "EXPIRED" || "DELETED" || "INACCESSIBLE",
//   environmentActions: [ // EnvironmentActionList
//     { // ConfigurableEnvironmentAction
//       type: "STRING_VALUE", // required
//       auth: "IAM" || "HTTPS",
//       parameters: [ // ConfigurableActionParameterList // required
//         { // ConfigurableActionParameter
//           key: "STRING_VALUE",
//           value: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   glossaryTerms: [ // GlossaryTerms
//     "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,
//     },
//   ],
//   lastDeployment: { // Deployment
//     deploymentId: "STRING_VALUE",
//     deploymentType: "CREATE" || "UPDATE" || "DELETE",
//     deploymentStatus: "IN_PROGRESS" || "SUCCESSFUL" || "FAILED" || "PENDING_DEPLOYMENT",
//     failureReason: { // EnvironmentError
//       code: "STRING_VALUE",
//       message: "STRING_VALUE", // required
//     },
//     messages: [ // DeploymentMessagesList
//       "STRING_VALUE",
//     ],
//     isDeploymentComplete: true || false,
//   },
//   provisioningProperties: { // ProvisioningProperties Union: only one key present
//     cloudFormation: { // CloudFormationProperties
//       templateUrl: "STRING_VALUE", // required
//     },
//   },
//   deploymentProperties: { // DeploymentProperties
//     startTimeoutMinutes: Number("int"),
//     endTimeoutMinutes: Number("int"),
//   },
//   environmentBlueprintId: "STRING_VALUE",
//   environmentConfigurationId: "STRING_VALUE",
// };

UpdateEnvironmentCommand Input

See UpdateEnvironmentCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

identifier
Required
string | undefined

The identifier of the environment that is to be updated.

blueprintVersion
string | undefined

The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.

description
string | undefined

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

glossaryTerms
string[] | undefined

The glossary terms to be updated as part of the UpdateEnvironment action.

name
string | undefined

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

userParameters
EnvironmentParameter[] | undefined

The user parameters of the environment.

UpdateEnvironmentCommand Output

See UpdateEnvironmentCommandOutput 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.

domainId
Required
string | undefined

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

name
Required
string | undefined

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

projectId
Required
string | undefined

The project identifier of the environment.

provider
Required
string | undefined

The provider identifier of the environment.

awsAccountId
string | undefined

The identifier of the Amazon Web Services account in which the environment is to be updated.

awsAccountRegion
string | undefined

The Amazon Web Services Region in which the environment is updated.

createdAt
Date | undefined

The timestamp of when the environment was created.

deploymentProperties
DeploymentProperties | undefined

The deployment properties to be updated as part of the UpdateEnvironment action.

description
string | undefined

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

environmentActions
ConfigurableEnvironmentAction[] | undefined

The environment actions to be updated as part of the UpdateEnvironment action.

environmentBlueprintId
string | undefined

The blueprint identifier of the environment.

environmentConfigurationId
string | undefined

The configuration ID of the environment.

environmentProfileId
string | undefined

The profile identifier of the environment.

glossaryTerms
string[] | undefined

The glossary terms to be updated as part of the UpdateEnvironment action.

id
string | undefined

The identifier of the environment that is to be updated.

lastDeployment
Deployment | undefined

The last deployment of the environment.

provisionedResources
Resource[] | undefined

The provisioned resources to be updated as part of the UpdateEnvironment action.

provisioningProperties
ProvisioningProperties | undefined

The provisioning properties to be updated as part of the UpdateEnvironment action.

status
EnvironmentStatus | undefined

The status to be updated as part of the UpdateEnvironment action.

updatedAt
Date | undefined

The timestamp of when the environment was updated.

userParameters
CustomParameter[] | undefined

The user parameters to be updated as part of the UpdateEnvironment 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.

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.