Skip to content

WorkspaceConfigurationDescription

Source code in docs_src/capo_amp/types/workspace_configuration_description.py
class WorkspaceConfigurationDescription(TypedDict, closed=True):
    status: "capo_amp.types.workspace_configuration_status.WorkspaceConfigurationStatus"
    """<p>This structure displays the current status of the workspace configuration, and might also contain a reason for that status.</p>"""
    limits_per_label_set: NotRequired[
        "capo_amp.types.limits_per_label_set_list.LimitsPerLabelSetList"
    ]
    """<p>This is an array of structures, where each structure displays one label sets for the workspace and the limits for that label set.</p>"""
    retention_period_in_days: NotRequired["int"]
    """<p>This field displays how many days that metrics are retained in the workspace.</p>"""
    out_of_order_time_window_in_seconds: NotRequired["int"]
    """<p>This field displays the out of order time window in seconds for accepting out of order samples.</p>"""
    rule_query_offset_in_seconds: NotRequired["int"]
    """<p>This field displays the duration in seconds that rule evaluation queries are offset into the past.</p>"""

limits_per_label_set instance-attribute

limits_per_label_set: NotRequired[LimitsPerLabelSetList]

This is an array of structures, where each structure displays one label sets for the workspace and the limits for that label set.

out_of_order_time_window_in_seconds instance-attribute

out_of_order_time_window_in_seconds: NotRequired[int]

This field displays the out of order time window in seconds for accepting out of order samples.

retention_period_in_days instance-attribute

retention_period_in_days: NotRequired[int]

This field displays how many days that metrics are retained in the workspace.

rule_query_offset_in_seconds instance-attribute

rule_query_offset_in_seconds: NotRequired[int]

This field displays the duration in seconds that rule evaluation queries are offset into the past.

status instance-attribute

This structure displays the current status of the workspace configuration, and might also contain a reason for that status.