Skip to content

CloudFormation  >  Structures  >  HookResultSummary

HookResultSummary

Structure Class

HookResultSummary dataclass

Bases: _SerdeShape

A ListHookResults call returns a summary of a Hook invocation.

Attributes

failure_mode class-attribute instance-attribute 
failure_mode: str | None = ...

The failure mode of the invocation.

hook_execution_target class-attribute instance-attribute 
hook_execution_target: str | None = ...

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 class-attribute instance-attribute 
hook_result_id: str | None = ...

The unique identifier for this Hook invocation result.

hook_status_reason class-attribute instance-attribute 
hook_status_reason: str | None = ...

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 class-attribute instance-attribute 
invocation_point: str | None = ...

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

invoked_at class-attribute instance-attribute 
invoked_at: datetime | None = ...

The timestamp when the Hook was invoked.

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

status class-attribute instance-attribute 
status: str | None = ...

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 class-attribute instance-attribute 
target_id: str | None = ...

The unique identifier of the Hook invocation target.

target_type class-attribute instance-attribute 
target_type: str | None = ...

The target type that the Hook was invoked against.

type_arn class-attribute instance-attribute 
type_arn: str | None = ...

The ARN of the Hook that was invoked.

type_configuration_version_id class-attribute instance-attribute 
type_configuration_version_id: str | None = ...

The version of the Hook configuration.

type_name class-attribute instance-attribute 
type_name: str | None = ...

The name of the Hook that was invoked.

type_version_id class-attribute instance-attribute 
type_version_id: str | None = ...

The version of the Hook that was invoked.