aws_sdk_iam/client/
get_human_readable_summary.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetHumanReadableSummary`](crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`entity_arn(impl Into<String>)`](crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder::entity_arn) / [`set_entity_arn(Option<String>)`](crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder::set_entity_arn):<br>required: **true**<br><p>Arn of the entity to be summarized. At this time, the only supported entity type is <code>delegation-request</code></p><br>
7    ///   - [`locale(impl Into<String>)`](crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder::locale) / [`set_locale(Option<String>)`](crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder::set_locale):<br>required: **false**<br><p>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>.</p><br>
8    /// - On success, responds with [`GetHumanReadableSummaryOutput`](crate::operation::get_human_readable_summary::GetHumanReadableSummaryOutput) with field(s):
9    ///   - [`summary_content(Option<String>)`](crate::operation::get_human_readable_summary::GetHumanReadableSummaryOutput::summary_content): <p>Summary content in the specified locale. Summary content is non-empty only if the <code>SummaryState</code> is <code>AVAILABLE</code>.</p>
10    ///   - [`locale(Option<String>)`](crate::operation::get_human_readable_summary::GetHumanReadableSummaryOutput::locale): <p>The locale that this response was generated for. This maps to the input locale.</p>
11    ///   - [`summary_state(Option<SummaryStateType>)`](crate::operation::get_human_readable_summary::GetHumanReadableSummaryOutput::summary_state): <p>State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.</p>
12    /// - On failure, responds with [`SdkError<GetHumanReadableSummaryError>`](crate::operation::get_human_readable_summary::GetHumanReadableSummaryError)
13    pub fn get_human_readable_summary(&self) -> crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder {
14        crate::operation::get_human_readable_summary::builders::GetHumanReadableSummaryFluentBuilder::new(self.handle.clone())
15    }
16}