aws_sdk_guardduty/client/create_trusted_entity_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 [`CreateTrustedEntitySet`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`detector_id(impl Into<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_detector_id):<br>required: **true**<br><p>The unique ID of the detector of the GuardDuty account for which you want to create a trusted entity set.</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 /// - [`name(impl Into<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_name):<br>required: **true**<br><p>A user-friendly name to identify the trusted entity set.</p> <p>The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).</p><br>
8 /// - [`format(TrustedEntitySetFormat)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::format) / [`set_format(Option<TrustedEntitySetFormat>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_format):<br>required: **true**<br><p>The format of the file that contains the trusted entity set.</p><br>
9 /// - [`location(impl Into<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::location) / [`set_location(Option<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_location):<br>required: **true**<br><p>The URI of the file that contains the threat entity set. The format of the <code>Location</code> URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-lists-create-activate.html">Format of location URL under Step 2: Adding trusted or threat intelligence data</a> in the <i>Amazon GuardDuty User Guide</i>.</p><br>
10 /// - [`expected_bucket_owner(impl Into<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_expected_bucket_owner):<br>required: **false**<br><p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b> parameter.</p><br>
11 /// - [`activate(bool)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::activate) / [`set_activate(Option<bool>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_activate):<br>required: **true**<br><p>A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.</p><br>
12 /// - [`client_token(impl Into<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_client_token):<br>required: **false**<br><p>The idempotency token for the create request.</p><br>
13 /// - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::set_tags):<br>required: **false**<br><p>The tags to be added to a new trusted entity set resource.</p><br>
14 /// - On success, responds with [`CreateTrustedEntitySetOutput`](crate::operation::create_trusted_entity_set::CreateTrustedEntitySetOutput) with field(s):
15 /// - [`trusted_entity_set_id(Option<String>)`](crate::operation::create_trusted_entity_set::CreateTrustedEntitySetOutput::trusted_entity_set_id): <p>The ID returned by GuardDuty after creation of the trusted entity set resource.</p>
16 /// - On failure, responds with [`SdkError<CreateTrustedEntitySetError>`](crate::operation::create_trusted_entity_set::CreateTrustedEntitySetError)
17 pub fn create_trusted_entity_set(&self) -> crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder {
18 crate::operation::create_trusted_entity_set::builders::CreateTrustedEntitySetFluentBuilder::new(self.handle.clone())
19 }
20}