Class: Aws::GameLiftStreams::Waiters::StreamSessionActive

Inherits:

Object

• Object
• Aws::GameLiftStreams::Waiters::StreamSessionActive

Defined in:

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

Overview

Waits until a stream session is active

Instance Method Summary

• #initialize(options) ⇒ StreamSessionActive constructor

  A new instance of StreamSessionActive.

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

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

Constructor Details

#initialize(options) ⇒ StreamSessionActive

Returns a new instance of StreamSessionActive.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/waiters.rb', line 263

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_stream_session,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "ERROR"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #additional_environment_variables => Hash<String,String>
• #additional_launch_args => Array<String>
• #application_arn => String
• #arn => String
• #connection_timeout_seconds => Integer
• #created_at => Time
• #description => String
• #export_files_metadata => Types::ExportFilesMetadata
• #last_updated_at => Time
• #location => String
• #log_file_location_uri => String
• #protocol => String
• #session_length_seconds => Integer
• #signal_request => String
• #signal_response => String
• #status => String
• #status_reason => String
• #stream_group_id => String
• #user_id => String
• #web_sdk_protocol_url => String

Parameters:

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

  a customizable set of options

Options Hash (params):

• :identifier (required, String) —

  The stream group that runs this stream session.

  This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN-arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 or ID-sg-1AB2C3De4.

• :stream_session_identifier (required, String) —

  An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4.

Returns:

• (Types::GetStreamSessionOutput) —

  Returns a response object which responds to the following methods:

  • #additional_environment_variables => Hash<String,String>
  • #additional_launch_args => Array<String>
  • #application_arn => String
  • #arn => String
  • #connection_timeout_seconds => Integer
  • #created_at => Time
  • #description => String
  • #export_files_metadata => Types::ExportFilesMetadata
  • #last_updated_at => Time
  • #location => String
  • #log_file_location_uri => String
  • #protocol => String
  • #session_length_seconds => Integer
  • #signal_request => String
  • #signal_response => String
  • #status => String
  • #status_reason => String
  • #stream_group_id => String
  • #user_id => String
  • #web_sdk_protocol_url => String

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/waiters.rb', line 290

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