aws_sdk_customerprofiles/client/
create_calculated_attribute_definition.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 [`CreateCalculatedAttributeDefinition`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_name(impl Into<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
7    ///   - [`calculated_attribute_name(impl Into<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::calculated_attribute_name) / [`set_calculated_attribute_name(Option<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_calculated_attribute_name):<br>required: **true**<br><p>The unique name of the calculated attribute.</p><br>
8    ///   - [`display_name(impl Into<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_display_name):<br>required: **false**<br><p>The display name of the calculated attribute.</p><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_description):<br>required: **false**<br><p>The description of the calculated attribute.</p><br>
10    ///   - [`attribute_details(AttributeDetails)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::attribute_details) / [`set_attribute_details(Option<AttributeDetails>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_attribute_details):<br>required: **true**<br><p>Mathematical expression and a list of attribute items specified in that expression.</p><br>
11    ///   - [`conditions(Conditions)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::conditions) / [`set_conditions(Option<Conditions>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_conditions):<br>required: **false**<br><p>The conditions including range, object count, and threshold for the calculated attribute.</p><br>
12    ///   - [`filter(Filter)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::filter) / [`set_filter(Option<Filter>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_filter):<br>required: **false**<br><p>Defines how to filter incoming objects to include part of the Calculated Attribute.</p><br>
13    ///   - [`statistic(Statistic)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::statistic) / [`set_statistic(Option<Statistic>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_statistic):<br>required: **true**<br><p>The aggregation operation to perform for the calculated attribute.</p><br>
14    ///   - [`use_historical_data(bool)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::use_historical_data) / [`set_use_historical_data(Option<bool>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_use_historical_data):<br>required: **false**<br><p>Whether historical data ingested before the Calculated Attribute was created should be included in calculations.</p><br>
15    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::set_tags):<br>required: **false**<br><p>The tags used to organize, track, or control access for this resource.</p><br>
16    /// - On success, responds with [`CreateCalculatedAttributeDefinitionOutput`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput) with field(s):
17    ///   - [`calculated_attribute_name(Option<String>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::calculated_attribute_name): <p>The unique name of the calculated attribute.</p>
18    ///   - [`display_name(Option<String>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::display_name): <p>The display name of the calculated attribute.</p>
19    ///   - [`description(Option<String>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::description): <p>The description of the calculated attribute.</p>
20    ///   - [`attribute_details(Option<AttributeDetails>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::attribute_details): <p>Mathematical expression and a list of attribute items specified in that expression.</p>
21    ///   - [`conditions(Option<Conditions>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::conditions): <p>The conditions including range, object count, and threshold for the calculated attribute.</p>
22    ///   - [`filter(Option<Filter>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::filter): <p>The filter that was used as part of the request.</p>
23    ///   - [`statistic(Option<Statistic>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::statistic): <p>The aggregation operation to perform for the calculated attribute.</p>
24    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::created_at): <p>The timestamp of when the calculated attribute definition was created.</p>
25    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::last_updated_at): <p>The timestamp of when the calculated attribute definition was most recently edited.</p>
26    ///   - [`use_historical_data(Option<bool>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::use_historical_data): <p>Whether historical data ingested before the Calculated Attribute was created should be included in calculations.</p>
27    ///   - [`status(Option<ReadinessStatus>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::status): <p>Status of the Calculated Attribute creation (whether all historical data has been indexed.)</p>
28    ///   - [`readiness(Option<Readiness>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::readiness): <p>Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.</p>
29    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionOutput::tags): <p>The tags used to organize, track, or control access for this resource.</p>
30    /// - On failure, responds with [`SdkError<CreateCalculatedAttributeDefinitionError>`](crate::operation::create_calculated_attribute_definition::CreateCalculatedAttributeDefinitionError)
31    pub fn create_calculated_attribute_definition(
32        &self,
33    ) -> crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder {
34        crate::operation::create_calculated_attribute_definition::builders::CreateCalculatedAttributeDefinitionFluentBuilder::new(self.handle.clone())
35    }
36}