IAM / Client / get_human_readable_summary

get_human_readable_summary

IAM.Client.get_human_readable_summary(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_human_readable_summary(
    EntityArn='string',
    Locale='string'
)

Parameters:

• EntityArn (string) –

  [REQUIRED]

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

• 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.

Return type:

dict

Returns:

Response Syntax

{
    'SummaryContent': 'string',
    'Locale': 'string',
    'SummaryState': 'AVAILABLE'|'NOT_AVAILABLE'|'NOT_SUPPORTED'|'FAILED'
}

Response Structure

• (dict) –

  • SummaryContent (string) –

    Summary content in the specified locale. Summary content is non-empty only if the SummaryState is AVAILABLE.

  • Locale (string) –

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

  • SummaryState (string) –

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

Exceptions

• IAM.Client.exceptions.InvalidInputException

• IAM.Client.exceptions.NoSuchEntityException

• IAM.Client.exceptions.ServiceFailureException