You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MachineLearning::Waiters::DataSourceAvailable

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) ⇒ DataSourceAvailable

Returns a new instance of DataSourceAvailable

Parameters:

  • options (Hash)

Options Hash (options):

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


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/waiters.rb', line 65

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_data_sources,
      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::DescribeDataSourcesOutput

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

    • CreatedAt - Sets the search criteria to DataSource creation dates.
    • Status - Sets the search criteria to DataSource statuses.
    • Name - Sets the search criteria to the contents of DataSource Name.
    • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
    • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
  • :eq (String)

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

  • :gt (String)

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

  • :lt (String)

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

  • :ge (String)

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

    • 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 maximum number of DataSource to include in the result.

Returns:



92
93
94
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/waiters.rb', line 92

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