Struct aws_sdk_machinelearning::client::fluent_builders::DescribeBatchPredictions

pub struct DescribeBatchPredictions<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeBatchPredictions.

Returns a list of BatchPrediction operations that match the search criteria in the request.

Implementations

impl<C, M, R> DescribeBatchPredictions<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeBatchPredictionsOutput, SdkError<DescribeBatchPredictionsError>> where
    R::Policy: SmithyRetryPolicy<DescribeBatchPredictionsInputOperationOutputAlias, DescribeBatchPredictionsOutput, DescribeBatchPredictionsError, DescribeBatchPredictionsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn filter_variable(self, inp: BatchPredictionFilterVariable) -> Self

Use one of the following variables to filter a list of BatchPrediction:

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.

• Status - Sets the search criteria to the BatchPrediction status.

• Name - Sets the search criteria to the contents of the BatchPrediction Name.

• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.

• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.

• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.

• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

pub fn set_filter_variable(
    self,
    input: Option<BatchPredictionFilterVariable>
) -> Self

Use one of the following variables to filter a list of BatchPrediction:

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.

• Status - Sets the search criteria to the BatchPrediction status.

• Name - Sets the search criteria to the contents of the BatchPrediction Name.

• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.

• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.

• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.

• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

pub fn eq(self, inp: impl Into<String>) -> Self

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

pub fn set_eq(self, input: Option<String>) -> Self

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

pub fn gt(self, inp: impl Into<String>) -> Self

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

pub fn set_gt(self, input: Option<String>) -> Self

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

pub fn lt(self, inp: impl Into<String>) -> Self

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

pub fn set_lt(self, input: Option<String>) -> Self

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

pub fn ge(self, inp: impl Into<String>) -> Self

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

pub fn set_ge(self, input: Option<String>) -> Self

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

pub fn le(self, inp: impl Into<String>) -> Self

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

pub fn set_le(self, input: Option<String>) -> Self

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

pub fn ne(self, inp: impl Into<String>) -> Self

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

pub fn set_ne(self, input: Option<String>) -> Self

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

pub fn prefix(self, inp: impl Into<String>) -> Self

A string that is found at the beginning of a variable, such as Name or Id.

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

pub fn set_prefix(self, input: Option<String>) -> Self

A string that is found at the beginning of a variable, such as Name or Id.

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

pub fn sort_order(self, inp: SortOrder) -> Self

A two-value parameter that determines the sequence of the resulting list of MLModels.

• asc - Arranges the list in ascending order (A-Z, 0-9).

• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

pub fn set_sort_order(self, input: Option<SortOrder>) -> Self

A two-value parameter that determines the sequence of the resulting list of MLModels.

• asc - Arranges the list in ascending order (A-Z, 0-9).

• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

pub fn next_token(self, inp: impl Into<String>) -> Self

An ID of the page in the paginated results.

pub fn set_next_token(self, input: Option<String>) -> Self

An ID of the page in the paginated results.

pub fn limit(self, inp: i32) -> Self

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

pub fn set_limit(self, input: Option<i32>) -> Self

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeBatchPredictions<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.