AWS CloudFormation

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

See also: AWS API Documentation

Request Syntax

client.list_hook_results(
    TargetType='CHANGE_SET'|'STACK'|'RESOURCE'|'CLOUD_CONTROL',
    TargetId='string',
    NextToken='string'
)

type TargetType:

string

param TargetType:

[REQUIRED]

The type of operation being targeted by the Hook.

type TargetId:

string

param 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.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'TargetType': 'CHANGE_SET'|'STACK'|'RESOURCE'|'CLOUD_CONTROL',
    'TargetId': 'string',
    'HookResults': [
        {
            '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'
}

Response Structure

• (dict) --

  • TargetType (string) --

    The type of operation being targeted by the Hook.

  • TargetId (string) --

    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 HooksRequestToken returned by the Cloud Control API operation request. For more information on the HooksRequestToken, see ProgressEvent.

  • HookResults (list) --

    A list of HookResultSummary structures that provides the status and Hook status reason for each Hook invocation for the specified target.

    • (dict) --

      Describes a Hook invocation, its status, and the reason for its status.

      • InvocationPoint (string) --

        The exact point in the provisioning logic where the Hook runs.

      • FailureMode (string) --

        The failure mode of the invocation. The following are potential modes:

        • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

        • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

      • TypeName (string) --

        The type name of the Hook being invoked.

      • TypeVersionId (string) --

        The version of the Hook being invoked.

      • TypeConfigurationVersionId (string) --

        The version of the Hook type configuration.

      • Status (string) --

        The state of the Hook invocation.

      • HookStatusReason (string) --

        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.

  • NextToken (string) --

    Pagination token, null or empty if no more results.