aws_sdk_customerprofiles/client/
get_segment_estimate.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSegmentEstimate`](crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    ///   - [`estimate_id(impl Into<String>)`](crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder::estimate_id) / [`set_estimate_id(Option<String>)`](crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder::set_estimate_id):<br>required: **true**<br><p>The query Id passed by a previous <code>CreateSegmentEstimate</code> operation.</p><br>
    /// - On success, responds with [`GetSegmentEstimateOutput`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput) with field(s):
    ///   - [`domain_name(Option<String>)`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput::domain_name): <p>The unique name of the domain.</p>
    ///   - [`estimate_id(Option<String>)`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput::estimate_id): <p>The <code>QueryId</code> which is the same as the value passed in <code>QueryId</code>.</p>
    ///   - [`status(Option<EstimateStatus>)`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput::status): <p>The current status of the query.</p>
    ///   - [`estimate(Option<String>)`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput::estimate): <p>The estimated number of profiles contained in the segment.</p>
    ///   - [`message(Option<String>)`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput::message): <p>The error message if there is any error.</p>
    ///   - [`status_code(i32)`](crate::operation::get_segment_estimate::GetSegmentEstimateOutput::status_code): <p>The status code of the segment estimate.</p>
    /// - On failure, responds with [`SdkError<GetSegmentEstimateError>`](crate::operation::get_segment_estimate::GetSegmentEstimateError)
    pub fn get_segment_estimate(&self) -> crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder {
        crate::operation::get_segment_estimate::builders::GetSegmentEstimateFluentBuilder::new(self.handle.clone())
    }
}