Class: Aws::GroundStation::Waiters::ContactUpdated

Inherits:

Object

Object
Aws::GroundStation::Waiters::ContactUpdated

show all

Defined in:: lib/aws-sdk-groundstation/waiters.rb

Overview

Waits until a contact has been updated

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ ContactUpdated constructor

A new instance of ContactUpdated.
#wait(params = {}) ⇒ Types::DescribeContactVersionResponse

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

Constructor Details

#initialize(options) ⇒ `ContactUpdated`

Returns a new instance of ContactUpdated.

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 'lib/aws-sdk-groundstation/waiters.rb', line 131

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

Instance Attribute Details

#waiter ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



163
164
165

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

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ `Types::DescribeContactVersionResponse`

Returns a response object which responds to the following methods:

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

Options Hash (params):

:contact_id (required, String) —

UUID of a contact.
:version_id (required, Integer) —

Version ID of a contact.

Returns:

(Types::DescribeContactVersionResponse) —
Returns a response object which responds to the following methods:
- #contact_id => String
- #mission_profile_arn => String
- #satellite_arn => String
- #start_time => Time
- #end_time => Time
- #pre_pass_start_time => Time
- #post_pass_end_time => Time
- #ground_station => String
- #contact_status => String
- #error_message => String
- #maximum_elevation => Types::Elevation
- #tags => Hash<String,String>
- #region => String
- #dataflow_list => Array<Types::DataflowDetail>
- #visibility_start_time => Time
- #visibility_end_time => Time
- #tracking_overrides => Types::TrackingOverrides
- #ephemeris => Types::EphemerisResponseData
- #version => Types::ContactVersion



158
159
160

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

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