Skip to content

WatchlistSummary

Source code in docs_src/capo_voice_id/types/watchlist_summary.py
class WatchlistSummary(TypedDict, closed=True):
    domain_id: NotRequired["capo_voice_id.types.domain_id.DomainId"]
    """<p>The identifier of the domain that contains the watchlist.</p>"""
    watchlist_id: NotRequired["capo_voice_id.types.watchlist_id.WatchlistId"]
    """<p>The identifier of the watchlist.</p>"""
    name: NotRequired["capo_voice_id.types.watchlist_name.WatchlistName"]
    """<p>The name for the watchlist.</p>"""
    description: NotRequired[
        "capo_voice_id.types.watchlist_description.WatchlistDescription"
    ]
    """<p>The description of the watchlist.</p>"""
    default_watchlist: "capo_voice_id.types.boolean.Boolean"
    """<p>Whether the specified watchlist is the default watchlist of a domain.</p>"""
    created_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>The timestamp of when the watchlist was created.</p>"""
    updated_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>The timestamp of when the watchlist was last updated.</p>"""

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp of when the watchlist was created.

default_watchlist instance-attribute

default_watchlist: Boolean

Whether the specified watchlist is the default watchlist of a domain.

description instance-attribute

description: NotRequired[WatchlistDescription]

The description of the watchlist.

domain_id instance-attribute

domain_id: NotRequired[DomainId]

The identifier of the domain that contains the watchlist.

name instance-attribute

name: NotRequired[WatchlistName]

The name for the watchlist.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp of when the watchlist was last updated.

watchlist_id instance-attribute

watchlist_id: NotRequired[WatchlistId]

The identifier of the watchlist.