Skip to content

OperationEvent

Source code in docs_src/capo_cloudformation/types/operation_event.py
class OperationEvent(TypedDict, closed=True):
    event_id: NotRequired["capo_cloudformation.types.event_id.EventId"]
    """<p>A unique identifier for this event.</p>"""
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The unique ID name of the instance of the stack.</p>"""
    operation_id: NotRequired["capo_cloudformation.types.operation_id.OperationId"]
    """<p>The unique identifier of the operation this event belongs to.</p>"""
    operation_type: NotRequired[
        "capo_cloudformation.types.operation_type.OperationType"
    ]
    """<p>The type of operation.</p>"""
    operation_status: NotRequired[
        "capo_cloudformation.types.beacon_stack_operation_status.BeaconStackOperationStatus"
    ]
    """<p>The current status of the operation.</p>"""
    event_type: NotRequired["capo_cloudformation.types.event_type.EventType"]
    """<p>The type of event.</p>"""
    logical_resource_id: NotRequired[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ]
    """<p>The logical name of the resource as specified in the template.</p>"""
    physical_resource_id: NotRequired[
        "capo_cloudformation.types.physical_resource_id.PhysicalResourceId"
    ]
    """<p>The name or unique identifier that corresponds to a physical instance ID of a resource.</p>"""
    resource_type: NotRequired["capo_cloudformation.types.resource_type.ResourceType"]
    """<p>Type of resource.</p>"""
    timestamp: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>Time the status was updated.</p>"""
    start_time: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>The time when the event started.</p>"""
    end_time: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>The time when the event ended.</p>"""
    resource_status: NotRequired[
        "capo_cloudformation.types.resource_status.ResourceStatus"
    ]
    """<p>Current status of the resource.</p>"""
    resource_status_reason: NotRequired[
        "capo_cloudformation.types.resource_status_reason.ResourceStatusReason"
    ]
    """<p>Success or failure message associated with the resource.</p>"""
    resource_properties: NotRequired[
        "capo_cloudformation.types.resource_properties.ResourceProperties"
    ]
    """<p>The properties used to create the resource.</p>"""
    client_request_token: NotRequired[
        "capo_cloudformation.types.client_request_token.ClientRequestToken"
    ]
    """<p>A unique identifier for the request that initiated this operation.</p>"""
    hook_type: NotRequired["capo_cloudformation.types.hook_type.HookType"]
    """<p>The type name of the Hook that was invoked.</p>"""
    hook_status: NotRequired["capo_cloudformation.types.hook_status.HookStatus"]
    """<p>The status of the Hook invocation. </p>"""
    hook_status_reason: NotRequired[
        "capo_cloudformation.types.hook_status_reason.HookStatusReason"
    ]
    """<p>Additional information about the Hook status.</p>"""
    hook_invocation_point: NotRequired[
        "capo_cloudformation.types.hook_invocation_point.HookInvocationPoint"
    ]
    """<p>The point in the operation lifecycle when the Hook was invoked.</p>"""
    hook_failure_mode: NotRequired[
        "capo_cloudformation.types.hook_failure_mode.HookFailureMode"
    ]
    """<p>Specifies how Hook failures are handled.</p>"""
    detailed_status: NotRequired[
        "capo_cloudformation.types.detailed_status.DetailedStatus"
    ]
    """<p>Additional status information about the operation.</p>"""
    validation_failure_mode: NotRequired[
        "capo_cloudformation.types.hook_failure_mode.HookFailureMode"
    ]
    """<p>Specifies how validation failures are handled.</p>"""
    validation_name: NotRequired[
        "capo_cloudformation.types.validation_name.ValidationName"
    ]
    """<p>The name of the validation that was performed.</p>"""
    validation_status: NotRequired[
        "capo_cloudformation.types.validation_status.ValidationStatus"
    ]
    """<p>The status of the validation.</p>"""
    validation_status_reason: NotRequired[
        "capo_cloudformation.types.validation_status_reason.ValidationStatusReason"
    ]
    """<p>Additional information about the validation status.</p>"""
    validation_path: NotRequired[
        "capo_cloudformation.types.validation_path.ValidationPath"
    ]
    """<p>The path within the resource where the validation was applied.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

A unique identifier for the request that initiated this operation.

detailed_status instance-attribute

detailed_status: NotRequired[DetailedStatus]

Additional status information about the operation.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time when the event ended.

event_id instance-attribute

event_id: NotRequired[EventId]

A unique identifier for this event.

event_type instance-attribute

event_type: NotRequired[EventType]

The type of event.

hook_failure_mode instance-attribute

hook_failure_mode: NotRequired[HookFailureMode]

Specifies how Hook failures are handled.

hook_invocation_point instance-attribute

hook_invocation_point: NotRequired[HookInvocationPoint]

The point in the operation lifecycle when the Hook was invoked.

hook_status instance-attribute

hook_status: NotRequired[HookStatus]

The status of the Hook invocation.

hook_status_reason instance-attribute

hook_status_reason: NotRequired[HookStatusReason]

Additional information about the Hook status.

hook_type instance-attribute

hook_type: NotRequired[HookType]

The type name of the Hook that was invoked.

logical_resource_id instance-attribute

logical_resource_id: NotRequired[LogicalResourceId]

The logical name of the resource as specified in the template.

operation_id instance-attribute

operation_id: NotRequired[OperationId]

The unique identifier of the operation this event belongs to.

operation_status instance-attribute

operation_status: NotRequired[BeaconStackOperationStatus]

The current status of the operation.

operation_type instance-attribute

operation_type: NotRequired[OperationType]

The type of operation.

physical_resource_id instance-attribute

physical_resource_id: NotRequired[PhysicalResourceId]

The name or unique identifier that corresponds to a physical instance ID of a resource.

resource_properties instance-attribute

resource_properties: NotRequired[ResourceProperties]

The properties used to create the resource.

resource_status instance-attribute

resource_status: NotRequired[ResourceStatus]

Current status of the resource.

resource_status_reason instance-attribute

resource_status_reason: NotRequired[ResourceStatusReason]

Success or failure message associated with the resource.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

Type of resource.

stack_id instance-attribute

stack_id: NotRequired[StackId]

The unique ID name of the instance of the stack.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The time when the event started.

timestamp instance-attribute

timestamp: NotRequired[Timestamp]

Time the status was updated.

validation_failure_mode instance-attribute

validation_failure_mode: NotRequired[HookFailureMode]

Specifies how validation failures are handled.

validation_name instance-attribute

validation_name: NotRequired[ValidationName]

The name of the validation that was performed.

validation_path instance-attribute

validation_path: NotRequired[ValidationPath]

The path within the resource where the validation was applied.

validation_status instance-attribute

validation_status: NotRequired[ValidationStatus]

The status of the validation.

validation_status_reason instance-attribute

validation_status_reason: NotRequired[ValidationStatusReason]

Additional information about the validation status.