get_hook_result¶
Operation¶
async
¶
get_hook_result(input: GetHookResultInput, plugins: list[Plugin] | None = None) -> GetHookResultOutput
Retrieves detailed information and remediation guidance for a Hook invocation result.
If the Hook uses a KMS key to encrypt annotations, callers of the
GetHookResult operation must have kms:Decrypt permissions. For more
information, see KMS key policy and permissions for encrypting
CloudFormation Hooks results at
rest
in the CloudFormation Hooks User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetHookResultInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetHookResultOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetHookResultInput structure.
Attributes¶
class-attribute
instance-attribute
¶
hook_result_id: str | None = ...
The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the ListHookResults operation.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetHookResultOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
annotations: list[Annotation] | None = ...
A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.
class-attribute
instance-attribute
¶
failure_mode: str | None = ...
The failure mode of the invocation.
class-attribute
instance-attribute
¶
hook_result_id: str | None = ...
The unique identifier of the Hook result.
class-attribute
instance-attribute
¶
hook_status_reason: str | None = ...
A message that provides additional details about the Hook invocation status.
class-attribute
instance-attribute
¶
invocation_point: str | None = ...
The specific point in the provisioning process where the Hook is invoked.
class-attribute
instance-attribute
¶
invoked_at: datetime | None = ...
The timestamp when the Hook was invoked.
class-attribute
instance-attribute
¶
original_type_name: str | None = ...
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.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
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.
class-attribute
instance-attribute
¶
Information about the target of the Hook invocation.
class-attribute
instance-attribute
¶
type_arn: str | None = ...
The Amazon Resource Name (ARN) of the Hook.
class-attribute
instance-attribute
¶
type_configuration_version_id: str | None = ...
The version identifier of the Hook configuration data that was used during invocation.