GetHumanReadableSummary
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- EntityArn
-
Arn of the entity to be summarized. At this time, the only supported entity type is
delegation-requestType: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
- Locale
-
A string representing the locale to use for the summary generation. The supported locale strings are based on the Supported languages of the AWS Management Console .
Type: String
Length Constraints: Minimum length of 2. Maximum length of 12.
Required: No
Response Elements
The following elements are returned by the service.
- Locale
-
The locale that this response was generated for. This maps to the input locale.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 12.
- SummaryContent
-
Summary content in the specified locale. Summary content is non-empty only if the
SummaryStateisAVAILABLE.Type: String
Length Constraints: Minimum length of 0. Maximum length of 10000.
- SummaryState
-
State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.
Type: String
Valid Values:
AVAILABLE | NOT_AVAILABLE | NOT_SUPPORTED | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of GetHumanReadableSummary.
Sample Request
https://iam.amazonaws.com/?Action=GetHumanReadableSummary
&EntityArn=arn%3Aaws%3Aiam%3A%3A561761503536%3Adelegation-request%2Fe4bdcdae-4f66-11eD-ELEG-ATIONEXAMPLE
&Version=2010-05-08
&AUTHPARAMS
Sample Response
<GetHumanReadableSummaryResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<GetHumanReadableSummaryResult>
<SummaryContent>Human readable summary in Markdown format</SummaryContent>
<Locale>en</Locale>
<SummaryState>AVAILABLE</SummaryState>
</GetHumanReadableSummaryResult>
<ResponseMetadata>
<RequestId>e4bdcdae-4f66-11e4-aefa-bfd6aEXAMPLE</RequestId>
</ResponseMetadata>
</GetHumanReadableSummaryResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
