Class: Aws::MachineLearning::Waiters::MLModelAvailable

Inherits:

Object

• Object
• Aws::MachineLearning::Waiters::MLModelAvailable

Defined in:

lib/aws-sdk-machinelearning/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ MLModelAvailable constructor

  A new instance of MLModelAvailable.

• #wait(params = {}) ⇒ Types::DescribeMLModelsOutput

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ MLModelAvailable

Returns a new instance of MLModelAvailable.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-machinelearning/waiters.rb', line 219

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_ml_models,
      acceptors: [
        {
          "expected" => "COMPLETED",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "results[].status"
        },
        {
          "expected" => "FAILED",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "results[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-machinelearning/waiters.rb', line 251

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #results => Array<Types::MLModel>

• #next_token => String

Options Hash (params):

• :filter_variable (String) —

  Use one of the following variables to filter a list of ‘MLModel`:

  • ‘CreatedAt` - Sets the search criteria to `MLModel` creation date.

  • ‘Status` - Sets the search criteria to `MLModel` status.

  • ‘Name` - Sets the search criteria to the contents of `MLModel` `Name`.

  • ‘IAMUser` - Sets the search criteria to the user account that invoked the `MLModel` creation.

  • ‘TrainingDataSourceId` - Sets the search criteria to the `DataSource` used to train one or more `MLModel`.

  • ‘RealtimeEndpointStatus` - Sets the search criteria to the `MLModel` real-time endpoint status.

  • ‘MLModelType` - Sets the search criteria to `MLModel` type: binary, regression, or multi-class.

  • ‘Algorithm` - Sets the search criteria to the algorithm that the `MLModel` uses.

  • ‘TrainingDataURI` - Sets the search criteria to the data file(s) used in training a `MLModel`. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

• :eq (String) —

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

• :gt (String) —

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

• :lt (String) —

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

• :ge (String) —

  The greater than or equal to operator. The ‘MLModel` 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 ‘MLModel` 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 ‘MLModel` 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, an ‘MLModel` could have the `Name` `2014-09-09-HolidayGiftMailer`. To search for this `MLModel`, 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 ‘MLModel`.

  • ‘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) —

  The 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:

• (Types::DescribeMLModelsOutput) —

  Returns a response object which responds to the following methods:

  • #results => Array<Types::MLModel>

  • #next_token => String

# File 'lib/aws-sdk-machinelearning/waiters.rb', line 246

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