get_environment_blueprint
Retrieve metadata and definition of an environment blueprint in Amazon DataZone, including deployment properties, provisioning configuration, and user parameters.
Instructions
Retrieves metadata and definition of an environment blueprint.
related tools:
get_environment_blueprint_configuration: Retrieves the configuration schema and parameters that must be provided when provisioning an environment from a given blueprint.
Args: domain_identifier (str): The ID of the domain in which this blueprint 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 the Amazon DataZone blueprint metadata:
- createdAt (str): Timestamp indicating when the blueprint was created.
- deploymentProperties (dict): Deployment-related configuration, including:
- endTimeoutMinutes (int): Timeout in minutes for ending deployment.
- startTimeoutMinutes (int): Timeout in minutes for starting deployment.
- description (str): A description of the blueprint.
- Constraints: 0–2048 characters.
- glossaryTerms (list of str): Glossary terms associated with the blueprint.
- Constraints: 1–20 items.
- Pattern: ^[a-zA-Z0-9_-]{1,36}$
- id (str): Unique ID of the blueprint.
- Pattern: ^[a-zA-Z0-9_-]{1,36}$
- name (str): Name of the blueprint.
- Constraints: 1–64 characters.
- Pattern: r"^[\w -]+$"
- provider (str): The provider of the blueprint.
- provisioningProperties (dict): Provisioning configuration for the blueprint.
- Note: This is a union object—only one configuration type may be present.
- updatedAt (str): Timestamp indicating when the blueprint was last updated.
- userParameters (list of dict): Custom parameters defined by the user, each including:
- defaultValue (str): Default value for the parameter.
- description (str): Description of the parameter.
- fieldType (str): Type of input field (e.g., string, boolean).
- isEditable (bool): Whether the parameter is user-editable.
- isOptional (bool): Whether the parameter is optional.
- keyName (str): Key name for the parameter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| domain_identifier | Yes |