Skip to main content

aws_sdk_securityagent/client/
list_discovered_endpoints.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 [`ListDiscoveredEndpoints`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::set_max_results):<br>required: **false**<br>Maximum number of discovered endpoints to return in a single request (default: 50)<br>
8    ///   - [`pentest_job_id(impl Into<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::pentest_job_id) / [`set_pentest_job_id(Option<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::set_pentest_job_id):<br>required: **true**<br>Identifier of the pentest job for which to retrieve discovered endpoints<br>
9    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::set_agent_space_id):<br>required: **true**<br>ID of the agent space where the pentest job exists<br>
10    ///   - [`prefix(impl Into<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::prefix) / [`set_prefix(Option<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::set_prefix):<br>required: **false**<br>Optional URI prefix filter to narrow down results<br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::set_next_token):<br>required: **false**<br>Token for pagination<br>
12    /// - On success, responds with [`ListDiscoveredEndpointsOutput`](crate::operation::list_discovered_endpoints::ListDiscoveredEndpointsOutput) with field(s):
13    ///   - [`discovered_endpoints(Option<Vec::<DiscoveredEndpoint>>)`](crate::operation::list_discovered_endpoints::ListDiscoveredEndpointsOutput::discovered_endpoints): List of discovered endpoints for the pentest job
14    ///   - [`next_token(Option<String>)`](crate::operation::list_discovered_endpoints::ListDiscoveredEndpointsOutput::next_token): Token for pagination to retrieve the next set of results
15    /// - On failure, responds with [`SdkError<ListDiscoveredEndpointsError>`](crate::operation::list_discovered_endpoints::ListDiscoveredEndpointsError)
16    pub fn list_discovered_endpoints(&self) -> crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder {
17        crate::operation::list_discovered_endpoints::builders::ListDiscoveredEndpointsFluentBuilder::new(self.handle.clone())
18    }
19}