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.
444 445 446 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 444 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.
513 514 515 516 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 513 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.
565 566 567 568 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 565 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.
608 609 610 611 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 608 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.
651 652 653 654 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 651 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.
736 737 738 739 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 736 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.
803 804 805 806 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 803 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.
885 886 887 888 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 885 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.
973 974 975 976 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 973 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.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1055 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.
1149 1150 1151 1152 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1149 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.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1468 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
.
1690 1691 1692 1693 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1690 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.
1786 1787 1788 1789 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1786 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.
1853 1854 1855 1856 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1853 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.
1915 1916 1917 1918 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1915 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.
2062 2063 2064 2065 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2062 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.
2124 2125 2126 2127 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2124 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.
2155 2156 2157 2158 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2155 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.
2213 2214 2215 2216 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2213 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.
2293 2294 2295 2296 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2293 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.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2370 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.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2399 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.
2420 2421 2422 2423 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2420 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.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2457 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.
2486 2487 2488 2489 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2486 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.
2553 2554 2555 2556 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2553 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.
2596 2597 2598 2599 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2596 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.
2630 2631 2632 2633 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2630 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
2743 2744 2745 2746 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2743 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.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2837 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
3006 3007 3008 3009 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3006 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.
3133 3134 3135 3136 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3133 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.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3271 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.
3328 3329 3330 3331 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3328 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.
3368 3369 3370 3371 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3368 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.
3398 3399 3400 3401 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3398 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.
3440 3441 3442 3443 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3440 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.
3490 3491 3492 3493 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3490 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.
3507 3508 3509 3510 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3507 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
3571 3572 3573 3574 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3571 def describe_portal(params = {}, = {}) req = build_request(:describe_portal, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
3609 3610 3611 3612 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3609 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.
3646 3647 3648 3649 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3646 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.
3723 3724 3725 3726 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3723 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.
3788 3789 3790 3791 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3788 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.
3840 3841 3842 3843 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3840 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.
3884 3885 3886 3887 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3884 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.
3933 3934 3935 3936 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3933 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.
4043 4044 4045 4046 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4043 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.
4105 4106 4107 4108 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4105 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.
4206 4207 4208 4209 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4206 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.
4376 4377 4378 4379 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4376 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.
4455 4456 4457 4458 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4455 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.
4500 4501 4502 4503 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4500 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.
4567 4568 4569 4570 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4567 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.
4672 4673 4674 4675 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4672 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.
4746 4747 4748 4749 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4746 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.
4817 4818 4819 4820 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4817 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.
4879 4880 4881 4882 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4879 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.
4973 4974 4975 4976 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4973 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.
5075 5076 5077 5078 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5075 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.
5123 5124 5125 5126 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5123 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.
5174 5175 5176 5177 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5174 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.
5220 5221 5222 5223 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5220 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.
5266 5267 5268 5269 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5266 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.
5312 5313 5314 5315 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5312 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.
5354 5355 5356 5357 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5354 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.
5400 5401 5402 5403 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5400 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.
5431 5432 5433 5434 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5431 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.
5500 5501 5502 5503 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5500 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.
5543 5544 5545 5546 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5543 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.