List Hook Results

cloudformation_list_hook_results

R Documentation

Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided

Description

Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.

Usage

cloudformation_list_hook_results(TargetType, TargetId, NextToken)

Arguments

TargetType

[required] The type of operation being targeted by the Hook.

TargetId

[required] The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set.

If the target is a Cloud Control API operation, this will be the HookRequestToken returned by the Cloud Control API operation request. For more information on the HookRequestToken, see ProgressEvent.

NextToken

A string that identifies the next page of events that you want to retrieve.

Value

A list with the following syntax:

list(
  TargetType = "CHANGE_SET"|"STACK"|"RESOURCE"|"CLOUD_CONTROL",
  TargetId = "string",
  HookResults = list(
    list(
      InvocationPoint = "PRE_PROVISION",
      FailureMode = "FAIL"|"WARN",
      TypeName = "string",
      TypeVersionId = "string",
      TypeConfigurationVersionId = "string",
      Status = "HOOK_IN_PROGRESS"|"HOOK_COMPLETE_SUCCEEDED"|"HOOK_COMPLETE_FAILED"|"HOOK_FAILED",
      HookStatusReason = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_hook_results(
  TargetType = "CHANGE_SET"|"STACK"|"RESOURCE"|"CLOUD_CONTROL",
  TargetId = "string",
  NextToken = "string"
)