aws_sdk_customerprofiles/client/
get_segment_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 [`GetSegmentDefinition`](crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
7    ///   - [`segment_definition_name(impl Into<String>)`](crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder::segment_definition_name) / [`set_segment_definition_name(Option<String>)`](crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder::set_segment_definition_name):<br>required: **true**<br><p>The unique name of the segment definition.</p><br>
8    /// - On success, responds with [`GetSegmentDefinitionOutput`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput) with field(s):
9    ///   - [`segment_definition_name(Option<String>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::segment_definition_name): <p>The name of the segment definition.</p>
10    ///   - [`display_name(Option<String>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::display_name): <p>The display name of the segment definition.</p>
11    ///   - [`description(Option<String>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::description): <p>The description of the segment definition.</p>
12    ///   - [`segment_groups(Option<SegmentGroup>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::segment_groups): <p>The segment criteria associated with this definition.</p>
13    ///   - [`segment_definition_arn(String)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::segment_definition_arn): <p>The arn of the segment definition.</p>
14    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::created_at): <p>The timestamp of when the segment definition was created.</p>
15    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::tags): <p>The tags used to organize, track, or control access for this resource.</p>
16    ///   - [`segment_sql_query(Option<String>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::segment_sql_query): <p>The segment SQL query.</p>
17    ///   - [`segment_type(Option<SegmentType>)`](crate::operation::get_segment_definition::GetSegmentDefinitionOutput::segment_type): <p>The segment type.</p> <p>Classic : Segments created using traditional SegmentGroup structure</p> <p>Enhanced : Segments created using SQL queries</p>
18    /// - On failure, responds with [`SdkError<GetSegmentDefinitionError>`](crate::operation::get_segment_definition::GetSegmentDefinitionError)
19    pub fn get_segment_definition(&self) -> crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder {
20        crate::operation::get_segment_definition::builders::GetSegmentDefinitionFluentBuilder::new(self.handle.clone())
21    }
22}