get_environment
Retrieve details of an Amazon DataZone environment by specifying the domain ID and environment ID.
Instructions
Gets an Amazon DataZone environment.
Args: domain_identifier (str): The ID of the domain where the environment exists. Pattern: ^dzd[-][a-zA-Z0-9-]{1,36}$ identifier (str): The ID of the environment to retrieve. Length Constraints: Minimum length of 0. Maximum length of 128.
Returns: Any: The API response containing: - awsAccountId (str): The AWS account ID associated with the environment. - awsAccountRegion (str): The AWS region where the environment is located. - createdAt (str): Timestamp when the environment was created. - createdBy (str): The identifier of the user who created the environment. - deploymentProperties (dict): Properties related to deployment, including: - endTimeoutMinutes (int): Timeout in minutes for ending the deployment. - startTimeoutMinutes (int): Timeout in minutes for starting the deployment. - description (str): Description of the environment. - domainId (str): The domain ID associated with the environment. - environmentActions (list): A list of actions for the environment, each containing: - auth (str): Authorization type for the action. - parameters (list): Parameters for the action, each including: - key (str): Parameter key. - value (str): Parameter value. - type (str): The type of environment action. - environmentBlueprintId (str): ID of the blueprint used for the environment. - environmentConfigurationId (str): ID of the environment configuration. - environmentProfileId (str): ID of the environment profile. - glossaryTerms (list): List of glossary term strings associated with the environment. - id (str): The unique ID of the environment. - lastDeployment (dict): Information about the last deployment, including: - deploymentId (str): ID of the last deployment. - deploymentStatus (str): Status of the deployment. - deploymentType (str): Type of deployment. - failureReason (dict): Details of any failure, including: - code (str): Error code for the failure. - message (str): Human-readable error message. - isDeploymentComplete (bool): Whether the deployment is complete. - messages (list): List of messages related to the deployment. - name (str): Name of the environment. - projectId (str): The project ID associated with the environment. - provider (str): Provider responsible for provisioning the environment. - provisionedResources (list): List of provisioned resources, each including: - name (str): Name of the resource. - provider (str): Resource provider. - type (str): Type of the resource. - value (str): Value associated with the resource. - provisioningProperties (dict): Additional properties used during provisioning. - status (str): Current status of the environment. - updatedAt (str): Timestamp when the environment was last updated. - userParameters (list): Parameters provided by the user, each including: - defaultValue (str): Default value of the parameter. - description (str): Description of the parameter. - fieldType (str): Type of input field. - isEditable (bool): Whether the parameter is editable. - isOptional (bool): Whether the parameter is optional. - keyName (str): Key name for the parameter.
Example: >>> get_environment( ... domain_identifier="dzd_4p9n6sw4qt9xgn", identifier="conn_123456789" ... )
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| domain_identifier | Yes |