get_human_readable_summary¶
Operation¶
async
¶
get_human_readable_summary(input: GetHumanReadableSummaryInput, plugins: list[Plugin] | None = None) -> GetHumanReadableSummaryOutput
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:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetHumanReadableSummaryInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetHumanReadableSummaryOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetHumanReadableSummaryInput structure.
Attributes¶
class-attribute
instance-attribute
¶
entity_arn: str | None = ...
Arn of the entity to be summarized. At this time, the only supported
entity type is delegation-request
class-attribute
instance-attribute
¶
locale: str | None = ...
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 .
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetHumanReadableSummaryOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
locale: str | None = ...
The locale that this response was generated for. This maps to the input locale.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.