Class: Aws::IoTSiteWise::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTSiteWise::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb
Overview
An API client for IoTSiteWise. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTSiteWise::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_assets(params = {}) ⇒ Struct
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
-
#associate_time_series_to_asset_property(params = {}) ⇒ Struct
Associates a time series (data stream) with an asset property.
-
#batch_associate_project_assets(params = {}) ⇒ Types::BatchAssociateProjectAssetsResponse
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
-
#batch_disassociate_project_assets(params = {}) ⇒ Types::BatchDisassociateProjectAssetsResponse
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
-
#batch_get_asset_property_aggregates(params = {}) ⇒ Types::BatchGetAssetPropertyAggregatesResponse
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
-
#batch_get_asset_property_value(params = {}) ⇒ Types::BatchGetAssetPropertyValueResponse
Gets the current value for one or more asset properties.
-
#batch_get_asset_property_value_history(params = {}) ⇒ Types::BatchGetAssetPropertyValueHistoryResponse
Gets the historical values for one or more asset properties.
-
#batch_put_asset_property_value(params = {}) ⇒ Types::BatchPutAssetPropertyValueResponse
Sends a list of asset property values to IoT SiteWise.
-
#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse
Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
-
#create_asset(params = {}) ⇒ Types::CreateAssetResponse
Creates an asset from an existing asset model.
-
#create_asset_model(params = {}) ⇒ Types::CreateAssetModelResponse
Creates an asset model from specified property and hierarchy definitions.
-
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard in an IoT SiteWise Monitor project.
-
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.
-
#create_portal(params = {}) ⇒ Types::CreatePortalResponse
Creates a portal, which can contain projects and dashboards.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a project in the specified portal.
-
#delete_access_policy(params = {}) ⇒ Struct
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
-
#delete_asset(params = {}) ⇒ Types::DeleteAssetResponse
Deletes an asset.
-
#delete_asset_model(params = {}) ⇒ Types::DeleteAssetModelResponse
Deletes an asset model.
-
#delete_dashboard(params = {}) ⇒ Struct
Deletes a dashboard from IoT SiteWise Monitor.
-
#delete_gateway(params = {}) ⇒ Struct
Deletes a gateway from IoT SiteWise.
-
#delete_portal(params = {}) ⇒ Types::DeletePortalResponse
Deletes a portal from IoT SiteWise Monitor.
-
#delete_project(params = {}) ⇒ Struct
Deletes a project from IoT SiteWise Monitor.
-
#delete_time_series(params = {}) ⇒ Struct
Deletes a time series (data stream).
-
#describe_access_policy(params = {}) ⇒ Types::DescribeAccessPolicyResponse
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
-
#describe_asset(params = {}) ⇒ Types::DescribeAssetResponse
Retrieves information about an asset.
-
#describe_asset_model(params = {}) ⇒ Types::DescribeAssetModelResponse
Retrieves information about an asset model.
-
#describe_asset_property(params = {}) ⇒ Types::DescribeAssetPropertyResponse
Retrieves information about an asset property.
-
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Retrieves information about a dashboard.
-
#describe_default_encryption_configuration(params = {}) ⇒ Types::DescribeDefaultEncryptionConfigurationResponse
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
-
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Retrieves information about a gateway.
-
#describe_gateway_capability_configuration(params = {}) ⇒ Types::DescribeGatewayCapabilityConfigurationResponse
Retrieves information about a gateway capability configuration.
-
#describe_logging_options(params = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current IoT SiteWise logging options.
-
#describe_portal(params = {}) ⇒ Types::DescribePortalResponse
Retrieves information about a portal.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
-
#describe_storage_configuration(params = {}) ⇒ Types::DescribeStorageConfigurationResponse
Retrieves information about the storage configuration for IoT SiteWise.
-
#describe_time_series(params = {}) ⇒ Types::DescribeTimeSeriesResponse
Retrieves information about a time series (data stream).
-
#disassociate_assets(params = {}) ⇒ Struct
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
-
#disassociate_time_series_from_asset_property(params = {}) ⇒ Struct
Disassociates a time series (data stream) from an asset property.
-
#get_asset_property_aggregates(params = {}) ⇒ Types::GetAssetPropertyAggregatesResponse
Gets aggregated values for an asset property.
-
#get_asset_property_value(params = {}) ⇒ Types::GetAssetPropertyValueResponse
Gets an asset property's current value.
-
#get_asset_property_value_history(params = {}) ⇒ Types::GetAssetPropertyValueHistoryResponse
Gets the history of an asset property's values.
-
#get_interpolated_asset_property_values(params = {}) ⇒ Types::GetInterpolatedAssetPropertyValuesResponse
Get interpolated values for an asset property for a specified time interval, during a period of time.
-
#list_access_policies(params = {}) ⇒ Types::ListAccessPoliciesResponse
Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
-
#list_asset_models(params = {}) ⇒ Types::ListAssetModelsResponse
Retrieves a paginated list of summaries of all asset models.
-
#list_asset_relationships(params = {}) ⇒ Types::ListAssetRelationshipsResponse
Retrieves a paginated list of asset relationships for an asset.
-
#list_assets(params = {}) ⇒ Types::ListAssetsResponse
Retrieves a paginated list of asset summaries.
-
#list_associated_assets(params = {}) ⇒ Types::ListAssociatedAssetsResponse
Retrieves a paginated list of associated assets.
-
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
-
#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse
Retrieves a paginated list of gateways.
-
#list_portals(params = {}) ⇒ Types::ListPortalsResponse
Retrieves a paginated list of IoT SiteWise Monitor portals.
-
#list_project_assets(params = {}) ⇒ Types::ListProjectAssetsResponse
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for an IoT SiteWise resource.
-
#list_time_series(params = {}) ⇒ Types::ListTimeSeriesResponse
Retrieves a paginated list of time series (data streams).
-
#put_default_encryption_configuration(params = {}) ⇒ Types::PutDefaultEncryptionConfigurationResponse
Sets the default encryption configuration for the Amazon Web Services account.
-
#put_logging_options(params = {}) ⇒ Struct
Sets logging options for IoT SiteWise.
-
#put_storage_configuration(params = {}) ⇒ Types::PutStorageConfigurationResponse
Configures storage settings for IoT SiteWise.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to an IoT SiteWise resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from an IoT SiteWise resource.
-
#update_access_policy(params = {}) ⇒ Struct
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
-
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
Updates an asset's name.
-
#update_asset_model(params = {}) ⇒ Types::UpdateAssetModelResponse
Updates an asset model and all of the assets that were created from the model.
-
#update_asset_property(params = {}) ⇒ Struct
Updates an asset property's alias and notification state.
-
#update_dashboard(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor dashboard.
-
#update_gateway(params = {}) ⇒ Struct
Updates a gateway's name.
-
#update_gateway_capability_configuration(params = {}) ⇒ Types::UpdateGatewayCapabilityConfigurationResponse
Updates a gateway capability configuration or defines a new capability configuration.
-
#update_portal(params = {}) ⇒ Types::UpdatePortalResponse
Updates an IoT SiteWise Monitor portal.
-
#update_project(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor project.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#associate_assets(params = {}) ⇒ Struct
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
399 400 401 402 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 399 def associate_assets(params = {}, = {}) req = build_request(:associate_assets, params) req.send_request() end |
#associate_time_series_to_asset_property(params = {}) ⇒ Struct
Associates a time series (data stream) with an asset property.
436 437 438 439 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 436 def associate_time_series_to_asset_property(params = {}, = {}) req = build_request(:associate_time_series_to_asset_property, params) req.send_request() end |
#batch_associate_project_assets(params = {}) ⇒ Types::BatchAssociateProjectAssetsResponse
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
479 480 481 482 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 479 def batch_associate_project_assets(params = {}, = {}) req = build_request(:batch_associate_project_assets, params) req.send_request() end |
#batch_disassociate_project_assets(params = {}) ⇒ Types::BatchDisassociateProjectAssetsResponse
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
522 523 524 525 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 522 def batch_disassociate_project_assets(params = {}, = {}) req = build_request(:batch_disassociate_project_assets, params) req.send_request() end |
#batch_get_asset_property_aggregates(params = {}) ⇒ Types::BatchGetAssetPropertyAggregatesResponse
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
607 608 609 610 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 607 def batch_get_asset_property_aggregates(params = {}, = {}) req = build_request(:batch_get_asset_property_aggregates, params) req.send_request() end |
#batch_get_asset_property_value(params = {}) ⇒ Types::BatchGetAssetPropertyValueResponse
Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
674 675 676 677 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 674 def batch_get_asset_property_value(params = {}, = {}) req = build_request(:batch_get_asset_property_value, params) req.send_request() end |
#batch_get_asset_property_value_history(params = {}) ⇒ Types::BatchGetAssetPropertyValueHistoryResponse
Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
756 757 758 759 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 756 def batch_get_asset_property_value_history(params = {}, = {}) req = build_request(:batch_get_asset_property_value_history, params) req.send_request() end |
#batch_put_asset_property_value(params = {}) ⇒ Types::BatchPutAssetPropertyValueResponse
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
of an asset property.A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that
have a timestamp of no more than 7 days in the past and no more than
10 minutes in the future. IoT SiteWise rejects timestamps outside of
the inclusive range of [-7 days, +10 minutes] and returns a
TimestampOutOfRangeException
error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate
timestamps unless the newer TQV has a different quality. For example,
if you store a TQV \{T1, GOOD, V1\}
, then storing \{T1, GOOD, V2\}
replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue
entry individually. For more information, see
BatchPutAssetPropertyValue authorization in the IoT SiteWise
User Guide.
844 845 846 847 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 844 def batch_put_asset_property_value(params = {}, = {}) req = build_request(:batch_put_asset_property_value, params) req.send_request() end |
#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse
Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
927 928 929 930 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 927 def create_access_policy(params = {}, = {}) req = build_request(:create_access_policy, params) req.send_request() end |
#create_asset(params = {}) ⇒ Types::CreateAssetResponse
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
996 997 998 999 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 996 def create_asset(params = {}, = {}) req = build_request(:create_asset, params) req.send_request() end |
#create_asset_model(params = {}) ⇒ Types::CreateAssetModelResponse
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1229 def create_asset_model(params = {}, = {}) req = build_request(:create_asset_model, params) req.send_request() end |
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard in an IoT SiteWise Monitor project.
1296 1297 1298 1299 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1296 def create_dashboard(params = {}, = {}) req = build_request(:create_dashboard, params) req.send_request() end |
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
1355 1356 1357 1358 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1355 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#create_portal(params = {}) ⇒ Types::CreatePortalResponse
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1503 def create_portal(params = {}, = {}) req = build_request(:create_portal, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a project in the specified portal.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1565 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#delete_access_policy(params = {}) ⇒ Struct
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1596 def delete_access_policy(params = {}, = {}) req = build_request(:delete_access_policy, params) req.send_request() end |
#delete_asset(params = {}) ⇒ Types::DeleteAssetResponse
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1647 def delete_asset(params = {}, = {}) req = build_request(:delete_asset, params) req.send_request() end |
#delete_asset_model(params = {}) ⇒ Types::DeleteAssetModelResponse
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
1696 1697 1698 1699 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1696 def delete_asset_model(params = {}, = {}) req = build_request(:delete_asset_model, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Struct
Deletes a dashboard from IoT SiteWise Monitor.
1725 1726 1727 1728 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1725 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Struct
Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1746 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_portal(params = {}) ⇒ Types::DeletePortalResponse
Deletes a portal from IoT SiteWise Monitor.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1783 def delete_portal(params = {}, = {}) req = build_request(:delete_portal, params) req.send_request() end |
#delete_project(params = {}) ⇒ Struct
Deletes a project from IoT SiteWise Monitor.
1812 1813 1814 1815 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1812 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_time_series(params = {}) ⇒ Struct
Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the
alias
of the time series.If the time series is associated with an asset property, specify one of the following:
The
alias
of the time series.The
assetId
andpropertyId
that identifies the asset property.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1864 def delete_time_series(params = {}, = {}) req = build_request(:delete_time_series, params) req.send_request() end |
#describe_access_policy(params = {}) ⇒ Types::DescribeAccessPolicyResponse
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1907 def describe_access_policy(params = {}, = {}) req = build_request(:describe_access_policy, params) req.send_request() end |
#describe_asset(params = {}) ⇒ Types::DescribeAssetResponse
Retrieves information about an asset.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- asset_active
- asset_not_exists
1986 1987 1988 1989 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1986 def describe_asset(params = {}, = {}) req = build_request(:describe_asset, params) req.send_request() end |
#describe_asset_model(params = {}) ⇒ Types::DescribeAssetModelResponse
Retrieves information about an asset model.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- asset_model_active
- asset_model_not_exists
2092 2093 2094 2095 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2092 def describe_asset_model(params = {}, = {}) req = build_request(:describe_asset_model, params) req.send_request() end |
#describe_asset_property(params = {}) ⇒ Types::DescribeAssetPropertyResponse
Retrieves information about an asset property.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2192 def describe_asset_property(params = {}, = {}) req = build_request(:describe_asset_property, params) req.send_request() end |
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Retrieves information about a dashboard.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2232 def describe_dashboard(params = {}, = {}) req = build_request(:describe_dashboard, params) req.send_request() end |
#describe_default_encryption_configuration(params = {}) ⇒ Types::DescribeDefaultEncryptionConfigurationResponse
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2262 def describe_default_encryption_configuration(params = {}, = {}) req = build_request(:describe_default_encryption_configuration, params) req.send_request() end |
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Retrieves information about a gateway.
2303 2304 2305 2306 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2303 def describe_gateway(params = {}, = {}) req = build_request(:describe_gateway, params) req.send_request() end |
#describe_gateway_capability_configuration(params = {}) ⇒ Types::DescribeGatewayCapabilityConfigurationResponse
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
2353 2354 2355 2356 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2353 def describe_gateway_capability_configuration(params = {}, = {}) req = build_request(:describe_gateway_capability_configuration, params) req.send_request() end |
#describe_logging_options(params = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current IoT SiteWise logging options.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2370 def (params = {}, = {}) req = build_request(:describe_logging_options, params) req.send_request() end |
#describe_portal(params = {}) ⇒ Types::DescribePortalResponse
Retrieves information about a portal.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- portal_active
- portal_not_exists
2434 2435 2436 2437 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2434 def describe_portal(params = {}, = {}) req = build_request(:describe_portal, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
2472 2473 2474 2475 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2472 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#describe_storage_configuration(params = {}) ⇒ Types::DescribeStorageConfigurationResponse
Retrieves information about the storage configuration for IoT SiteWise.
2504 2505 2506 2507 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2504 def describe_storage_configuration(params = {}, = {}) req = build_request(:describe_storage_configuration, params) req.send_request() end |
#describe_time_series(params = {}) ⇒ Types::DescribeTimeSeriesResponse
Retrieves information about a time series (data stream).
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the
alias
of the time series.If the time series is associated with an asset property, specify one of the following:
The
alias
of the time series.The
assetId
andpropertyId
that identifies the asset property.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2564 def describe_time_series(params = {}, = {}) req = build_request(:describe_time_series, params) req.send_request() end |
#disassociate_assets(params = {}) ⇒ Struct
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
2610 2611 2612 2613 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2610 def disassociate_assets(params = {}, = {}) req = build_request(:disassociate_assets, params) req.send_request() end |
#disassociate_time_series_from_asset_property(params = {}) ⇒ Struct
Disassociates a time series (data stream) from an asset property.
2647 2648 2649 2650 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2647 def disassociate_time_series_from_asset_property(params = {}, = {}) req = build_request(:disassociate_time_series_from_asset_property, params) req.send_request() end |
#get_asset_property_aggregates(params = {}) ⇒ Types::GetAssetPropertyAggregatesResponse
Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
of an asset property.A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2753 2754 2755 2756 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2753 def get_asset_property_aggregates(params = {}, = {}) req = build_request(:get_asset_property_aggregates, params) req.send_request() end |
#get_asset_property_value(params = {}) ⇒ Types::GetAssetPropertyValueResponse
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
of an asset property.A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
2815 2816 2817 2818 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2815 def get_asset_property_value(params = {}, = {}) req = build_request(:get_asset_property_value, params) req.send_request() end |
#get_asset_property_value_history(params = {}) ⇒ Types::GetAssetPropertyValueHistoryResponse
Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
of an asset property.A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2912 2913 2914 2915 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2912 def get_asset_property_value_history(params = {}, = {}) req = build_request(:get_asset_property_value_history, params) req.send_request() end |
#get_interpolated_asset_property_values(params = {}) ⇒ Types::GetInterpolatedAssetPropertyValuesResponse
Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
of an asset property.A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3082 3083 3084 3085 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3082 def get_interpolated_asset_property_values(params = {}, = {}) req = build_request(:get_interpolated_asset_property_values, params) req.send_request() end |
#list_access_policies(params = {}) ⇒ Types::ListAccessPoliciesResponse
Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3161 3162 3163 3164 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3161 def list_access_policies(params = {}, = {}) req = build_request(:list_access_policies, params) req.send_request() end |
#list_asset_models(params = {}) ⇒ Types::ListAssetModelsResponse
Retrieves a paginated list of summaries of all asset models.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3209 3210 3211 3212 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3209 def list_asset_models(params = {}, = {}) req = build_request(:list_asset_models, params) req.send_request() end |
#list_asset_relationships(params = {}) ⇒ Types::ListAssetRelationshipsResponse
Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3264 3265 3266 3267 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3264 def list_asset_relationships(params = {}, = {}) req = build_request(:list_asset_relationships, params) req.send_request() end |
#list_assets(params = {}) ⇒ Types::ListAssetsResponse
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3349 3350 3351 3352 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3349 def list_assets(params = {}, = {}) req = build_request(:list_assets, params) req.send_request() end |
#list_associated_assets(params = {}) ⇒ Types::ListAssociatedAssetsResponse
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
List child assets associated to a parent asset by a hierarchy that you specify.
List an asset's parent asset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3441 3442 3443 3444 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3441 def list_associated_assets(params = {}, = {}) req = build_request(:list_associated_assets, params) req.send_request() end |
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3487 3488 3489 3490 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3487 def list_dashboards(params = {}, = {}) req = build_request(:list_dashboards, params) req.send_request() end |
#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse
Retrieves a paginated list of gateways.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3532 3533 3534 3535 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3532 def list_gateways(params = {}, = {}) req = build_request(:list_gateways, params) req.send_request() end |
#list_portals(params = {}) ⇒ Types::ListPortalsResponse
Retrieves a paginated list of IoT SiteWise Monitor portals.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3578 3579 3580 3581 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3578 def list_portals(params = {}, = {}) req = build_request(:list_portals, params) req.send_request() end |
#list_project_assets(params = {}) ⇒ Types::ListProjectAssetsResponse
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3620 3621 3622 3623 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3620 def list_project_assets(params = {}, = {}) req = build_request(:list_project_assets, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3666 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for an IoT SiteWise resource.
3697 3698 3699 3700 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3697 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_time_series(params = {}) ⇒ Types::ListTimeSeriesResponse
Retrieves a paginated list of time series (data streams).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3757 3758 3759 3760 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3757 def list_time_series(params = {}, = {}) req = build_request(:list_time_series, params) req.send_request() end |
#put_default_encryption_configuration(params = {}) ⇒ Types::PutDefaultEncryptionConfigurationResponse
Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
3800 3801 3802 3803 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3800 def put_default_encryption_configuration(params = {}, = {}) req = build_request(:put_default_encryption_configuration, params) req.send_request() end |
#put_logging_options(params = {}) ⇒ Struct
Sets logging options for IoT SiteWise.
3822 3823 3824 3825 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3822 def (params = {}, = {}) req = build_request(:put_logging_options, params) req.send_request() end |
#put_storage_configuration(params = {}) ⇒ Types::PutStorageConfigurationResponse
Configures storage settings for IoT SiteWise.
3909 3910 3911 3912 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3909 def put_storage_configuration(params = {}, = {}) req = build_request(:put_storage_configuration, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
3946 3947 3948 3949 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3946 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from an IoT SiteWise resource.
3974 3975 3976 3977 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3974 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_policy(params = {}) ⇒ Struct
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
4039 4040 4041 4042 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4039 def update_access_policy(params = {}, = {}) req = build_request(:update_access_policy, params) req.send_request() end |
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
4092 4093 4094 4095 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4092 def update_asset(params = {}, = {}) req = build_request(:update_asset, params) req.send_request() end |
#update_asset_model(params = {}) ⇒ Types::UpdateAssetModelResponse
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
4329 4330 4331 4332 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4329 def update_asset_model(params = {}, = {}) req = build_request(:update_asset_model, params) req.send_request() end |
#update_asset_property(params = {}) ⇒ Struct
Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
4401 4402 4403 4404 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4401 def update_asset_property(params = {}, = {}) req = build_request(:update_asset_property, params) req.send_request() end |
#update_dashboard(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor dashboard.
4448 4449 4450 4451 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4448 def update_dashboard(params = {}, = {}) req = build_request(:update_dashboard, params) req.send_request() end |
#update_gateway(params = {}) ⇒ Struct
Updates a gateway's name.
4472 4473 4474 4475 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4472 def update_gateway(params = {}, = {}) req = build_request(:update_gateway, params) req.send_request() end |
#update_gateway_capability_configuration(params = {}) ⇒ Types::UpdateGatewayCapabilityConfigurationResponse
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
4528 4529 4530 4531 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4528 def update_gateway_capability_configuration(params = {}, = {}) req = build_request(:update_gateway_capability_configuration, params) req.send_request() end |
#update_portal(params = {}) ⇒ Types::UpdatePortalResponse
Updates an IoT SiteWise Monitor portal.
4623 4624 4625 4626 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4623 def update_portal(params = {}, = {}) req = build_request(:update_portal, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor project.
4660 4661 4662 4663 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4660 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
asset_active | #describe_asset | 3 | 20 |
asset_model_active | #describe_asset_model | 3 | 20 |
asset_model_not_exists | #describe_asset_model | 3 | 20 |
asset_not_exists | #describe_asset | 3 | 20 |
portal_active | #describe_portal | 3 | 20 |
portal_not_exists | #describe_portal | 3 | 20 |
4775 4776 4777 4778 4779 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4775 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |