human_readable_summaries

Creates, updates, deletes, gets or lists a human_readable_summaries resource.

Overview

Name	human_readable_summaries
Type	Resource
Id	aws.iam.human_readable_summaries

Fields

The following fields are returned by SELECT queries:

get_human_readable_summary

Name	Datatype	Description
locale	string	The locale that this response was generated for. This maps to the input locale.
summary_content	string	Summary content in the specified locale. Summary content is non-empty only if the SummaryState is AVAILABLE.
summary_state	string	State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_human_readable_summary	select	EntityArn, region	Locale	Retrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request This method uses a Large Language Model (LLM) to generate the summary. If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read default permissions granted to delegation requests. These rules are identical to GetDelegationRequest API behavior, such that a party who has permissions to call GetDelegationRequest for a given delegation request will always be able to retrieve the human readable summary for that request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
EntityArn	string	Arn of the entity to be summarized. At this time, the only supported entity type is delegation-request
region	string	AWS region (default: us-east-1)
Locale	string	A string representing the locale to use for the summary generation. The supported locale strings are based on the Supported languages of the Amazon Web Services Management Console .

SELECT examples

get_human_readable_summary

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request This method uses a Large Language Model (LLM) to generate the summary. If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read default permissions granted to delegation requests. These rules are identical to GetDelegationRequest API behavior, such that a party who has permissions to call GetDelegationRequest for a given delegation request will always be able to retrieve the human readable summary for that request.

SELECT
locale,
summary_content,
summary_state
FROM aws.iam.human_readable_summaries
WHERE EntityArn = '{{ EntityArn }}' -- required
AND region = '{{ region }}' -- required
AND Locale = '{{ Locale }}'
;