Skip to content

ControlOperation

Source code in docs_src/capo_controltower/types/control_operation.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class ControlOperation(TypedDict, closed=True):
    operation_type: NotRequired[
        "capo_controltower.types.control_operation_type.ControlOperationType"
    ]
    """<p>One of <code>ENABLE_CONTROL</code> or <code>DISABLE_CONTROL</code>.</p>"""
    start_time: NotRequired["capo_controltower.types.timestamp.Timestamp"]
    """<p>The time that the operation began.</p>"""
    end_time: NotRequired["capo_controltower.types.timestamp.Timestamp"]
    """<p>The time that the operation finished.</p>"""
    status: NotRequired[
        "capo_controltower.types.control_operation_status.ControlOperationStatus"
    ]
    """<p>One of <code>IN_PROGRESS</code>, <code>SUCEEDED</code>, or <code>FAILED</code>.</p>"""
    status_message: NotRequired["str"]
    """<p>If the operation result is <code>FAILED</code>, this string contains a message explaining why the operation failed.</p>"""
    operation_identifier: NotRequired[
        "capo_controltower.types.operation_identifier.OperationIdentifier"
    ]
    """<p>The identifier of the specified operation.</p>"""
    control_identifier: NotRequired[
        "capo_controltower.types.control_identifier.ControlIdentifier"
    ]
    """<p>The <code>controlIdentifier</code> of the control for the operation.</p>"""
    target_identifier: NotRequired[
        "capo_controltower.types.target_identifier.TargetIdentifier"
    ]
    """<p>The target upon which the control operation is working.</p>"""
    enabled_control_identifier: NotRequired["capo_controltower.types.arn.Arn"]
    """<p>The <code>controlIdentifier</code> of the enabled control.</p>"""

control_identifier instance-attribute 

control_identifier: NotRequired[ControlIdentifier]

The controlIdentifier of the control for the operation.

enabled_control_identifier instance-attribute 

enabled_control_identifier: NotRequired[Arn]

The controlIdentifier of the enabled control.

end_time instance-attribute 

end_time: NotRequired[Timestamp]

The time that the operation finished.

operation_identifier instance-attribute 

operation_identifier: NotRequired[OperationIdentifier]

The identifier of the specified operation.

operation_type instance-attribute 

operation_type: NotRequired[ControlOperationType]

One of ENABLE_CONTROL or DISABLE_CONTROL.

start_time instance-attribute 

start_time: NotRequired[Timestamp]

The time that the operation began.

status instance-attribute 

status: NotRequired[ControlOperationStatus]

One of IN_PROGRESS, SUCEEDED, or FAILED.

status_message instance-attribute 

status_message: NotRequired[str]

If the operation result is FAILED, this string contains a message explaining why the operation failed.

target_identifier instance-attribute 

target_identifier: NotRequired[TargetIdentifier]

The target upon which the control operation is working.