AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the GetHookResult operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.CloudFormation.Model.GetHookResultResponse

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C# 
public class GetHookResultResponse : AmazonWebServiceResponse

The GetHookResultResponse type exposes the following members

Constructors

NameDescription
Public Method GetHookResultResponse()

Properties

NameTypeDescription
Public Property Annotations System.Collections.Generic.List<Amazon.CloudFormation.Model.Annotation>

Gets and sets the property Annotations.

A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property FailureMode Amazon.CloudFormation.HookFailureMode

Gets and sets the property FailureMode.

The failure mode of the invocation.

Public Property HookResultId System.String

Gets and sets the property HookResultId.

The unique identifier of the Hook result.

Public Property HookStatusReason System.String

Gets and sets the property HookStatusReason.

A message that provides additional details about the Hook invocation status.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InvocationPoint Amazon.CloudFormation.HookInvocationPoint

Gets and sets the property InvocationPoint.

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

Public Property InvokedAt System.DateTime

Gets and sets the property InvokedAt.

The timestamp when the Hook was invoked.

Public Property OriginalTypeName System.String

Gets and sets the property OriginalTypeName.

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.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Status Amazon.CloudFormation.HookStatus

Gets and sets the property Status.

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.

Public Property Target Amazon.CloudFormation.Model.HookTarget

Gets and sets the property Target.

Information about the target of the Hook invocation.

Public Property TypeArn System.String

Gets and sets the property TypeArn.

The Amazon Resource Name (ARN) of the Hook.

Public Property TypeConfigurationVersionId System.String

Gets and sets the property TypeConfigurationVersionId.

The version identifier of the Hook configuration data that was used during invocation.

Public Property TypeName System.String

Gets and sets the property TypeName.

The name of the Hook that was invoked.

Public Property TypeVersionId System.String

Gets and sets the property TypeVersionId.

The version identifier of the Hook that was invoked.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5