aws_sdk_iotsitewise/client/

batch_get_asset_property_aggregates.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchGetAssetPropertyAggregates`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`entries(BatchGetAssetPropertyAggregatesEntry)`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::entries) / [`set_entries(Option<Vec::<BatchGetAssetPropertyAggregatesEntry>>)`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::set_entries):<br>required: **true**<br><p>The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to be used for the next set of paginated results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</p> <ul>  <li>   <p>The size of the result set is equal to 1 MB.</p></li>  <li>   <p>The number of data points in the result set is equal to the value of <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</p></li> </ul><br>
    /// - On success, responds with [`BatchGetAssetPropertyAggregatesOutput`](crate::operation::batch_get_asset_property_aggregates::BatchGetAssetPropertyAggregatesOutput) with field(s):
    ///   - [`error_entries(Vec::<BatchGetAssetPropertyAggregatesErrorEntry>)`](crate::operation::batch_get_asset_property_aggregates::BatchGetAssetPropertyAggregatesOutput::error_entries): <p>A list of the errors (if any) associated with the batch request. Each error entry contains the <code>entryId</code> of the entry that failed.</p>
    ///   - [`success_entries(Vec::<BatchGetAssetPropertyAggregatesSuccessEntry>)`](crate::operation::batch_get_asset_property_aggregates::BatchGetAssetPropertyAggregatesOutput::success_entries): <p>A list of entries that were processed successfully by this batch request. Each success entry contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
    ///   - [`skipped_entries(Vec::<BatchGetAssetPropertyAggregatesSkippedEntry>)`](crate::operation::batch_get_asset_property_aggregates::BatchGetAssetPropertyAggregatesOutput::skipped_entries): <p>A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::batch_get_asset_property_aggregates::BatchGetAssetPropertyAggregatesOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
    /// - On failure, responds with [`SdkError<BatchGetAssetPropertyAggregatesError>`](crate::operation::batch_get_asset_property_aggregates::BatchGetAssetPropertyAggregatesError)
    pub fn batch_get_asset_property_aggregates(
        &self,
    ) -> crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder {
        crate::operation::batch_get_asset_property_aggregates::builders::BatchGetAssetPropertyAggregatesFluentBuilder::new(self.handle.clone())
    }
}