Class: Aws::GroundStation::Waiters::ContactScheduled

Inherits:

Object

• Object
• Aws::GroundStation::Waiters::ContactScheduled

Defined in:

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

Overview

Waits until a contact has been scheduled

Instance Method Summary

• #initialize(options) ⇒ ContactScheduled constructor

  A new instance of ContactScheduled.

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

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

Constructor Details

#initialize(options) ⇒ ContactScheduled

Returns a new instance of ContactScheduled.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/waiters.rb', line 85

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_contact,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "contact_status",
          "state" => "failure",
          "expected" => "FAILED_TO_SCHEDULE"
        },
        {
          "matcher" => "path",
          "argument" => "contact_status",
          "state" => "success",
          "expected" => "SCHEDULED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #contact_id => String
• #contact_status => String
• #dataflow_list => Array<Types::DataflowDetail>
• #end_time => Time
• #error_message => String
• #ground_station => String
• #maximum_elevation => Types::Elevation
• #mission_profile_arn => String
• #post_pass_end_time => Time
• #pre_pass_start_time => Time
• #region => String
• #satellite_arn => String
• #start_time => Time
• #tags => Hash<String,String>
• #visibility_end_time => Time
• #visibility_start_time => Time

Parameters:

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

  a customizable set of options

Options Hash (params):

• :contact_id (required, String) —

  UUID of a contact.

Returns:

• (Types::DescribeContactResponse) —

  Returns a response object which responds to the following methods:

  • #contact_id => String
  • #contact_status => String
  • #dataflow_list => Array<Types::DataflowDetail>
  • #end_time => Time
  • #error_message => String
  • #ground_station => String
  • #maximum_elevation => Types::Elevation
  • #mission_profile_arn => String
  • #post_pass_end_time => Time
  • #pre_pass_start_time => Time
  • #region => String
  • #satellite_arn => String
  • #start_time => Time
  • #tags => Hash<String,String>
  • #visibility_end_time => Time
  • #visibility_start_time => Time

# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/waiters.rb', line 112

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