Skip to content

AssociateGlossaryTermsRequest

Source code in docs_src/capo_glue/types/associate_glossary_terms_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class AssociateGlossaryTermsRequest(TypedDict, closed=True):
    asset_identifier: "capo_glue.types.asset_id.AssetId"
    """<p>The unique identifier of the asset to associate glossary terms with.</p>"""
    iterable_form_name: NotRequired[
        "capo_glue.types.iterable_form_name.IterableFormName"
    ]
    """<p>The name of the iterable form. When specified along with <code>itemIdentifier</code>, the glossary terms are associated with an item within the iterable form rather than the asset itself.</p>"""
    item_identifier: NotRequired["capo_glue.types.item_identifier.ItemIdentifier"]
    """<p>The identifier of the item within the iterable form. Required when <code>iterableFormName</code> is specified.</p>"""
    glossary_term_identifiers: (
        "capo_glue.types.glossary_term_id_list.GlossaryTermIdList"
    )
    """<p>The list of glossary term identifiers to associate with the asset.</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>"""

asset_identifier instance-attribute 

asset_identifier: AssetId

The unique identifier of the asset to associate glossary terms with.

client_token instance-attribute 

client_token: NotRequired[HashString]

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

glossary_term_identifiers instance-attribute 

glossary_term_identifiers: GlossaryTermIdList

The list of glossary term identifiers to associate with the asset.

item_identifier instance-attribute 

item_identifier: NotRequired[ItemIdentifier]

The identifier of the item within the iterable form. Required when iterableFormName is specified.

iterable_form_name instance-attribute 

iterable_form_name: NotRequired[IterableFormName]

The name of the iterable form. When specified along with itemIdentifier, the glossary terms are associated with an item within the iterable form rather than the asset itself.