AWS CLI Command Reference

[ aws . cloudformation ]

get-hook-result

Description

Retrieves detailed information and remediation guidance for a Hook invocation result.

See also: AWS API Documentation

Synopsis

  get-hook-result
[--hook-result-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--hook-result-id (string)

The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the ListHookResults operation.

Constraints:

  • min: 36
  • max: 36
  • pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

HookResultId -> (string)

The unique identifier of the Hook result.

Constraints:

  • min: 36
  • max: 36
  • pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

InvocationPoint -> (string)

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

Possible values:

  • PRE_PROVISION

FailureMode -> (string)

The failure mode of the invocation.

Possible values:

  • FAIL
  • WARN

TypeName -> (string)

The name of the Hook that was invoked.

Constraints:

  • min: 10
  • max: 196

OriginalTypeName -> (string)

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 .

Constraints:

  • min: 10
  • max: 196

TypeVersionId -> (string)

The version identifier of the Hook that was invoked.

Constraints:

  • min: 1
  • max: 128
  • pattern: [A-Za-z0-9-]+

TypeConfigurationVersionId -> (string)

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

Constraints:

  • min: 1
  • max: 128
  • pattern: [A-Za-z0-9-]+

TypeArn -> (string)

The Amazon Resource Name (ARN) of the Hook.

Constraints:

  • max: 1024
  • pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/[A-Za-z0-9-]+/?

Status -> (string)

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.

Possible values:

  • HOOK_IN_PROGRESS
  • HOOK_COMPLETE_SUCCEEDED
  • HOOK_COMPLETE_FAILED
  • HOOK_FAILED

HookStatusReason -> (string)

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

Constraints:

  • min: 1
  • max: 1024

InvokedAt -> (timestamp)

The timestamp when the Hook was invoked.

Target -> (structure)

Information about the target of the Hook invocation.

TargetType -> (string) [required]

The target type.

Possible values:

  • RESOURCE

TargetTypeName -> (string) [required]

The target name, for example, AWS::S3::Bucket .

Constraints:

  • min: 1
  • max: 256
  • pattern: ^[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}$

TargetId -> (string) [required]

The unique identifier of the Hook invocation target.

Constraints:

  • min: 1
  • max: 256
  • pattern: [^_]*

Action -> (string) [required]

The action that invoked the Hook.

Possible values:

  • CREATE
  • UPDATE
  • DELETE
  • IMPORT

Annotations -> (list)

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

(structure)

The Annotation data type.

A GetHookResult call returns detailed information and remediation guidance from Control Tower, Guard, Lambda, or custom Hooks for a Hook invocation result.

AnnotationName -> (string)

An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.

Constraints:

  • min: 1
  • max: 1024

Status -> (string)

The status of the Hook invocation from the downstream service.

Possible values:

  • PASSED
  • FAILED
  • SKIPPED

StatusMessage -> (string)

The explanation for the specific status assigned to this Hook invocation. For example, “Bucket does not block public access”.

Constraints:

  • min: 1
  • max: 16384

RemediationMessage -> (string)

Suggests what to change if your Hook returns a FAILED status. For example, “Block public access to the bucket”.

Constraints:

  • min: 1
  • max: 16384

RemediationLink -> (string)

A URL that you can access for additional remediation guidance.

Constraints:

  • min: 1
  • max: 5120

SeverityLevel -> (string)

The relative risk associated with any violations of this type.

Possible values:

  • INFORMATIONAL
  • LOW
  • MEDIUM
  • HIGH
  • CRITICAL
© Copyright 2025, Amazon Web Services. Created using Sphinx.