Class: Aws::EndUserMessaging::Waiters::BrandProfileActive

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

Overview

Wait until a brand profile reaches the ACTIVE state.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BrandProfileActive

Returns a new instance of BrandProfileActive.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 5
  • :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
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/waiters.rb', line 86

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_brand_profile,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "BLOCKED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "CANCELLED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :brand_profile_id (required, String) —

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

Returns:



125
126
127
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/waiters.rb', line 125

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