Class: Aws::EndUserMessaging::Waiters::JobSuccess

Inherits:

Object

• Object
• Aws::EndUserMessaging::Waiters::JobSuccess

Defined in:

gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/waiters.rb

Overview

Wait until an async job reaches the SUCCESS terminal state.

Instance Method Summary

• #initialize(options) ⇒ JobSuccess constructor

  A new instance of JobSuccess.

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

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

Constructor Details

#initialize(options) ⇒ JobSuccess

Returns a new instance of JobSuccess.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/waiters.rb', line 143

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

Instance Method Details

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

Returns a response object which responds to the following methods:

• #job_id => String
• #status => String
• #operation_type => String
• #created_at => Time
• #updated_at => Time
• #brand_profile_id => String
• #error_code => String
• #error_message => String
• #resources => Array<Types::JobResource>

Parameters:

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

  a customizable set of options

Options Hash (params):

• :job_id (required, String) —

  The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

Returns:

• (Types::Job) —

  Returns a response object which responds to the following methods:

  • #job_id => String
  • #status => String
  • #operation_type => String
  • #created_at => Time
  • #updated_at => Time
  • #brand_profile_id => String
  • #error_code => String
  • #error_message => String
  • #resources => Array<Types::JobResource>

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/waiters.rb', line 170

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