aws_sdk_guardduty/client/
get_ip_set.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 [`GetIPSet`](crate::operation::get_ip_set::builders::GetIPSetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`detector_id(impl Into<String>)`](crate::operation::get_ip_set::builders::GetIPSetFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::get_ip_set::builders::GetIPSetFluentBuilder::set_detector_id):<br>required: **true**<br><p>The unique ID of the detector that is associated with the IPSet.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p><br>
7    ///   - [`ip_set_id(impl Into<String>)`](crate::operation::get_ip_set::builders::GetIPSetFluentBuilder::ip_set_id) / [`set_ip_set_id(Option<String>)`](crate::operation::get_ip_set::builders::GetIPSetFluentBuilder::set_ip_set_id):<br>required: **true**<br><p>The unique ID of the IPSet to retrieve.</p><br>
8    /// - On success, responds with [`GetIpSetOutput`](crate::operation::get_ip_set::GetIpSetOutput) with field(s):
9    ///   - [`name(Option<String>)`](crate::operation::get_ip_set::GetIpSetOutput::name): <p>The user-friendly name for the IPSet.</p>
10    ///   - [`format(Option<IpSetFormat>)`](crate::operation::get_ip_set::GetIpSetOutput::format): <p>The format of the file that contains the IPSet.</p>
11    ///   - [`location(Option<String>)`](crate::operation::get_ip_set::GetIpSetOutput::location): <p>The URI of the file that contains the IPSet.</p>
12    ///   - [`status(Option<IpSetStatus>)`](crate::operation::get_ip_set::GetIpSetOutput::status): <p>The status of IPSet file that was uploaded.</p>
13    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_ip_set::GetIpSetOutput::tags): <p>The tags of the IPSet resource.</p>
14    ///   - [`expected_bucket_owner(Option<String>)`](crate::operation::get_ip_set::GetIpSetOutput::expected_bucket_owner): <p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b> parameter. This field appears in the response only if it was provided during IPSet creation or update.</p>
15    /// - On failure, responds with [`SdkError<GetIPSetError>`](crate::operation::get_ip_set::GetIPSetError)
16    pub fn get_ip_set(&self) -> crate::operation::get_ip_set::builders::GetIPSetFluentBuilder {
17        crate::operation::get_ip_set::builders::GetIPSetFluentBuilder::new(self.handle.clone())
18    }
19}