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_computation_model(params = {}) ⇒ Types::CreateComputationModelResponse
Create a computation model with a configuration and data binding.
-
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard in an IoT SiteWise Monitor project.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a dataset to connect an external datasource.
-
#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_computation_model(params = {}) ⇒ Types::DeleteComputationModelResponse
Deletes a computation model.
-
#delete_dashboard(params = {}) ⇒ Struct
Deletes a dashboard from IoT SiteWise Monitor.
-
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset.
-
#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_computation_model(params = {}) ⇒ Types::DescribeComputationModelResponse
Retrieves information about a computation model.
-
#describe_computation_model_execution_summary(params = {}) ⇒ Types::DescribeComputationModelExecutionSummaryResponse
Retrieves information about the execution summary of a computation model.
-
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Retrieves information about a dashboard.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
-
#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_execution(params = {}) ⇒ Types::DescribeExecutionResponse
Retrieves information about the execution.
-
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Retrieves information about a gateway.
-
#describe_gateway_capability_configuration(params = {}) ⇒ Types::DescribeGatewayCapabilityConfigurationResponse
Each gateway capability defines data sources for a gateway.
-
#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.
-
#invoke_assistant(params = {}) ⇒ Types::InvokeAssistantResponse
Invokes SiteWise Assistant to start or continue a conversation.
-
#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_computation_model_data_binding_usages(params = {}) ⇒ Types::ListComputationModelDataBindingUsagesResponse
Lists all data binding usages for computation models.
-
#list_computation_model_resolve_to_resources(params = {}) ⇒ Types::ListComputationModelResolveToResourcesResponse
Lists all distinct resources that are resolved from the executed actions of the computation model.
-
#list_computation_models(params = {}) ⇒ Types::ListComputationModelsResponse
Retrieves a paginated list of summaries of all computation models.
-
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves a paginated list of datasets for a specific target resource.
-
#list_executions(params = {}) ⇒ Types::ListExecutionsResponse
Retrieves a paginated list of summaries of all executions.
-
#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_computation_model(params = {}) ⇒ Types::UpdateComputationModelResponse
Updates the computation model.
-
#update_dashboard(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor dashboard.
-
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a dataset.
-
#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.
487 488 489 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 487 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.
556 557 558 559 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 556 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.
608 609 610 611 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 608 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.
651 652 653 654 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 651 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.
694 695 696 697 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 694 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.
779 780 781 782 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 779 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.
847 848 849 850 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 847 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.
930 931 932 933 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 930 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.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1028 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.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1110 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.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1204 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1523 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
.
1745 1746 1747 1748 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1745 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.
Newly ingested data in the hot tier triggers notifications and computations.
After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.
Data older than 7 days does not trigger computations or notifications.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1849 def create_bulk_import_job(params = {}, = {}) req = build_request(:create_bulk_import_job, params) req.send_request() end |
#create_computation_model(params = {}) ⇒ Types::CreateComputationModelResponse
Create a computation model with a configuration and data binding.
1940 1941 1942 1943 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1940 def create_computation_model(params = {}, = {}) req = build_request(:create_computation_model, params) req.send_request() end |
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard in an IoT SiteWise Monitor project.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2012 def create_dashboard(params = {}, = {}) req = build_request(:create_dashboard, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a dataset to connect an external datasource.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2089 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, 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.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2174 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.
2337 2338 2339 2340 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2337 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.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2399 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.
2430 2431 2432 2433 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2430 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.
2488 2489 2490 2491 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2488 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.
2568 2569 2570 2571 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2568 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.
2645 2646 2647 2648 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2645 def delete_asset_model_composite_model(params = {}, = {}) req = build_request(:delete_asset_model_composite_model, params) req.send_request() end |
#delete_computation_model(params = {}) ⇒ Types::DeleteComputationModelResponse
Deletes a computation model. This action can't be undone.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2685 def delete_computation_model(params = {}, = {}) req = build_request(:delete_computation_model, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Struct
Deletes a dashboard from IoT SiteWise Monitor.
2714 2715 2716 2717 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2714 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset. This cannot be undone.
2754 2755 2756 2757 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2754 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, 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.
2775 2776 2777 2778 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2775 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.
2812 2813 2814 2815 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2812 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.
2841 2842 2843 2844 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2841 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.
2908 2909 2910 2911 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2908 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.
2951 2952 2953 2954 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2951 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.
2988 2989 2990 2991 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2988 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
3101 3102 3103 3104 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3101 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.
3195 3196 3197 3198 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3195 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
3364 3365 3366 3367 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3364 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.
3491 3492 3493 3494 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3491 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.
3629 3630 3631 3632 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3629 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.
3686 3687 3688 3689 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3686 def describe_bulk_import_job(params = {}, = {}) req = build_request(:describe_bulk_import_job, params) req.send_request() end |
#describe_computation_model(params = {}) ⇒ Types::DescribeComputationModelResponse
Retrieves information about a computation model.
3747 3748 3749 3750 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3747 def describe_computation_model(params = {}, = {}) req = build_request(:describe_computation_model, params) req.send_request() end |
#describe_computation_model_execution_summary(params = {}) ⇒ Types::DescribeComputationModelExecutionSummaryResponse
Retrieves information about the execution summary of a computation model.
3787 3788 3789 3790 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3787 def describe_computation_model_execution_summary(params = {}, = {}) req = build_request(:describe_computation_model_execution_summary, params) req.send_request() end |
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Retrieves information about a dashboard.
3827 3828 3829 3830 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3827 def describe_dashboard(params = {}, = {}) req = build_request(:describe_dashboard, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
3877 3878 3879 3880 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3877 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, 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.
3907 3908 3909 3910 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3907 def describe_default_encryption_configuration(params = {}, = {}) req = build_request(:describe_default_encryption_configuration, params) req.send_request() end |
#describe_execution(params = {}) ⇒ Types::DescribeExecutionResponse
Retrieves information about the execution.
3956 3957 3958 3959 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3956 def describe_execution(params = {}, = {}) req = build_request(:describe_execution, params) req.send_request() end |
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Retrieves information about a gateway.
4001 4002 4003 4004 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4001 def describe_gateway(params = {}, = {}) req = build_request(:describe_gateway, params) req.send_request() end |
#describe_gateway_capability_configuration(params = {}) ⇒ Types::DescribeGatewayCapabilityConfigurationResponse
Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.
. The namespace follows the format service:capability:version
,
where:
service
- The service providing the capability, oriotsitewise
.capability
- The specific capability type. Options include:opcuacollector
for the OPC UA data source collector, orpublisher
for data publisher capability.version
- The version number of the capability. Option include2
for Classic streams, V2 gateways, and3
for MQTT-enabled, V3 gateways.
After updating a capability configuration, the sync status becomes
OUT_OF_SYNC
until the gateway processes the configuration.Use
DescribeGatewayCapabilityConfiguration
to check the sync status and
verify the configuration was applied.
A gateway can have multiple capability configurations with different namespaces.
4062 4063 4064 4065 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4062 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.
4079 4080 4081 4082 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4079 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
4149 4150 4151 4152 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4149 def describe_portal(params = {}, = {}) req = build_request(:describe_portal, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
4187 4188 4189 4190 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4187 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.
4226 4227 4228 4229 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4226 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.
4303 4304 4305 4306 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4303 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.
4368 4369 4370 4371 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4368 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.
4420 4421 4422 4423 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4420 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.
4471 4472 4473 4474 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4471 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.
4534 4535 4536 4537 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4534 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.
4644 4645 4646 4647 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4644 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.
4707 4708 4709 4710 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4707 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.
4809 4810 4811 4812 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4809 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.
4980 4981 4982 4983 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4980 def get_interpolated_asset_property_values(params = {}, = {}) req = build_request(:get_interpolated_asset_property_values, params) req.send_request() end |
#invoke_assistant(params = {}) ⇒ Types::InvokeAssistantResponse
Invokes SiteWise Assistant to start or continue a conversation.
5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5219 def invoke_assistant(params = {}, = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::ResponseStream then handler when Proc then EventStreams::ResponseStream.new.tap(&handler) when nil then EventStreams::ResponseStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::IoTSiteWise::EventStreams::ResponseStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:invoke_assistant, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(, &block) 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.
5316 5317 5318 5319 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5316 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.
5371 5372 5373 5374 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5371 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.
5438 5439 5440 5441 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5438 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.
5543 5544 5545 5546 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5543 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.
5617 5618 5619 5620 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5617 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.
5688 5689 5690 5691 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5688 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.
5750 5751 5752 5753 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5750 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.
5844 5845 5846 5847 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5844 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:
CHILD
- List all child assets associated to the asset.PARENT
- List the asset's parent asset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5946 5947 5948 5949 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5946 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.
5994 5995 5996 5997 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5994 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.
6045 6046 6047 6048 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6045 def list_composition_relationships(params = {}, = {}) req = build_request(:list_composition_relationships, params) req.send_request() end |
#list_computation_model_data_binding_usages(params = {}) ⇒ Types::ListComputationModelDataBindingUsagesResponse
Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6110 6111 6112 6113 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6110 def list_computation_model_data_binding_usages(params = {}, = {}) req = build_request(:list_computation_model_data_binding_usages, params) req.send_request() end |
#list_computation_model_resolve_to_resources(params = {}) ⇒ Types::ListComputationModelResolveToResourcesResponse
Lists all distinct resources that are resolved from the executed actions of the computation model.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6150 6151 6152 6153 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6150 def list_computation_model_resolve_to_resources(params = {}, = {}) req = build_request(:list_computation_model_resolve_to_resources, params) req.send_request() end |
#list_computation_models(params = {}) ⇒ Types::ListComputationModelsResponse
Retrieves a paginated list of summaries of all computation models.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6203 6204 6205 6206 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6203 def list_computation_models(params = {}, = {}) req = build_request(:list_computation_models, 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.
6249 6250 6251 6252 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6249 def list_dashboards(params = {}, = {}) req = build_request(:list_dashboards, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves a paginated list of datasets for a specific target resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6300 6301 6302 6303 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6300 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_executions(params = {}) ⇒ Types::ListExecutionsResponse
Retrieves a paginated list of summaries of all executions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6364 6365 6366 6367 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6364 def list_executions(params = {}, = {}) req = build_request(:list_executions, 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.
6412 6413 6414 6415 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6412 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.
6459 6460 6461 6462 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6459 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.
6501 6502 6503 6504 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6501 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.
6547 6548 6549 6550 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6547 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.
6578 6579 6580 6581 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6578 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.
6647 6648 6649 6650 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6647 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.
6690 6691 6692 6693 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6690 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.
6712 6713 6714 6715 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6712 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.
6827 6828 6829 6830 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6827 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.
6864 6865 6866 6867 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6864 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.
6892 6893 6894 6895 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6892 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.
6957 6958 6959 6960 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6957 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.
7028 7029 7030 7031 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7028 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.
If you remove a property from an 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 asset model property with a new one with the
same name
, do the following:
Submit an
UpdateAssetModel
request with the entire existing property removed.Submit a second
UpdateAssetModel
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
.
7362 7363 7364 7365 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7362 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
.
7564 7565 7566 7567 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7564 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.
7656 7657 7658 7659 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7656 def update_asset_property(params = {}, = {}) req = build_request(:update_asset_property, params) req.send_request() end |
#update_computation_model(params = {}) ⇒ Types::UpdateComputationModelResponse
Updates the computation model.
7735 7736 7737 7738 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7735 def update_computation_model(params = {}, = {}) req = build_request(:update_computation_model, params) req.send_request() end |
#update_dashboard(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor dashboard.
7787 7788 7789 7790 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7787 def update_dashboard(params = {}, = {}) req = build_request(:update_dashboard, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a dataset.
7852 7853 7854 7855 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7852 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_gateway(params = {}) ⇒ Struct
Updates a gateway's name.
7876 7877 7878 7879 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7876 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.
Important workflow notes:
Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.
. The namespace follows the format service:capability:version
,
where:
service
- The service providing the capability, oriotsitewise
.capability
- The specific capability type. Options include:opcuacollector
for the OPC UA data source collector, orpublisher
for data publisher capability.version
- The version number of the capability. Option include2
for Classic streams, V2 gateways, and3
for MQTT-enabled, V3 gateways.
After updating a capability configuration, the sync status becomes
OUT_OF_SYNC
until the gateway processes the configuration.Use
DescribeGatewayCapabilityConfiguration
to check the sync status and
verify the configuration was applied.
A gateway can have multiple capability configurations with different namespaces.
7949 7950 7951 7952 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7949 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.
8060 8061 8062 8063 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8060 def update_portal(params = {}, = {}) req = build_request(:update_portal, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
Updates an IoT SiteWise Monitor project.
8097 8098 8099 8100 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8097 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 |
8217 8218 8219 8220 8221 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8217 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |