Class: Aws::IoTSiteWise::Waiters::AssetActive

Inherits:

Object

Object
Aws::IoTSiteWise::Waiters::AssetActive

show all

Defined in:: sig/waiters.rbs,
lib/aws-sdk-iotsitewise/waiters.rb

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ AssetActive constructor
A new instance of AssetActive.
#wait(params = {}) ⇒ Types::DescribeAssetResponse
Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ `AssetActive`

Returns a new instance of AssetActive.

Parameters:

options (Hash)

Options Hash (options):

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



89
90

# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 89

def initialize: (?client: Client, ?max_attempts: Integer, ?delay: Integer, ?before_attempt: Proc, ?before_wait: Proc) -> void
| (?Hash[Symbol, untyped]) -> void

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.



121
122
123

# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 121

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#asset_id => String
#asset_external_id => String
#asset_arn => String
#asset_name => String
#asset_model_id => String
#asset_properties => Array<Types::AssetProperty>
#asset_hierarchies => Array<Types::AssetHierarchy>
#asset_composite_models => Array<Types::AssetCompositeModel>
#asset_creation_date => Time
#asset_last_update_date => Time
#asset_status => Types::AssetStatus
#asset_description => String
#asset_composite_model_summaries => Array<Types::AssetCompositeModelSummary>

Options Hash (params):

:asset_id (required, String) —
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
:exclude_properties (Boolean) —
Whether or not to exclude asset properties from the response.

Returns:

(Types::DescribeAssetResponse) —
Returns a response object which responds to the following methods:
- #asset_id => String
- #asset_external_id => String
- #asset_arn => String
- #asset_name => String
- #asset_model_id => String
- #asset_properties => Array<Types::AssetProperty>
- #asset_hierarchies => Array<Types::AssetHierarchy>
- #asset_composite_models => Array<Types::AssetCompositeModel>
- #asset_creation_date => Time
- #asset_last_update_date => Time
- #asset_status => Types::AssetStatus
- #asset_description => String
- #asset_composite_model_summaries => Array<Types::AssetCompositeModelSummary>

116	# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 116 def wait: (