Skip to content

GetGlossaryTermOutput

Source code in docs_src/capo_datazone/types/get_glossary_term_output.py
class GetGlossaryTermOutput(TypedDict, closed=True):
    domain_id: "capo_datazone.types.domain_id.DomainId"
    """<p>The ID of the Amazon DataZone domain in which this business glossary term exists.</p>"""
    glossary_id: "capo_datazone.types.glossary_id.GlossaryId"
    """<p>The ID of the business glossary to which this term belongs.</p>"""
    id: "capo_datazone.types.glossary_term_id.GlossaryTermId"
    """<p>The ID of the business glossary term.</p>"""
    name: "capo_datazone.types.glossary_term_name.GlossaryTermName"
    """<p>The name of the business glossary term.</p>"""
    short_description: NotRequired[
        "capo_datazone.types.short_description.ShortDescription"
    ]
    """<p>The short decription of the business glossary term.</p>"""
    long_description: NotRequired[
        "capo_datazone.types.long_description.LongDescription"
    ]
    """<p>The long description of the business glossary term.</p>"""
    term_relations: NotRequired["capo_datazone.types.term_relations.TermRelations"]
    """<p>The relations of the business glossary term.</p>"""
    status: "capo_datazone.types.glossary_term_status.GlossaryTermStatus"
    """<p>The status of the business glossary term.</p>"""
    created_at: NotRequired["capo_datazone.types.created_at.CreatedAt"]
    """<p>The timestamp of when the business glossary term was created.</p>"""
    created_by: NotRequired["capo_datazone.types.created_by.CreatedBy"]
    """<p>The Amazon DataZone user who created the business glossary.</p>"""
    updated_at: NotRequired["capo_datazone.types.updated_at.UpdatedAt"]
    """<p>The timestamp of when the business glossary term was updated.</p>"""
    updated_by: NotRequired["capo_datazone.types.updated_by.UpdatedBy"]
    """<p>The Amazon DataZone user who updated the business glossary term.</p>"""
    usage_restrictions: NotRequired[
        "capo_datazone.types.glossary_usage_restrictions.GlossaryUsageRestrictions"
    ]
    """<p>The usage restriction of a term within a restricted glossary.</p>"""

created_at instance-attribute

created_at: NotRequired[CreatedAt]

The timestamp of when the business glossary term was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The Amazon DataZone user who created the business glossary.

domain_id instance-attribute

domain_id: DomainId

The ID of the Amazon DataZone domain in which this business glossary term exists.

glossary_id instance-attribute

glossary_id: GlossaryId

The ID of the business glossary to which this term belongs.

id instance-attribute

The ID of the business glossary term.

long_description instance-attribute

long_description: NotRequired[LongDescription]

The long description of the business glossary term.

name instance-attribute

The name of the business glossary term.

short_description instance-attribute

short_description: NotRequired[ShortDescription]

The short decription of the business glossary term.

status instance-attribute

The status of the business glossary term.

term_relations instance-attribute

term_relations: NotRequired[TermRelations]

The relations of the business glossary term.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The timestamp of when the business glossary term was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The Amazon DataZone user who updated the business glossary term.

usage_restrictions instance-attribute

usage_restrictions: NotRequired[GlossaryUsageRestrictions]

The usage restriction of a term within a restricted glossary.