Skip to content

CreateGlossaryTermRequest

Source code in docs_src/capo_glue/types/create_glossary_term_request.py
class CreateGlossaryTermRequest(TypedDict, closed=True):
    glossary_identifier: "capo_glue.types.glossary_id.GlossaryId"
    """<p>The unique identifier of the glossary in which to create the term.</p>"""
    name: "capo_glue.types.glossary_term_name.GlossaryTermName"
    """<p>The name of the glossary term.</p>"""
    short_description: NotRequired[
        "capo_glue.types.glossary_short_description.GlossaryShortDescription"
    ]
    """<p>A short description of the glossary term.</p>"""
    long_description: NotRequired[
        "capo_glue.types.glossary_long_description.GlossaryLongDescription"
    ]
    """<p>A long description of the glossary term.</p>"""
    client_token: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""

client_token instance-attribute

client_token: NotRequired[HashString]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

glossary_identifier instance-attribute

glossary_identifier: GlossaryId

The unique identifier of the glossary in which to create the term.

long_description instance-attribute

long_description: NotRequired[GlossaryLongDescription]

A long description of the glossary term.

name instance-attribute

The name of the glossary term.

short_description instance-attribute

short_description: NotRequired[GlossaryShortDescription]

A short description of the glossary term.