ListHookResultsRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListHookResults operation. Returns summaries of invoked Hooks. For more information, see View CloudFormation Hooks invocations in the CloudFormation Hooks User Guide.

This operation supports the following parameter combinations:

No parameters: Returns all Hook invocation summaries.
TypeArn only: Returns summaries for a specific Hook.
TypeArn and Status: Returns summaries for a specific Hook filtered by status.
TargetId and TargetType: Returns summaries for a specific Hook invocation target.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudFormation.AmazonCloudFormationRequest
      Amazon.CloudFormation.Model.ListHookResultsRequest

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

Syntax

public class ListHookResultsRequest : AmazonCloudFormationRequest
         IAmazonWebServiceRequest

The ListHookResultsRequest type exposes the following members

Constructors

	Name	Description
	ListHookResultsRequest()

Properties

Name	Type	Description
NextToken	System.String	Gets and sets the property NextToken. A string that identifies the next page of events that you want to retrieve.
Status	Amazon.CloudFormation.HookStatus	Gets and sets the property Status. Filters results by the status of Hook invocations. Can only be used in combination with `TypeArn`. Valid values are: `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.
TargetId	System.String	Gets and sets the property TargetId. Filters results by the unique identifier of the target the Hook was invoked against. For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the `HookRequestToken` returned by the Cloud Control API request. For more information on the `HookRequestToken`, see ProgressEvent. Required when `TargetType` is specified and cannot be used otherwise.
TargetType	Amazon.CloudFormation.ListHookResultsTargetType	Gets and sets the property TargetType. Filters results by target type. Currently, only `CHANGE_SET` and `CLOUD_CONTROL` are supported filter options. Required when `TargetId` is specified and cannot be used otherwise.
TypeArn	System.String	Gets and sets the property TypeArn. Filters results by the ARN of the Hook. Can be used alone or in combination with `Status`.

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