GetHumanReadableSummaryCommand

Use a bare-bones client and the command you need to make an API call.

GetHumanReadableSummaryCommandInput

[GetHumanReadableSummaryCommandInput](@aws-sdk/client-iam!GetHumanReadableSummaryCommandInput:Interface)

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is <code>delegation-request</code> This method uses a Large Language Model (LLM) to generate the summary. If a delegation request has no owner or owner account, <code>GetHumanReadableSummary</code> 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 <code>GetHumanReadableSummary</code> 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 <a href="">default permissions granted to delegation requests</a>. These rules are identical to <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetDelegationRequest.html">GetDelegationRequest</a> API behavior, such that a party who has permissions to call <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetDelegationRequest.html">GetDelegationRequest</a> for a given delegation request will always be able to retrieve the human readable summary for that request.

EntityArn

Arn of the entity to be summarized. At this time, the only supported entity type is <code>delegation-request</code>

Locale

A string representing the locale to use for the summary generation. The supported locale strings are based on the <a href="/awsconsolehelpdocs/latest/gsg/change-language.html#supported-languages"> Supported languages of the Amazon Web Services Management Console </a>.

The input for [GetHumanReadableSummaryCommand](@aws-sdk/client-iam!GetHumanReadableSummaryCommand:Class).

$metadata

Metadata pertaining to this request.

The locale that this response was generated for. This maps to the input locale.

SummaryContent

Summary content in the specified locale. Summary content is non-empty only if the <code>SummaryState</code> is <code>AVAILABLE</code>.

SummaryState

State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.

GetHumanReadableSummaryCommandOutput

The output of [GetHumanReadableSummaryCommand](@aws-sdk/client-iam!GetHumanReadableSummaryCommand:Class).

$fault

name

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

NoSuchEntityException

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

ServiceFailureException

The request processing has failed because of an unknown error, exception or failure.

IAMServiceException

Base exception class for all service exceptions from IAM service.