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 (IAM Identity Center user, IAM Identity Center 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_asset_model_composite_model(params = {}) ⇒ Types::CreateAssetModelCompositeModelResponse
Creates a custom composite model from specified property and hierarchy definitions.
-
#create_bulk_import_job(params = {}) ⇒ Types::CreateBulkImportJobResponse
Defines a job to ingest data to IoT SiteWise from Amazon S3.
-
#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_asset_model_composite_model(params = {}) ⇒ Types::DeleteAssetModelCompositeModelResponse
Deletes a composite 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_action(params = {}) ⇒ Types::DescribeActionResponse
Retrieves information about an action.
-
#describe_asset(params = {}) ⇒ Types::DescribeAssetResponse
Retrieves information about an asset.
-
#describe_asset_composite_model(params = {}) ⇒ Types::DescribeAssetCompositeModelResponse
Retrieves information about an asset composite model (also known as an asset component).
-
#describe_asset_model(params = {}) ⇒ Types::DescribeAssetModelResponse
Retrieves information about an asset model.
-
#describe_asset_model_composite_model(params = {}) ⇒ Types::DescribeAssetModelCompositeModelResponse
Retrieves information about an asset model composite model (also known as an asset model component).
-
#describe_asset_property(params = {}) ⇒ Types::DescribeAssetPropertyResponse
Retrieves information about an asset property.
-
#describe_bulk_import_job(params = {}) ⇒ Types::DescribeBulkImportJobResponse
Retrieves information about a bulk import job request.
-
#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.
-
#execute_action(params = {}) ⇒ Types::ExecuteActionResponse
Executes an action on a target resource.
-
#execute_query(params = {}) ⇒ Types::ExecuteQueryResponse
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
-
#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 IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
-
#list_actions(params = {}) ⇒ Types::ListActionsResponse
Retrieves a paginated list of actions for a specific target resource.
-
#list_asset_model_composite_models(params = {}) ⇒ Types::ListAssetModelCompositeModelsResponse
Retrieves a paginated list of composite models associated with the asset model.
-
#list_asset_model_properties(params = {}) ⇒ Types::ListAssetModelPropertiesResponse
Retrieves a paginated list of properties associated with an asset model.
-
#list_asset_models(params = {}) ⇒ Types::ListAssetModelsResponse
Retrieves a paginated list of summaries of all asset models.
-
#list_asset_properties(params = {}) ⇒ Types::ListAssetPropertiesResponse
Retrieves a paginated list of properties associated with an asset.
-
#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_bulk_import_jobs(params = {}) ⇒ Types::ListBulkImportJobsResponse
Retrieves a paginated list of bulk import job requests.
-
#list_composition_relationships(params = {}) ⇒ Types::ListCompositionRelationshipsResponse
Retrieves a paginated list of composition relationships for an asset model of type
COMPONENT_MODEL
. -
#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_model_composite_model(params = {}) ⇒ Types::UpdateAssetModelCompositeModelResponse
Updates a composite 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.
410 411 412 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 410 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.
479 480 481 482 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 479 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.
531 532 533 534 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 531 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.
574 575 576 577 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 574 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.
617 618 619 620 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 617 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.
702 703 704 705 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 702 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.
769 770 771 772 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 769 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.
851 852 853 854 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 851 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.
939 940 941 942 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 939 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 (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1021 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.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1115 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.
You can create two types of asset models, ASSET_MODEL
or
COMPONENT_MODEL
.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
1432 1433 1434 1435 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1432 def create_asset_model(params = {}, = {}) req = build_request(:create_asset_model, params) req.send_request() end |
#create_asset_model_composite_model(params = {}) ⇒ Types::CreateAssetModelCompositeModelResponse
Creates a custom composite model from specified property and hierarchy
definitions. There are two types of custom composite models, inline
and component-model-based
.
Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.
To create a component-model-based model, specify the
composedAssetModelId
of an existing asset model with
assetModelType
of COMPONENT_MODEL
.
To create an inline model, specify the
assetModelCompositeModelProperties
and don't include an
composedAssetModelId
.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1627 def create_asset_model_composite_model(params = {}, = {}) req = build_request(:create_asset_model_composite_model, params) req.send_request() end |
#create_bulk_import_job(params = {}) ⇒ Types::CreateBulkImportJobResponse
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.
Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.
1723 1724 1725 1726 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1723 def create_bulk_import_job(params = {}, = {}) req = build_request(:create_bulk_import_job, params) req.send_request() end |
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard in an IoT SiteWise Monitor project.
1790 1791 1792 1793 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1790 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.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1849 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 IAM Identity Center or IAM to authenticate portal users and manage user permissions.
1996 1997 1998 1999 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1996 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.
2058 2059 2060 2061 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2058 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.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2089 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.
2147 2148 2149 2150 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2147 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.
2203 2204 2205 2206 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2203 def delete_asset_model(params = {}, = {}) req = build_request(:delete_asset_model, params) req.send_request() end |
#delete_asset_model_composite_model(params = {}) ⇒ Types::DeleteAssetModelCompositeModelResponse
Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite 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.
2256 2257 2258 2259 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2256 def delete_asset_model_composite_model(params = {}, = {}) req = build_request(:delete_asset_model_composite_model, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Struct
Deletes a dashboard from IoT SiteWise Monitor.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2285 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.
2306 2307 2308 2309 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2306 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2343 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.
2372 2373 2374 2375 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2372 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.
2439 2440 2441 2442 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2439 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.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2482 def describe_access_policy(params = {}, = {}) req = build_request(:describe_access_policy, params) req.send_request() end |
#describe_action(params = {}) ⇒ Types::DescribeActionResponse
Retrieves information about an action.
2516 2517 2518 2519 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2516 def describe_action(params = {}, = {}) req = build_request(:describe_action, 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
2629 2630 2631 2632 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2629 def describe_asset(params = {}, = {}) req = build_request(:describe_asset, params) req.send_request() end |
#describe_asset_composite_model(params = {}) ⇒ Types::DescribeAssetCompositeModelResponse
Retrieves information about an asset composite model (also known as an
asset component). An AssetCompositeModel
is an instance of an
AssetModelCompositeModel
. If you want to see information about the
model this is based on, call DescribeAssetModelCompositeModel.
2723 2724 2725 2726 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2723 def describe_asset_composite_model(params = {}, = {}) req = build_request(:describe_asset_composite_model, 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
2877 2878 2879 2880 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2877 def describe_asset_model(params = {}, = {}) req = build_request(:describe_asset_model, params) req.send_request() end |
#describe_asset_model_composite_model(params = {}) ⇒ Types::DescribeAssetModelCompositeModelResponse
Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2993 def describe_asset_model_composite_model(params = {}, = {}) req = build_request(:describe_asset_model_composite_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.
3131 3132 3133 3134 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3131 def describe_asset_property(params = {}, = {}) req = build_request(:describe_asset_property, params) req.send_request() end |
#describe_bulk_import_job(params = {}) ⇒ Types::DescribeBulkImportJobResponse
Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
3188 3189 3190 3191 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3188 def describe_bulk_import_job(params = {}, = {}) req = build_request(:describe_bulk_import_job, params) req.send_request() end |
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Retrieves information about a dashboard.
3228 3229 3230 3231 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3228 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.
3258 3259 3260 3261 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3258 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.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3299 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.
3349 3350 3351 3352 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3349 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.
3366 3367 3368 3369 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3366 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
3430 3431 3432 3433 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3430 def describe_portal(params = {}, = {}) req = build_request(:describe_portal, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
3468 3469 3470 3471 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3468 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.
3505 3506 3507 3508 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3505 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.
3582 3583 3584 3585 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3582 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.
3647 3648 3649 3650 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3647 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.
3699 3700 3701 3702 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3699 def disassociate_time_series_from_asset_property(params = {}, = {}) req = build_request(:disassociate_time_series_from_asset_property, params) req.send_request() end |
#execute_action(params = {}) ⇒ Types::ExecuteActionResponse
Executes an action on a target resource.
3743 3744 3745 3746 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3743 def execute_action(params = {}, = {}) req = build_request(:execute_action, params) req.send_request() end |
#execute_query(params = {}) ⇒ Types::ExecuteQueryResponse
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3792 3793 3794 3795 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3792 def execute_query(params = {}, = {}) req = build_request(:execute_query, 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.
3902 3903 3904 3905 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3902 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.
3964 3965 3966 3967 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3964 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.
4065 4066 4067 4068 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4065 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.
4235 4236 4237 4238 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4235 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 IAM Identity Center user, an IAM Identity Center 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.
4314 4315 4316 4317 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4314 def list_access_policies(params = {}, = {}) req = build_request(:list_access_policies, params) req.send_request() end |
#list_actions(params = {}) ⇒ Types::ListActionsResponse
Retrieves a paginated list of actions for a specific target resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4359 4360 4361 4362 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4359 def list_actions(params = {}, = {}) req = build_request(:list_actions, params) req.send_request() end |
#list_asset_model_composite_models(params = {}) ⇒ Types::ListAssetModelCompositeModelsResponse
Retrieves a paginated list of composite models associated with the asset model
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4415 4416 4417 4418 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4415 def list_asset_model_composite_models(params = {}, = {}) req = build_request(:list_asset_model_composite_models, params) req.send_request() end |
#list_asset_model_properties(params = {}) ⇒ Types::ListAssetModelPropertiesResponse
Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4509 4510 4511 4512 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4509 def list_asset_model_properties(params = {}, = {}) req = build_request(:list_asset_model_properties, 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.
4571 4572 4573 4574 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4571 def list_asset_models(params = {}, = {}) req = build_request(:list_asset_models, params) req.send_request() end |
#list_asset_properties(params = {}) ⇒ Types::ListAssetPropertiesResponse
Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4642 4643 4644 4645 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4642 def list_asset_properties(params = {}, = {}) req = build_request(:list_asset_properties, 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.
4704 4705 4706 4707 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4704 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.
4798 4799 4800 4801 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4798 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.
4903 4904 4905 4906 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4903 def list_associated_assets(params = {}, = {}) req = build_request(:list_associated_assets, params) req.send_request() end |
#list_bulk_import_jobs(params = {}) ⇒ Types::ListBulkImportJobsResponse
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4951 4952 4953 4954 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4951 def list_bulk_import_jobs(params = {}, = {}) req = build_request(:list_bulk_import_jobs, params) req.send_request() end |
#list_composition_relationships(params = {}) ⇒ Types::ListCompositionRelationshipsResponse
Retrieves a paginated list of composition relationships for an asset
model of type COMPONENT_MODEL
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5002 5003 5004 5005 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5002 def list_composition_relationships(params = {}, = {}) req = build_request(:list_composition_relationships, 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.
5048 5049 5050 5051 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5048 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.
5093 5094 5095 5096 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5093 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.
5139 5140 5141 5142 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5139 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.
5181 5182 5183 5184 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5181 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.
5227 5228 5229 5230 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5227 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.
5258 5259 5260 5261 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5258 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.
5327 5328 5329 5330 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5327 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.
5370 5371 5372 5373 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5370 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.
5392 5393 5394 5395 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5392 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.
5499 5500 5501 5502 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5499 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.
5536 5537 5538 5539 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5536 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.
5564 5565 5566 5567 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5564 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.
5629 5630 5631 5632 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5629 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.
5700 5701 5702 5703 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5700 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.
6007 6008 6009 6010 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6007 def update_asset_model(params = {}, = {}) req = build_request(:update_asset_model, params) req.send_request() end |
#update_asset_model_composite_model(params = {}) ⇒ Types::UpdateAssetModelCompositeModelResponse
Updates a composite 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.
If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing composite asset model property with a new one
with the same name
, do the following:
Submit an
UpdateAssetModelCompositeModel
request with the entire existing property removed.Submit a second
UpdateAssetModelCompositeModel
request that includes the new property. The new asset property will have the samename
as the previous one and IoT SiteWise will generate a new uniqueid
.
6183 6184 6185 6186 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6183 def update_asset_model_composite_model(params = {}, = {}) req = build_request(:update_asset_model_composite_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.
6275 6276 6277 6278 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6275 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.
6322 6323 6324 6325 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6322 def update_dashboard(params = {}, = {}) req = build_request(:update_dashboard, params) req.send_request() end |
#update_gateway(params = {}) ⇒ Struct
Updates a gateway's name.
6346 6347 6348 6349 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6346 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.
6402 6403 6404 6405 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6402 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.
6497 6498 6499 6500 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6497 def update_portal(params = {}, = {}) req = build_request(:update_portal, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor project.
6534 6535 6536 6537 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6534 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 |
6649 6650 6651 6652 6653 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6649 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |