Skip to content

HookResultSummary

Source code in docs_src/capo_cloudformation/types/hook_result_summary.py
class HookResultSummary(TypedDict, closed=True):
    hook_result_id: NotRequired[
        "capo_cloudformation.types.hook_invocation_id.HookInvocationId"
    ]
    """<p>The unique identifier for this Hook invocation result.</p>"""
    invocation_point: NotRequired[
        "capo_cloudformation.types.hook_invocation_point.HookInvocationPoint"
    ]
    """<p>The specific point in the provisioning process where the Hook is invoked.</p>"""
    failure_mode: NotRequired[
        "capo_cloudformation.types.hook_failure_mode.HookFailureMode"
    ]
    """<p>The failure mode of the invocation.</p>"""
    type_name: NotRequired["capo_cloudformation.types.hook_type_name.HookTypeName"]
    """<p>The name of the Hook that was invoked.</p>"""
    type_version_id: NotRequired[
        "capo_cloudformation.types.hook_type_version_id.HookTypeVersionId"
    ]
    """<p>The version of the Hook that was invoked.</p>"""
    type_configuration_version_id: NotRequired[
        "capo_cloudformation.types.hook_type_configuration_version_id.HookTypeConfigurationVersionId"
    ]
    """<p>The version of the Hook configuration.</p>"""
    status: NotRequired["capo_cloudformation.types.hook_status.HookStatus"]
    """<p>The status of the Hook invocation. The following statuses are possible:</p> <ul> <li> <p> <code>HOOK_IN_PROGRESS</code>: The Hook is currently running.</p> </li> <li> <p> <code>HOOK_COMPLETE_SUCCEEDED</code>: The Hook completed successfully.</p> </li> <li> <p> <code>HOOK_COMPLETE_FAILED</code>: The Hook completed but failed validation.</p> </li> <li> <p> <code>HOOK_FAILED</code>: The Hook encountered an error during execution.</p> </li> </ul>"""
    hook_status_reason: NotRequired[
        "capo_cloudformation.types.hook_status_reason.HookStatusReason"
    ]
    """<p>A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.</p>"""
    invoked_at: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>The timestamp when the Hook was invoked.</p> <p>Only shown in responses when the request does not specify <code>TargetType</code> and <code>TargetId</code> filters.</p>"""
    target_type: NotRequired[
        "capo_cloudformation.types.list_hook_results_target_type.ListHookResultsTargetType"
    ]
    """<p>The target type that the Hook was invoked against.</p>"""
    target_id: NotRequired["capo_cloudformation.types.hook_result_id.HookResultId"]
    """<p>The unique identifier of the Hook invocation target.</p>"""
    type_arn: NotRequired["capo_cloudformation.types.hook_type_arn.HookTypeArn"]
    """<p>The ARN of the Hook that was invoked.</p>"""
    hook_execution_target: NotRequired[
        "capo_cloudformation.types.hook_result_id.HookResultId"
    ]
    """<p>The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.</p> <p>Only shown in responses when the request does not specify <code>TargetType</code> and <code>TargetId</code> filters.</p>"""

failure_mode instance-attribute

failure_mode: NotRequired[HookFailureMode]

The failure mode of the invocation.

hook_execution_target instance-attribute

hook_execution_target: NotRequired[HookResultId]

The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.

Only shown in responses when the request does not specify TargetType and TargetId filters.

hook_result_id instance-attribute

hook_result_id: NotRequired[HookInvocationId]

The unique identifier for this Hook invocation result.

hook_status_reason instance-attribute

hook_status_reason: NotRequired[HookStatusReason]

A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.

invocation_point instance-attribute

invocation_point: NotRequired[HookInvocationPoint]

The specific point in the provisioning process where the Hook is invoked.

invoked_at instance-attribute

invoked_at: NotRequired[Timestamp]

The timestamp when the Hook was invoked.

Only shown in responses when the request does not specify TargetType and TargetId filters.

status instance-attribute

status: NotRequired[HookStatus]

The status of the Hook invocation. The following statuses are possible:

  • HOOK_IN_PROGRESS: The Hook is currently running.

  • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

  • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

  • HOOK_FAILED: The Hook encountered an error during execution.

target_id instance-attribute

target_id: NotRequired[HookResultId]

The unique identifier of the Hook invocation target.

target_type instance-attribute

target_type: NotRequired[ListHookResultsTargetType]

The target type that the Hook was invoked against.

type_arn instance-attribute

type_arn: NotRequired[HookTypeArn]

The ARN of the Hook that was invoked.

type_configuration_version_id instance-attribute

type_configuration_version_id: NotRequired[HookTypeConfigurationVersionId]

The version of the Hook configuration.

type_name instance-attribute

type_name: NotRequired[HookTypeName]

The name of the Hook that was invoked.

type_version_id instance-attribute

type_version_id: NotRequired[HookTypeVersionId]

The version of the Hook that was invoked.