aws_sdk_machinelearning/client/

describe_batch_predictions.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeBatchPredictions`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filter_variable(BatchPredictionFilterVariable)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::filter_variable) / [`set_filter_variable(Option<BatchPredictionFilterVariable>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_filter_variable):<br>required: **false**<br><p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p> <ul>  <li>   <p><code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</p></li>  <li>   <p><code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</p></li>  <li>   <p><code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code> <b> </b> <code>Name</code>.</p></li>  <li>   <p><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</p></li>  <li>   <p><code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</p></li>  <li>   <p><code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</p></li>  <li>   <p><code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p></li> </ul><br>
    ///   - [`eq(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::eq) / [`set_eq(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_eq):<br>required: **false**<br><p>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p><br>
    ///   - [`gt(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::gt) / [`set_gt(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_gt):<br>required: **false**<br><p>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p><br>
    ///   - [`lt(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::lt) / [`set_lt(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_lt):<br>required: **false**<br><p>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p><br>
    ///   - [`ge(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::ge) / [`set_ge(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_ge):<br>required: **false**<br><p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.</p><br>
    ///   - [`le(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::le) / [`set_le(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_le):<br>required: **false**<br><p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p><br>
    ///   - [`ne(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::ne) / [`set_ne(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_ne):<br>required: **false**<br><p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p><br>
    ///   - [`prefix(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::prefix) / [`set_prefix(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_prefix):<br>required: **false**<br><p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p> <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code> <code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>:</p> <ul>  <li>   <p>2014-09</p></li>  <li>   <p>2014-09-09</p></li>  <li>   <p>2014-09-09-Holiday</p></li> </ul><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_sort_order):<br>required: **false**<br><p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p> <ul>  <li>   <p><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p></li>  <li>   <p><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p></li> </ul> <p>Results are sorted by <code>FilterVariable</code>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_next_token):<br>required: **false**<br><p>An ID of the page in the paginated results.</p><br>
    ///   - [`limit(i32)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::set_limit):<br>required: **false**<br><p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p><br>
    /// - On success, responds with [`DescribeBatchPredictionsOutput`](crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput) with field(s):
    ///   - [`results(Option<Vec::<BatchPrediction>>)`](crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput::results): <p>A list of <code>BatchPrediction</code> objects that meet the search criteria.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput::next_token): <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
    /// - On failure, responds with [`SdkError<DescribeBatchPredictionsError>`](crate::operation::describe_batch_predictions::DescribeBatchPredictionsError)
    pub fn describe_batch_predictions(&self) -> crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder {
        crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsFluentBuilder::new(self.handle.clone())
    }
}