Class: Aws::MachineLearning::Waiters::BatchPredictionAvailable

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/waiters.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BatchPredictionAvailable

Returns a new instance of BatchPredictionAvailable.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 60
  • :delay (Integer) — default: 30
  • :before_attempt (Proc)
  • :before_wait (Proc) 


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/waiters.rb', line 87

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_batch_predictions,
      acceptors: [
        {
          "expected" => "COMPLETED",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "results[].status"
        },
        {
          "expected" => "FAILED",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "results[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeBatchPredictionsOutput

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :filter_variable (String) —

    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.

  • :eq (String) —

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

  • :gt (String) —

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

  • :lt (String) —

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

  • :ge (String) —

    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.

  • :le (String) —

    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.

  • :ne (String) —

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

  • :prefix (String) —

    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

  • :sort_order (String) —

    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.

  • :next_token (String) —

    An ID of the page in the paginated results.

  • :limit (Integer) —

    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.

Returns:



114
115
116
 
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/waiters.rb', line 114

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end