Class: Aws::Rekognition::Waiters::ProjectVersionRunning

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

Overview

Wait until the ProjectVersion is running.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ProjectVersionRunning

Returns a new instance of ProjectVersionRunning.

Parameters:

  • options (Hash)

Options Hash (options):

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


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

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

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :project_arn (required, String)

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

  • :version_names (Array<String>)

    A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) 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 Custom Labels 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:



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

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