aws_sdk_customerprofiles/client/
get_segment_membership.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSegmentMembership`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    ///   - [`segment_definition_name(impl Into<String>)`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::segment_definition_name) / [`set_segment_definition_name(Option<String>)`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::set_segment_definition_name):<br>required: **true**<br><p>The Id of the wanted segment. Needs to be a valid, and existing segment Id.</p><br>
    ///   - [`profile_ids(impl Into<String>)`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::profile_ids) / [`set_profile_ids(Option<Vec::<String>>)`](crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::set_profile_ids):<br>required: **true**<br><p>The list of profile IDs to query for.</p><br>
    /// - On success, responds with [`GetSegmentMembershipOutput`](crate::operation::get_segment_membership::GetSegmentMembershipOutput) with field(s):
    ///   - [`segment_definition_name(Option<String>)`](crate::operation::get_segment_membership::GetSegmentMembershipOutput::segment_definition_name): <p>The unique name of the segment definition.</p>
    ///   - [`profiles(Option<Vec::<ProfileQueryResult>>)`](crate::operation::get_segment_membership::GetSegmentMembershipOutput::profiles): <p>An array of maps where each contains a response per profile requested.</p>
    ///   - [`failures(Option<Vec::<ProfileQueryFailures>>)`](crate::operation::get_segment_membership::GetSegmentMembershipOutput::failures): <p>An array of maps where each contains a response per profile failed for the request.</p>
    /// - On failure, responds with [`SdkError<GetSegmentMembershipError>`](crate::operation::get_segment_membership::GetSegmentMembershipError)
    pub fn get_segment_membership(&self) -> crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder {
        crate::operation::get_segment_membership::builders::GetSegmentMembershipFluentBuilder::new(self.handle.clone())
    }
}