AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Waiters::PortalActive

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ PortalActive

Returns a new instance of PortalActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/waiters.rb', line 247

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_portal,
      acceptors: [{
        "state" => "success",
        "matcher" => "path",
        "argument" => "portal_status.state",
        "expected" => "ACTIVE"
      }]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :portal_id (required, String)

    The ID of the portal.

Returns:



266
267
268
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/waiters.rb', line 266

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