Skip to content

UpdateEnvironmentInput

Source code in docs_src/capo_datazone/types/update_environment_input.py
class UpdateEnvironmentInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the domain in which the environment is to be updated.</p>"""
    identifier: "capo_datazone.types.environment_id.EnvironmentId"
    """<p>The identifier of the environment that is to be updated.</p>"""
    name: NotRequired["str"]
    """<p>The name to be updated as part of the <code>UpdateEnvironment</code> action.</p>"""
    description: NotRequired["str"]
    """<p>The description to be updated as part of the <code>UpdateEnvironment</code> action.</p>"""
    glossary_terms: NotRequired["capo_datazone.types.glossary_terms.GlossaryTerms"]
    """<p>The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.</p>"""
    blueprint_version: NotRequired["str"]
    """<p>The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: <code>latest</code>.</p>"""
    user_parameters: NotRequired[
        "capo_datazone.types.environment_parameters_list.EnvironmentParametersList"
    ]
    """<p>The user parameters of the environment.</p>"""
    environment_configuration_name: NotRequired[
        "capo_datazone.types.environment_configuration_name.EnvironmentConfigurationName"
    ]
    """<p>The configuration name of the environment.</p>"""

blueprint_version instance-attribute

blueprint_version: NotRequired[str]

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

description instance-attribute

description: NotRequired[str]

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

domain_identifier instance-attribute

domain_identifier: DomainId

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

environment_configuration_name instance-attribute

environment_configuration_name: NotRequired[EnvironmentConfigurationName]

The configuration name of the environment.

glossary_terms instance-attribute

glossary_terms: NotRequired[GlossaryTerms]

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

identifier instance-attribute

identifier: EnvironmentId

The identifier of the environment that is to be updated.

name instance-attribute

name: NotRequired[str]

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

user_parameters instance-attribute

user_parameters: NotRequired[EnvironmentParametersList]

The user parameters of the environment.