ListHookResults - AWS CloudFormation

ListHookResults

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

TargetId

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: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

TargetType

The type of operation being targeted by the Hook.

Type: String

Valid Values: CHANGE_SET | STACK | RESOURCE | CLOUD_CONTROL

Required: Yes

Response Elements

The following elements are returned by the service.

HookResults.member.N

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

Type: Array of HookResultSummary objects

NextToken

Pagination token, null or empty if no more results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

TargetId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

TargetType

The type of operation being targeted by the Hook.

Type: String

Valid Values: CHANGE_SET | STACK | RESOURCE | CLOUD_CONTROL

Errors

For information about the errors that are common to all actions, see Common Errors.

HookResultNotFound

The specified target doesn't have any requested Hook invocations.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: