Class: Aws::Rekognition::Waiters::ProjectVersionTrainingCompleted

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

Overview

Wait until the ProjectVersion training completes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ProjectVersionTrainingCompleted

Returns a new instance of ProjectVersionTrainingCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/aws-sdk-rekognition/waiters.rb', line 131

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 360,
    delay: 120,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_project_versions,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "project_version_descriptions[].status",
          "expected" => "TRAINING_COMPLETED"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "project_version_descriptions[].status",
          "expected" => "TRAINING_FAILED"
        }
      ]
    )
  }.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. 



163
164
165
 
# File 'lib/aws-sdk-rekognition/waiters.rb', line 163

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :project_arn (required, String) —

    The Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe.

  • :version_names (Array<String>) —

    A list of model or project version names that you want to describe. You can add up to 10 model or project version names to the list. If you don’t specify a value, all project version descriptions are returned. A version name is part of a project version ARN. For example, ‘my-model.2020-01-21T09.10.15` is the version name in the following ARN. `arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123`.

  • :next_token (String) —

    If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Returns:



158
159
160
 
# File 'lib/aws-sdk-rekognition/waiters.rb', line 158

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