Skip to content

BaselineOperation

Source code in docs_src/capo_controltower/types/baseline_operation.py
class BaselineOperation(TypedDict, closed=True):
    operation_identifier: NotRequired[
        "capo_controltower.types.operation_identifier.OperationIdentifier"
    ]
    """<p>The identifier of the specified operation.</p>"""
    operation_type: NotRequired[
        "capo_controltower.types.baseline_operation_type.BaselineOperationType"
    ]
    """<p>An enumerated type (<code>enum</code>) with possible values of <code>ENABLE_BASELINE</code>, <code>DISABLE_BASELINE</code>, <code>UPDATE_ENABLED_BASELINE</code>, or <code>RESET_ENABLED_BASELINE</code>.</p>"""
    status: NotRequired[
        "capo_controltower.types.baseline_operation_status.BaselineOperationStatus"
    ]
    """<p>An enumerated type (<code>enum</code>) with possible values of <code>SUCCEEDED</code>, <code>FAILED</code>, or <code>IN_PROGRESS</code>.</p>"""
    start_time: NotRequired["capo_controltower.types.timestamp.Timestamp"]
    """<p>The start time of the operation, in ISO 8601 format.</p>"""
    end_time: NotRequired["capo_controltower.types.timestamp.Timestamp"]
    """<p>The end time of the operation (if applicable), in ISO 8601 format.</p>"""
    status_message: NotRequired["str"]
    """<p>A status message that gives more information about the operation's status, if applicable.</p>"""

end_time instance-attribute

end_time: NotRequired[Timestamp]

The end time of the operation (if applicable), in ISO 8601 format.

operation_identifier instance-attribute

operation_identifier: NotRequired[OperationIdentifier]

The identifier of the specified operation.

operation_type instance-attribute

operation_type: NotRequired[BaselineOperationType]

An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The start time of the operation, in ISO 8601 format.

status instance-attribute

status: NotRequired[BaselineOperationStatus]

An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.

status_message instance-attribute

status_message: NotRequired[str]

A status message that gives more information about the operation's status, if applicable.