Get Human Readable Summary
| iam_get_human_readable_summary | R Documentation |
Retrieves a human readable summary for a given entity¶
Description¶
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,
get_human_readable_summary 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
get_human_readable_summary 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
get_delegation_request API behavior, such that a party who has
permissions to call get_delegation_request for a given delegation
request will always be able to retrieve the human readable summary for
that request.
Usage¶
iam_get_human_readable_summary(EntityArn, Locale)
Arguments¶
EntityArn |
[required] Arn of the entity to be summarized. At this time, the
only supported entity type is |
Locale |
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 . |
Value¶
A list with the following syntax:
list(
SummaryContent = "string",
Locale = "string",
SummaryState = "AVAILABLE"|"NOT_AVAILABLE"|"NOT_SUPPORTED"|"FAILED"
)
Request syntax¶
svc$get_human_readable_summary(
EntityArn = "string",
Locale = "string"
)