Class: Aws::SageMaker::Waiters::ImageVersionCreated

Inherits:

Object

Object
Aws::SageMaker::Waiters::ImageVersionCreated

show all

Defined in:: lib/aws-sdk-sagemaker/waiters.rb

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ ImageVersionCreated constructor

A new instance of ImageVersionCreated.
#wait(params = {}) ⇒ Types::DescribeImageVersionResponse

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

Constructor Details

#initialize(options) ⇒ `ImageVersionCreated`

Returns a new instance of ImageVersionCreated.

Parameters:

options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-sagemaker/waiters.rb', line 334

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 60,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_image_version,
      acceptors: [
        {
          "expected" => "CREATED",
          "matcher" => "path",
          "state" => "success",
          "argument" => "image_version_status"
        },
        {
          "expected" => "CREATE_FAILED",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "image_version_status"
        },
        {
          "expected" => "ValidationException",
          "matcher" => "error",
          "state" => "failure"
        }
      ]
    )
  }.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.



371
372
373

# File 'lib/aws-sdk-sagemaker/waiters.rb', line 371

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ `Types::DescribeImageVersionResponse`

Returns a response object which responds to the following methods:

#base_image => String
#container_image => String
#creation_time => Time
#failure_reason => String
#image_arn => String
#image_version_arn => String
#image_version_status => String
#last_modified_time => Time
#version => Integer
#vendor_guidance => String
#job_type => String
#ml_framework => String
#programming_lang => String
#processor => String
#horovod => Boolean
#release_notes => String

Options Hash (params):

:image_name (required, String) —

The name of the image.
:version (Integer) —

The version of the image. If not specified, the latest version is described.
:alias (String) —

The alias of the image version.

Returns:

(Types::DescribeImageVersionResponse) —
Returns a response object which responds to the following methods:
- #base_image => String
- #container_image => String
- #creation_time => Time
- #failure_reason => String
- #image_arn => String
- #image_version_arn => String
- #image_version_status => String
- #last_modified_time => Time
- #version => Integer
- #vendor_guidance => String
- #job_type => String
- #ml_framework => String
- #programming_lang => String
- #processor => String
- #horovod => Boolean
- #release_notes => String



366
367
368

# File 'lib/aws-sdk-sagemaker/waiters.rb', line 366

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