Skip to content

GetHookResultOutput

Source code in docs_src/capo_cloudformation/types/get_hook_result_output.py
class GetHookResultOutput(TypedDict, closed=True):
    hook_result_id: NotRequired[
        "capo_cloudformation.types.hook_invocation_id.HookInvocationId"
    ]
    """<p>The unique identifier of the Hook 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>"""
    original_type_name: NotRequired[
        "capo_cloudformation.types.hook_type_name.HookTypeName"
    ]
    """<p>The original public type name of the Hook when an alias is used.</p> <p>For example, if you activate <code>AWS::Hooks::GuardHook</code> with alias <code>MyCompany::Custom::GuardHook</code>, then <code>TypeName</code> will be <code>MyCompany::Custom::GuardHook</code> and <code>OriginalTypeName</code> will be <code>AWS::Hooks::GuardHook</code>. </p>"""
    type_version_id: NotRequired[
        "capo_cloudformation.types.hook_type_version_id.HookTypeVersionId"
    ]
    """<p>The version identifier of the Hook that was invoked.</p>"""
    type_configuration_version_id: NotRequired[
        "capo_cloudformation.types.hook_type_configuration_version_id.HookTypeConfigurationVersionId"
    ]
    """<p>The version identifier of the Hook configuration data that was used during invocation.</p>"""
    type_arn: NotRequired["capo_cloudformation.types.hook_type_arn.HookTypeArn"]
    """<p>The Amazon Resource Name (ARN) of the Hook.</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 message that provides additional details about the Hook invocation status.</p>"""
    invoked_at: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>The timestamp when the Hook was invoked.</p>"""
    target: NotRequired["capo_cloudformation.types.hook_target.HookTarget"]
    """<p>Information about the target of the Hook invocation.</p>"""
    annotations: NotRequired["capo_cloudformation.types.annotation_list.AnnotationList"]
    """<p>A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.</p>"""

annotations instance-attribute

annotations: NotRequired[AnnotationList]

A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

failure_mode instance-attribute

failure_mode: NotRequired[HookFailureMode]

The failure mode of the invocation.

hook_result_id instance-attribute

hook_result_id: NotRequired[HookInvocationId]

The unique identifier of the Hook result.

hook_status_reason instance-attribute

hook_status_reason: NotRequired[HookStatusReason]

A message that provides additional details about the Hook invocation status.

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.

original_type_name instance-attribute

original_type_name: NotRequired[HookTypeName]

The original public type name of the Hook when an alias is used.

For example, if you activate AWS::Hooks::GuardHook with alias MyCompany::Custom::GuardHook, then TypeName will be MyCompany::Custom::GuardHook and OriginalTypeName will be AWS::Hooks::GuardHook.

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 instance-attribute

target: NotRequired[HookTarget]

Information about the target of the Hook invocation.

type_arn instance-attribute

type_arn: NotRequired[HookTypeArn]

The Amazon Resource Name (ARN) of the Hook.

type_configuration_version_id instance-attribute

type_configuration_version_id: NotRequired[HookTypeConfigurationVersionId]

The version identifier of the Hook configuration data that was used during invocation.

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 identifier of the Hook that was invoked.