Retrieves detailed information and remediation guidance for a Hook invocation result¶

Description¶

Retrieves detailed information and remediation guidance for a Hook invocation result.

If the Hook uses a KMS key to encrypt annotations, callers of the get_hook_result 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.

Usage¶

cloudformation_get_hook_result(HookResultId)

Arguments¶

HookResultId

The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the list_hook_results operation.

Value¶

A list with the following syntax:

list(
  HookResultId = "string",
  InvocationPoint = "PRE_PROVISION",
  FailureMode = "FAIL"|"WARN",
  TypeName = "string",
  OriginalTypeName = "string",
  TypeVersionId = "string",
  TypeConfigurationVersionId = "string",
  TypeArn = "string",
  Status = "HOOK_IN_PROGRESS"|"HOOK_COMPLETE_SUCCEEDED"|"HOOK_COMPLETE_FAILED"|"HOOK_FAILED",
  HookStatusReason = "string",
  InvokedAt = as.POSIXct(
    "2015-01-01"
  ),
  Target = list(
    TargetType = "RESOURCE",
    TargetTypeName = "string",
    TargetId = "string",
    Action = "CREATE"|"UPDATE"|"DELETE"|"IMPORT"
  ),
  Annotations = list(
    list(
      AnnotationName = "string",
      Status = "PASSED"|"FAILED"|"SKIPPED",
      StatusMessage = "string",
      RemediationMessage = "string",
      RemediationLink = "string",
      SeverityLevel = "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL"
    )
  )
)

Request syntax¶

svc$get_hook_result(
  HookResultId = "string"
)