aws_sdk_directory/client/list_ad_assessments.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 [`ListADAssessments`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`directory_id(impl Into<String>)`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::set_directory_id):<br>required: **false**<br><p>The identifier of the directory for which to list assessments. If not specified, all assessments in your account are returned.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token from a previous request to <code>ListADAssessments</code>. Pass null if this is the first request.</p><br>
9 /// - [`limit(i32)`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of assessment summaries to return.</p><br>
10 /// - On success, responds with [`ListAdAssessmentsOutput`](crate::operation::list_ad_assessments::ListAdAssessmentsOutput) with field(s):
11 /// - [`assessments(Option<Vec::<AssessmentSummary>>)`](crate::operation::list_ad_assessments::ListAdAssessmentsOutput::assessments): <p>A list of assessment summaries containing basic information about each directory assessment.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_ad_assessments::ListAdAssessmentsOutput::next_token): <p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent request to retrieve the next set of items.</p>
13 /// - On failure, responds with [`SdkError<ListADAssessmentsError>`](crate::operation::list_ad_assessments::ListADAssessmentsError)
14 pub fn list_ad_assessments(&self) -> crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder {
15 crate::operation::list_ad_assessments::builders::ListADAssessmentsFluentBuilder::new(self.handle.clone())
16 }
17}