GetEnvironmentCommand

Gets an Amazon DataZone environment.

Example Syntax

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

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

GetEnvironmentCommand Input

See GetEnvironmentCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain where the environment exists.

identifier
Required
string | undefined

The ID of the Amazon DataZone environment.

GetEnvironmentCommand Output

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 ID of the Amazon DataZone domain where the environment exists.

name
Required
string | undefined

The name of the environment.

projectId
Required
string | undefined

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

provider
Required
string | undefined

The provider of this Amazon DataZone environment.

awsAccountId
string | undefined

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

awsAccountRegion
string | undefined

The Amazon Web Services region where the environment exists.

createdAt
Date | undefined

The timestamp of when the environment was created.

deploymentProperties
DeploymentProperties | undefined

The deployment properties of the environment.

description
string | undefined

The description of the environment.

environmentActions
ConfigurableEnvironmentAction[] | undefined

The actions of the environment.

environmentBlueprintId
string | undefined

The blueprint with which the environment is created.

environmentConfigurationId
string | undefined

The configuration ID that is used to create the environment.

environmentProfileId
string | undefined

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

glossaryTerms
string[] | undefined

The business glossary terms that can be used in this environment.

id
string | undefined

The ID of the environment.

lastDeployment
Deployment | undefined

The details of the last deployment of the environment.

provisionedResources
Resource[] | undefined

The provisioned resources of this Amazon DataZone environment.

provisioningProperties
ProvisioningProperties | undefined

The provisioning properties of this Amazon DataZone environment.

status
EnvironmentStatus | undefined

The status of this Amazon DataZone environment.

updatedAt
Date | undefined

The timestamp of when this environment was updated.

userParameters
CustomParameter[] | undefined

The user parameters of this Amazon DataZone environment.

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.