Skip to content

GetHumanReadableSummaryResponse

Source code in docs_src/capo_iam/types/get_human_readable_summary_response.py
class GetHumanReadableSummaryResponse(TypedDict, closed=True):
    summary_content: NotRequired[
        "capo_iam.types.summary_content_type.summaryContentType"
    ]
    """<p>Summary content in the specified locale. Summary content is non-empty only if the <code>SummaryState</code> is <code>AVAILABLE</code>.</p>"""
    locale: NotRequired["capo_iam.types.locale_type.localeType"]
    """<p>The locale that this response was generated for. This maps to the input locale.</p>"""
    summary_state: NotRequired["capo_iam.types.summary_state_type.summaryStateType"]
    """<p>State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.</p>"""

locale instance-attribute

locale: NotRequired[localeType]

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

summary_content instance-attribute

summary_content: NotRequired[summaryContentType]

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

summary_state instance-attribute

summary_state: NotRequired[summaryStateType]

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