aws_sdk_wellarchitected/client/
list_check_summaries.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListCheckSummaries`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`workload_id(impl Into<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::workload_id) / [`set_workload_id(Option<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_workload_id):<br>required: **true**<br><p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next set of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for this request.</p><br>
    ///   - [`lens_arn(impl Into<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::lens_arn) / [`set_lens_arn(Option<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_lens_arn):<br>required: **true**<br><p>Well-Architected Lens ARN.</p><br>
    ///   - [`pillar_id(impl Into<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::pillar_id) / [`set_pillar_id(Option<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_pillar_id):<br>required: **true**<br><p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <code>PillarReviewSummary$PillarId</code>.</p><br>
    ///   - [`question_id(impl Into<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::question_id) / [`set_question_id(Option<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_question_id):<br>required: **true**<br><p>The ID of the question.</p><br>
    ///   - [`choice_id(impl Into<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::choice_id) / [`set_choice_id(Option<String>)`](crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::set_choice_id):<br>required: **true**<br><p>The ID of a choice.</p><br>
    /// - On success, responds with [`ListCheckSummariesOutput`](crate::operation::list_check_summaries::ListCheckSummariesOutput) with field(s):
    ///   - [`check_summaries(Option<Vec::<CheckSummary>>)`](crate::operation::list_check_summaries::ListCheckSummariesOutput::check_summaries): <p>List of Trusted Advisor summaries related to the Well-Architected best practice.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_check_summaries::ListCheckSummariesOutput::next_token): <p>The token to use to retrieve the next set of results.</p>
    /// - On failure, responds with [`SdkError<ListCheckSummariesError>`](crate::operation::list_check_summaries::ListCheckSummariesError)
    pub fn list_check_summaries(&self) -> crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder {
        crate::operation::list_check_summaries::builders::ListCheckSummariesFluentBuilder::new(self.handle.clone())
    }
}