Skip to content

UpdateGlossaryTermOutput

Source code in docs_src/capo_datazone/types/update_glossary_term_output.py
class UpdateGlossaryTermOutput(TypedDict, closed=True):
    id: "capo_datazone.types.glossary_term_id.GlossaryTermId"
    """<p>The identifier of the business glossary term that is to be updated.</p>"""
    domain_id: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.</p>"""
    glossary_id: "capo_datazone.types.glossary_id.GlossaryId"
    """<p>The identifier of the business glossary in which a term is to be updated.</p>"""
    name: "capo_datazone.types.glossary_term_name.GlossaryTermName"
    """<p>The name to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>"""
    status: "capo_datazone.types.glossary_term_status.GlossaryTermStatus"
    """<p>The status to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>"""
    short_description: NotRequired[
        "capo_datazone.types.short_description.ShortDescription"
    ]
    """<p>The short description to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>"""
    long_description: NotRequired[
        "capo_datazone.types.long_description.LongDescription"
    ]
    """<p>The long description to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>"""
    term_relations: NotRequired["capo_datazone.types.term_relations.TermRelations"]
    """<p>The term relations to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>"""
    usage_restrictions: NotRequired[
        "capo_datazone.types.glossary_usage_restrictions.GlossaryUsageRestrictions"
    ]
    """<p>The usage restriction of a term within a restricted glossary.</p>"""

domain_id instance-attribute

domain_id: DomainId

The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

glossary_id instance-attribute

glossary_id: GlossaryId

The identifier of the business glossary in which a term is to be updated.

id instance-attribute

The identifier of the business glossary term that is to be updated.

long_description instance-attribute

long_description: NotRequired[LongDescription]

The long description to be updated as part of the UpdateGlossaryTerm action.

name instance-attribute

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

short_description instance-attribute

short_description: NotRequired[ShortDescription]

The short description to be updated as part of the UpdateGlossaryTerm action.

status instance-attribute

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

term_relations instance-attribute

term_relations: NotRequired[TermRelations]

The term relations to be updated as part of the UpdateGlossaryTerm action.

usage_restrictions instance-attribute

usage_restrictions: NotRequired[GlossaryUsageRestrictions]

The usage restriction of a term within a restricted glossary.