1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PreviewAgents`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`preview_agents_arn(impl Into<String>)`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::preview_agents_arn) / [`set_preview_agents_arn(Option<String>)`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::set_preview_agents_arn):<br>required: **true**<br><p>The ARN of the assessment target whose agents you want to preview.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::set_next_token):<br>required: **false**<br><p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the <b>PreviewAgents</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from the previous response to continue listing data.</p><br>
    ///   - [`max_results(i32)`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::set_max_results):<br>required: **false**<br><p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</p><br>
    /// - On success, responds with [`PreviewAgentsOutput`](crate::operation::preview_agents::PreviewAgentsOutput) with field(s):
    ///   - [`agent_previews(Vec::<AgentPreview>)`](crate::operation::preview_agents::PreviewAgentsOutput::agent_previews): <p>The resulting list of agents.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::preview_agents::PreviewAgentsOutput::next_token): <p> When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.</p>
    /// - On failure, responds with [`SdkError<PreviewAgentsError>`](crate::operation::preview_agents::PreviewAgentsError)
    pub fn preview_agents(&self) -> crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder {
        crate::operation::preview_agents::builders::PreviewAgentsFluentBuilder::new(self.handle.clone())
    }
}