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_data_segments_to_dataset(params = {}) ⇒ Types::BatchAssociateDataSegmentsToDatasetResponse
Associates a batch of data segments with a curated dataset.
-
#batch_associate_project_assets(params = {}) ⇒ Types::BatchAssociateProjectAssetsResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#batch_delete_dataset_data_segments(params = {}) ⇒ Types::BatchDeleteDatasetDataSegmentsResponse
Deletes a batch of data segments from a session dataset.
-
#batch_disassociate_data_segments_from_dataset(params = {}) ⇒ Types::BatchDisassociateDataSegmentsFromDatasetResponse
Disassociates a batch of data segments from a curated dataset.
-
#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.
-
#cancel_enrichment_job(params = {}) ⇒ Types::CancelEnrichmentJobResponse
Cancels a running or pending enrichment job.
-
#cancel_pipeline_execution(params = {}) ⇒ Types::CancelPipelineExecutionResponse
Cancels a pipeline execution in the specified workspace.
-
#cancel_query(params = {}) ⇒ Types::CancelQueryResponse
Cancels a running query.
-
#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a new application for the workspace and IdC application provided.
-
#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
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a dataset.
-
#create_dataset_export_job(params = {}) ⇒ Types::CreateDatasetExportJobResponse
Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3.
-
#create_enrichment_job(params = {}) ⇒ Types::CreateEnrichmentJobResponse
Creates an asynchronous enrichment job to analyze time-series sensor data.
-
#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_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates a new pipeline in the specified workspace.
-
#create_portal(params = {}) ⇒ Types::CreatePortalResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#create_task(params = {}) ⇒ Types::CreateTaskResponse
Creates a new task in the specified workspace.
-
#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse
Creates a workspace in IoT SiteWise.
-
#delete_access_policy(params = {}) ⇒ Struct
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
-
#delete_application(params = {}) ⇒ Struct
Deletes an application by ID.
-
#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_asset_model_interface_relationship(params = {}) ⇒ Types::DeleteAssetModelInterfaceRelationshipResponse
Deletes an interface relationship between an asset model and an interface asset 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_pipeline(params = {}) ⇒ Types::DeletePipelineResponse
Deletes a pipeline from the specified workspace.
-
#delete_portal(params = {}) ⇒ Types::DeletePortalResponse
Deletes a portal from IoT SiteWise Monitor.
-
#delete_project(params = {}) ⇒ Struct
Deletes a project from IoT SiteWise Monitor.
-
#delete_task(params = {}) ⇒ Types::DeleteTaskResponse
Deletes a task from the specified workspace.
-
#delete_time_series(params = {}) ⇒ Struct
Deletes a time series (data stream).
-
#delete_workspace(params = {}) ⇒ Types::DeleteWorkspaceResponse
Deletes a workspace.
-
#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_application(params = {}) ⇒ Types::DescribeApplicationResponse
Retrieves Application details based on the ID.
-
#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_model_interface_relationship(params = {}) ⇒ Types::DescribeAssetModelInterfaceRelationshipResponse
Retrieves information about an interface relationship between an asset model and an interface asset model.
-
#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_dataset_export_job(params = {}) ⇒ Types::DescribeDatasetExportJobResponse
Retrieves information about a dataset export job.
-
#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_enrichment_job(params = {}) ⇒ Types::DescribeEnrichmentJobResponse
Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.
-
#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_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves detailed information about a specific pipeline in a workspace.
-
#describe_pipeline_execution(params = {}) ⇒ Types::DescribePipelineExecutionResponse
Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node.
-
#describe_portal(params = {}) ⇒ Types::DescribePortalResponse
Retrieves information about a portal.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
-
#describe_query(params = {}) ⇒ Types::DescribeQueryResponse
Retrieves information about a query, including its status.
-
#describe_search(params = {}) ⇒ Types::DescribeSearchResponse
Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason.
-
#describe_storage_configuration(params = {}) ⇒ Types::DescribeStorageConfigurationResponse
Retrieves information about the storage configuration for IoT SiteWise.
-
#describe_task(params = {}) ⇒ Types::DescribeTaskResponse
Retrieves detailed information about a specific task in a workspace.
-
#describe_time_series(params = {}) ⇒ Types::DescribeTimeSeriesResponse
Retrieves information about a time series (data stream).
-
#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse
Retrieves information about a workspace.
-
#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_capture_data(params = {}) ⇒ Types::GetCaptureDataResponse
Retrieves video data for a specific time range.
-
#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.
-
#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse
Retrieves the paginated results of a query.
-
#get_search_results(params = {}) ⇒ Types::GetSearchResultsResponse
Retrieves the ranked results of a search, ordered by descending relevance score.
-
#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_applications(params = {}) ⇒ Types::ListApplicationsResponse
Retrieves a paginated list of existing applications.
-
#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_dataset_data_segment_relationships(params = {}) ⇒ Types::ListDatasetDataSegmentRelationshipsResponse
Retrieves a paginated list of data segment relationships for a session dataset.
-
#list_dataset_data_segments(params = {}) ⇒ Types::ListDatasetDataSegmentsResponse
Retrieves a paginated list of data segments associated with a dataset.
-
#list_dataset_export_jobs(params = {}) ⇒ Types::ListDatasetExportJobsResponse
Retrieves a paginated list of dataset export jobs for a workspace.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves a paginated list of datasets for a specific target resource.
-
#list_enrichment_jobs(params = {}) ⇒ Types::ListEnrichmentJobsResponse
Lists enrichment jobs within a workspace with optional filtering and pagination.
-
#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_interface_relationships(params = {}) ⇒ Types::ListInterfaceRelationshipsResponse
Retrieves a paginated list of asset models that have a specific interface asset model applied to them.
-
#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsResponse
Lists pipeline executions for a specific pipeline in a workspace.
-
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Lists pipelines in a workspace.
-
#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_queries(params = {}) ⇒ Types::ListQueriesResponse
Retrieves a paginated list of queries for a workspace.
-
#list_searches(params = {}) ⇒ Types::ListSearchesResponse
Lists the searches in a workspace, most recently started first.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for an IoT SiteWise resource.
-
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Lists tasks in a workspace.
-
#list_time_series(params = {}) ⇒ Types::ListTimeSeriesResponse
Retrieves a paginated list of time series (data streams).
-
#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse
Retrieves a paginated list of workspaces.
-
#put_asset_model_interface_relationship(params = {}) ⇒ Types::PutAssetModelInterfaceRelationshipResponse
Creates or updates an interface relationship between an asset model and an interface asset model.
-
#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.
-
#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionResponse
Starts execution of a pipeline in the specified workspace.
-
#start_query(params = {}) ⇒ Types::StartQueryResponse
Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.
-
#start_search(params = {}) ⇒ Types::StartSearchResponse
Starts an asynchronous search over the data in a workspace.
-
#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
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#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
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#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_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse
Updates an existing pipeline in the specified workspace.
-
#update_portal(params = {}) ⇒ Types::UpdatePortalResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#update_project(params = {}) ⇒ Struct
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.
-
#update_task(params = {}) ⇒ Types::UpdateTaskResponse
Updates an existing task in the specified workspace.
-
#update_workspace(params = {}) ⇒ Types::UpdateWorkspaceResponse
Updates a workspace.
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.
490 491 492 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 490 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.
559 560 561 562 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 559 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.
611 612 613 614 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 611 def associate_time_series_to_asset_property(params = {}, = {}) req = build_request(:associate_time_series_to_asset_property, params) req.send_request() end |
#batch_associate_data_segments_to_dataset(params = {}) ⇒ Types::BatchAssociateDataSegmentsToDatasetResponse
Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.
684 685 686 687 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 684 def batch_associate_data_segments_to_dataset(params = {}, = {}) req = build_request(:batch_associate_data_segments_to_dataset, params) req.send_request() end |
#batch_associate_project_assets(params = {}) ⇒ Types::BatchAssociateProjectAssetsResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
737 738 739 740 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 737 def batch_associate_project_assets(params = {}, = {}) req = build_request(:batch_associate_project_assets, params) req.send_request() end |
#batch_delete_dataset_data_segments(params = {}) ⇒ Types::BatchDeleteDatasetDataSegmentsResponse
Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.
806 807 808 809 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 806 def batch_delete_dataset_data_segments(params = {}, = {}) req = build_request(:batch_delete_dataset_data_segments, params) req.send_request() end |
#batch_disassociate_data_segments_from_dataset(params = {}) ⇒ Types::BatchDisassociateDataSegmentsFromDatasetResponse
Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.
877 878 879 880 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 877 def batch_disassociate_data_segments_from_dataset(params = {}, = {}) req = build_request(:batch_disassociate_data_segments_from_dataset, params) req.send_request() end |
#batch_disassociate_project_assets(params = {}) ⇒ Types::BatchDisassociateProjectAssetsResponse
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
920 921 922 923 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 920 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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1005 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1073 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.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1156 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
assetIdandpropertyIdof 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.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1254 def batch_put_asset_property_value(params = {}, = {}) req = build_request(:batch_put_asset_property_value, params) req.send_request() end |
#cancel_enrichment_job(params = {}) ⇒ Types::CancelEnrichmentJobResponse
Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status.
Behavior
- Jobs in PENDING or RUNNING status transition to CANCELLED
- Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages
- Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException
- Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)
- The API responds immediately after recording the cancellation
- Cleanup of job resources happens asynchronously in the background
When to Cancel
Cancel a job when:
- The job is taking longer than expected
- The job was created with incorrect parameters
- You no longer need the results
Idempotency
You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1318 def cancel_enrichment_job(params = {}, = {}) req = build_request(:cancel_enrichment_job, params) req.send_request() end |
#cancel_pipeline_execution(params = {}) ⇒ Types::CancelPipelineExecutionResponse
Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1364 def cancel_pipeline_execution(params = {}, = {}) req = build_request(:cancel_pipeline_execution, params) req.send_request() end |
#cancel_query(params = {}) ⇒ Types::CancelQueryResponse
Cancels a running query.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1396 def cancel_query(params = {}, = {}) req = build_request(:cancel_query, params) req.send_request() end |
#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
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.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1493 def create_access_policy(params = {}, = {}) req = build_request(:create_access_policy, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a new application for the workspace and IdC application provided
1553 1554 1555 1556 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1553 def create_application(params = {}, = {}) req = build_request(:create_application, 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.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1647 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 three types of asset models, ASSET_MODEL,
COMPONENT_MODEL, or an INTERFACE.
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.
INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1969 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.
2193 2194 2195 2196 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2193 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 that ingests data into time series
outside of a workspace, you must enable IoT SiteWise warm tier or IoT
SiteWise cold tier. For more information about how to configure
storage settings, see PutStorageConfiguration. This requirement
doesn't apply to bulk import jobs that ingest data into a session
dataset in a workspace (jobs that specify a workspaceName and
datasetId). Those jobs don't use IoT SiteWise warm or cold tier
storage.
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.
2339 2340 2341 2342 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2339 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.
2430 2431 2432 2433 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2430 def create_computation_model(params = {}, = {}) req = build_request(:create_computation_model, params) req.send_request() end |
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Creates a dashboard in an IoT SiteWise Monitor project.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2512 def create_dashboard(params = {}, = {}) req = build_request(:create_dashboard, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.
2625 2626 2627 2628 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2625 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_dataset_export_job(params = {}) ⇒ Types::CreateDatasetExportJobResponse
Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.
2720 2721 2722 2723 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2720 def create_dataset_export_job(params = {}, = {}) req = build_request(:create_dataset_export_job, params) req.send_request() end |
#create_enrichment_job(params = {}) ⇒ Types::CreateEnrichmentJobResponse
Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.
Idempotency
Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.
Prerequisites
Before creating a job, ensure:
- The workspace is in ACTIVE state (not being deleted)
- You have IAM permissions for the workspace, dataset, and time-series resources
- You have KMS Decrypt permission on the workspace's customer-managed encryption key
- No duplicate job (same workspace, dataset, property, and job type) is currently running
Workflow
- Submit the job with configuration specifying which video data to analyze and the time range
- Capture the jobId from the response
- Use DescribeEnrichmentJob to monitor progress and check job status
- When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
- For COMPLETED jobs, query IoT SiteWise for semantic search on video events
Error Handling
- ConflictingOperationException: A duplicate job is already running for the same configuration
- InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
- AccessDeniedException: Insufficient IAM or KMS permissions
- LimitExceededException: Too many concurrent jobs or requests
2824 2825 2826 2827 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2824 def create_enrichment_job(params = {}, = {}) req = build_request(:create_enrichment_job, 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.
2909 2910 2911 2912 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2909 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.
You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.
3006 3007 3008 3009 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3006 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#create_portal(params = {}) ⇒ Types::CreatePortalResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
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.
3176 3177 3178 3179 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3176 def create_portal(params = {}, = {}) req = build_request(:create_portal, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Creates a project in the specified portal.
3248 3249 3250 3251 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3248 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_task(params = {}) ⇒ Types::CreateTaskResponse
Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.
Specify a containerTaskConfiguration for custom container
workloads with configurable ECR image, processing type, processing
unit, and environment variables.
3361 3362 3363 3364 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3361 def create_task(params = {}, = {}) req = build_request(:create_task, params) req.send_request() end |
#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse
Creates a workspace in IoT SiteWise. A workspace isolates its
resources, such as datasets, time series, pipelines, and tasks, and
their data from other workspaces, and has its own quotas and
throttling limits. You must specify an encryption configuration when
you create a workspace. The operation returns immediately with the
workspace in the CREATING state. Provisioning completes
asynchronously, after which the workspace state is ACTIVE, or
FAILED if provisioning doesn't complete.
3433 3434 3435 3436 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3433 def create_workspace(params = {}, = {}) req = build_request(:create_workspace, 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.
3464 3465 3466 3467 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3464 def delete_access_policy(params = {}, = {}) req = build_request(:delete_access_policy, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an application by ID
3488 3489 3490 3491 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3488 def delete_application(params = {}, = {}) req = build_request(:delete_application, 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.
3548 3549 3550 3551 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3548 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.
3630 3631 3632 3633 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3630 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.
3709 3710 3711 3712 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3709 def delete_asset_model_composite_model(params = {}, = {}) req = build_request(:delete_asset_model_composite_model, params) req.send_request() end |
#delete_asset_model_interface_relationship(params = {}) ⇒ Types::DeleteAssetModelInterfaceRelationshipResponse
Deletes an interface relationship between an asset model and an interface asset model.
3762 3763 3764 3765 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3762 def delete_asset_model_interface_relationship(params = {}, = {}) req = build_request(:delete_asset_model_interface_relationship, params) req.send_request() end |
#delete_computation_model(params = {}) ⇒ Types::DeleteComputationModelResponse
Deletes a computation model. This action can't be undone.
3802 3803 3804 3805 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3802 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.
3831 3832 3833 3834 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3831 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.
3880 3881 3882 3883 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3880 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.
3901 3902 3903 3904 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3901 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Types::DeletePipelineResponse
Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.
3940 3941 3942 3943 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3940 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#delete_portal(params = {}) ⇒ Types::DeletePortalResponse
Deletes a portal from IoT SiteWise Monitor.
3977 3978 3979 3980 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3977 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.
4006 4007 4008 4009 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4006 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_task(params = {}) ⇒ Types::DeleteTaskResponse
Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.
4040 4041 4042 4043 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4040 def delete_task(params = {}, = {}) req = build_request(:delete_task, 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. You can't delete a time series until all of its data segments have been deleted from session datasets.
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the
aliasof the time series.If the time series is associated with an asset property, specify one of the following:
The
aliasof the time series.The
assetIdandpropertyIdthat identifies the asset property.
4112 4113 4114 4115 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4112 def delete_time_series(params = {}, = {}) req = build_request(:delete_time_series, params) req.send_request() end |
#delete_workspace(params = {}) ⇒ Types::DeleteWorkspaceResponse
Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.
4152 4153 4154 4155 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4152 def delete_workspace(params = {}, = {}) req = build_request(:delete_workspace, 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.
4195 4196 4197 4198 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4195 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.
4232 4233 4234 4235 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4232 def describe_action(params = {}, = {}) req = build_request(:describe_action, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Retrieves Application details based on the ID
4280 4281 4282 4283 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4280 def describe_application(params = {}, = {}) req = build_request(:describe_application, 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
4393 4394 4395 4396 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4393 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.
4487 4488 4489 4490 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4487 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. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- asset_model_active
- asset_model_not_exists
4662 4663 4664 4665 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4662 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.
4789 4790 4791 4792 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4789 def describe_asset_model_composite_model(params = {}, = {}) req = build_request(:describe_asset_model_composite_model, params) req.send_request() end |
#describe_asset_model_interface_relationship(params = {}) ⇒ Types::DescribeAssetModelInterfaceRelationshipResponse
Retrieves information about an interface relationship between an asset model and an interface asset model.
4832 4833 4834 4835 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4832 def describe_asset_model_interface_relationship(params = {}, = {}) req = build_request(:describe_asset_model_interface_relationship, 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.
4970 4971 4972 4973 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4970 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.
5040 5041 5042 5043 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5040 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.
5105 5106 5107 5108 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5105 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.
5145 5146 5147 5148 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5145 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.
5185 5186 5187 5188 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5185 def describe_dashboard(params = {}, = {}) req = build_request(:describe_dashboard, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
5258 5259 5260 5261 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5258 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_dataset_export_job(params = {}) ⇒ Types::DescribeDatasetExportJobResponse
Retrieves information about a dataset export job.
5320 5321 5322 5323 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5320 def describe_dataset_export_job(params = {}, = {}) req = build_request(:describe_dataset_export_job, 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.
5350 5351 5352 5353 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5350 def describe_default_encryption_configuration(params = {}, = {}) req = build_request(:describe_default_encryption_configuration, params) req.send_request() end |
#describe_enrichment_job(params = {}) ⇒ Types::DescribeEnrichmentJobResponse
Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.
Use Cases
- Monitor job progress by checking status updates with DescribeEnrichmentJob
- Retrieve the complete job configuration submitted during creation
- Debug failed jobs by examining the failureMessage field
- Track job lifecycle with creation, update, completion, and cancellation timestamps
Status Monitoring
Jobs progress through statuses: PENDING → RUNNING → terminal state
Terminal states:
- COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
- FAILED: Job encountered an error; check failureMessage for details
- TIMED_OUT: Job exceeded maximum processing time
- CANCELLED: Job was cancelled via CancelEnrichmentJob
Response Fields
The response includes:
- Current job status and type
- Full job configuration as originally submitted
- Lifecycle timestamps (created, updated, completed, cancelled)
- Failure details if status is FAILED
5436 5437 5438 5439 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5436 def describe_enrichment_job(params = {}, = {}) req = build_request(:describe_enrichment_job, params) req.send_request() end |
#describe_execution(params = {}) ⇒ Types::DescribeExecutionResponse
Retrieves information about the execution.
5485 5486 5487 5488 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5485 def describe_execution(params = {}, = {}) req = build_request(:describe_execution, params) req.send_request() end |
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Retrieves information about a gateway.
5530 5531 5532 5533 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5530 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:opcuacollectorfor the OPC UA data source collector, orpublisherfor data publisher capability.version- The version number of the capability. Option include2for Classic streams, V2 gateways, and3for 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.
5591 5592 5593 5594 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5591 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.
5617 5618 5619 5620 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5617 def (params = {}, = {}) req = build_request(:describe_logging_options, params) req.send_request() end |
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves detailed information about a specific pipeline in a workspace.
5680 5681 5682 5683 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5680 def describe_pipeline(params = {}, = {}) req = build_request(:describe_pipeline, params) req.send_request() end |
#describe_pipeline_execution(params = {}) ⇒ Types::DescribePipelineExecutionResponse
Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5788 5789 5790 5791 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5788 def describe_pipeline_execution(params = {}, = {}) req = build_request(:describe_pipeline_execution, 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
5858 5859 5860 5861 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5858 def describe_portal(params = {}, = {}) req = build_request(:describe_portal, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Retrieves information about a project.
5896 5897 5898 5899 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5896 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#describe_query(params = {}) ⇒ Types::DescribeQueryResponse
Retrieves information about a query, including its status.
5938 5939 5940 5941 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5938 def describe_query(params = {}, = {}) req = build_request(:describe_query, params) req.send_request() end |
#describe_search(params = {}) ⇒ Types::DescribeSearchResponse
Returns the current status and metadata of a single search, including
the query that was submitted, the search type, and — when the search
has failed — the reason. Use this to poll a search started with
StartSearch until it reaches a terminal status (SUCCEEDED or
FAILED).
5986 5987 5988 5989 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5986 def describe_search(params = {}, = {}) req = build_request(:describe_search, params) req.send_request() end |
#describe_storage_configuration(params = {}) ⇒ Types::DescribeStorageConfigurationResponse
Retrieves information about the storage configuration for IoT SiteWise.
6025 6026 6027 6028 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6025 def describe_storage_configuration(params = {}, = {}) req = build_request(:describe_storage_configuration, params) req.send_request() end |
#describe_task(params = {}) ⇒ Types::DescribeTaskResponse
Retrieves detailed information about a specific task in a workspace.
6094 6095 6096 6097 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6094 def describe_task(params = {}, = {}) req = build_request(:describe_task, 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
aliasof the time series.If the time series is associated with an asset property, specify one of the following:
The
aliasof the time series.The
assetIdandpropertyIdthat identifies the asset property.
6177 6178 6179 6180 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6177 def describe_time_series(params = {}, = {}) req = build_request(:describe_time_series, params) req.send_request() end |
#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse
Retrieves information about a workspace.
6218 6219 6220 6221 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6218 def describe_workspace(params = {}, = {}) req = build_request(:describe_workspace, 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.
6283 6284 6285 6286 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6283 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.
6335 6336 6337 6338 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6335 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.
6386 6387 6388 6389 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6386 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.
6449 6450 6451 6452 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6449 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
assetIdandpropertyIdof 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.
6559 6560 6561 6562 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6559 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
assetIdandpropertyIdof 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.
6622 6623 6624 6625 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6622 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
assetIdandpropertyIdof 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.
6724 6725 6726 6727 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6724 def get_asset_property_value_history(params = {}, = {}) req = build_request(:get_asset_property_value_history, params) req.send_request() end |
#get_capture_data(params = {}) ⇒ Types::GetCaptureDataResponse
Retrieves video data for a specific time range.
6796 6797 6798 6799 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6796 def get_capture_data(params = {}, = {}) req = build_request(:get_capture_data, 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
assetIdandpropertyIdof 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.
6967 6968 6969 6970 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6967 def get_interpolated_asset_property_values(params = {}, = {}) req = build_request(:get_interpolated_asset_property_values, params) req.send_request() end |
#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse
Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7016 7017 7018 7019 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7016 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#get_search_results(params = {}) ⇒ Types::GetSearchResultsResponse
Retrieves the ranked results of a search, ordered by descending
relevance score. Results are available only after the search has
reached the SUCCEEDED status. Calling this on a search that exists
but has not yet completed returns InvalidRequestException, while
calling it on a search that does not exist returns
ResourceNotFoundException. The response is paginated: when
nextToken is present, pass it on a subsequent call to retrieve the
next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7079 7080 7081 7082 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7079 def get_search_results(params = {}, = {}) req = build_request(:get_search_results, params) req.send_request() end |
#invoke_assistant(params = {}) ⇒ Types::InvokeAssistantResponse
Invokes SiteWise Assistant to start or continue a conversation.
7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7318 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.
7415 7416 7417 7418 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7415 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.
7470 7471 7472 7473 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7470 def list_actions(params = {}, = {}) req = build_request(:list_actions, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Retrieves a paginated list of existing applications
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7510 7511 7512 7513 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7510 def list_applications(params = {}, = {}) req = build_request(:list_applications, 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.
7577 7578 7579 7580 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7577 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.
7685 7686 7687 7688 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7685 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.
7762 7763 7764 7765 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7762 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.
7833 7834 7835 7836 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7833 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.
7895 7896 7897 7898 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7895 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.
7989 7990 7991 7992 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7989 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.
8091 8092 8093 8094 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8091 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.
8143 8144 8145 8146 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8143 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.
8194 8195 8196 8197 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8194 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.
8259 8260 8261 8262 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8259 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.
8299 8300 8301 8302 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8299 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.
8352 8353 8354 8355 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8352 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.
8398 8399 8400 8401 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8398 def list_dashboards(params = {}, = {}) req = build_request(:list_dashboards, params) req.send_request() end |
#list_dataset_data_segment_relationships(params = {}) ⇒ Types::ListDatasetDataSegmentRelationshipsResponse
Retrieves a paginated list of data segment relationships for a session
dataset. Use this operation to find the curated datasets that
reference data segments of the specified session dataset. Use the
nextToken parameter to retrieve additional results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8451 8452 8453 8454 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8451 def list_dataset_data_segment_relationships(params = {}, = {}) req = build_request(:list_dataset_data_segment_relationships, params) req.send_request() end |
#list_dataset_data_segments(params = {}) ⇒ Types::ListDatasetDataSegmentsResponse
Retrieves a paginated list of data segments associated with a dataset.
Use the nextToken parameter to retrieve additional results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8509 8510 8511 8512 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8509 def list_dataset_data_segments(params = {}, = {}) req = build_request(:list_dataset_data_segments, params) req.send_request() end |
#list_dataset_export_jobs(params = {}) ⇒ Types::ListDatasetExportJobsResponse
Retrieves a paginated list of dataset export jobs for a workspace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8558 8559 8560 8561 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8558 def list_dataset_export_jobs(params = {}, = {}) req = build_request(:list_dataset_export_jobs, 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.
8624 8625 8626 8627 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8624 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_enrichment_jobs(params = {}) ⇒ Types::ListEnrichmentJobsResponse
Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).
Filtering
Combine filters to narrow results:
- datasetId: Filter by dataset
- propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)
- status: Filter by job status (e.g., RUNNING to find active jobs)
- jobType: Filter by enrichment type (currently only EVENT_DETECTION)
- startDate and endDate: Filter by job creation time range
Important Constraints
- You must specify either propertyAlias OR timeSeriesId, but not both
- Attempting to specify both results in an InvalidRequestException
- Date filters use ISO 8601 format
- startDate is exclusive, endDate is inclusive
Pagination
The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.
Common Use Cases
- Find all running jobs: Filter by status=RUNNING
- List recent jobs for a dataset: Filter by datasetId with optional date range
- Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId
- Track all event detection jobs: Filter by jobType=EVENT_DETECTION
Performance
Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8757 8758 8759 8760 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8757 def list_enrichment_jobs(params = {}, = {}) req = build_request(:list_enrichment_jobs, 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.
8821 8822 8823 8824 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8821 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.
8869 8870 8871 8872 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8869 def list_gateways(params = {}, = {}) req = build_request(:list_gateways, params) req.send_request() end |
#list_interface_relationships(params = {}) ⇒ Types::ListInterfaceRelationshipsResponse
Retrieves a paginated list of asset models that have a specific interface asset model applied to them.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8911 8912 8913 8914 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8911 def list_interface_relationships(params = {}, = {}) req = build_request(:list_interface_relationships, params) req.send_request() end |
#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsResponse
Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9003 9004 9005 9006 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9003 def list_pipeline_executions(params = {}, = {}) req = build_request(:list_pipeline_executions, params) req.send_request() end |
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9056 9057 9058 9059 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9056 def list_pipelines(params = {}, = {}) req = build_request(:list_pipelines, 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.
9103 9104 9105 9106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9103 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.
9145 9146 9147 9148 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9145 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.
9191 9192 9193 9194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9191 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_queries(params = {}) ⇒ Types::ListQueriesResponse
Retrieves a paginated list of queries for a workspace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9239 9240 9241 9242 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9239 def list_queries(params = {}, = {}) req = build_request(:list_queries, params) req.send_request() end |
#list_searches(params = {}) ⇒ Types::ListSearchesResponse
Lists the searches in a workspace, most recently started first.
Results can be narrowed with optional filters (status, search type,
group, and started-at time range) and are paginated: when nextToken
is present, pass it on a subsequent call to retrieve the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9300 9301 9302 9303 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9300 def list_searches(params = {}, = {}) req = build_request(:list_searches, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for an IoT SiteWise resource.
9331 9332 9333 9334 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9331 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Lists tasks in a workspace. To get complete details about a task, use DescribeTask.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9384 9385 9386 9387 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9384 def list_tasks(params = {}, = {}) req = build_request(:list_tasks, 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.
9459 9460 9461 9462 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9459 def list_time_series(params = {}, = {}) req = build_request(:list_time_series, params) req.send_request() end |
#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse
Retrieves a paginated list of workspaces. Use the nextToken
parameter to retrieve additional results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9502 9503 9504 9505 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9502 def list_workspaces(params = {}, = {}) req = build_request(:list_workspaces, params) req.send_request() end |
#put_asset_model_interface_relationship(params = {}) ⇒ Types::PutAssetModelInterfaceRelationshipResponse
Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
9572 9573 9574 9575 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9572 def put_asset_model_interface_relationship(params = {}, = {}) req = build_request(:put_asset_model_interface_relationship, 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.
9615 9616 9617 9618 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9615 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.
9641 9642 9643 9644 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9641 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.
9756 9757 9758 9759 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9756 def put_storage_configuration(params = {}, = {}) req = build_request(:put_storage_configuration, params) req.send_request() end |
#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionResponse
Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.
You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.
9849 9850 9851 9852 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9849 def start_pipeline_execution(params = {}, = {}) req = build_request(:start_pipeline_execution, params) req.send_request() end |
#start_query(params = {}) ⇒ Types::StartQueryResponse
Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.
9892 9893 9894 9895 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9892 def start_query(params = {}, = {}) req = build_request(:start_query, params) req.send_request() end |
#start_search(params = {}) ⇒ Types::StartSearchResponse
Starts an asynchronous search over the data in a workspace. The search
runs in the background; the response returns immediately with a
searchId and an initial status of QUEUED. Use DescribeSearch to
poll for completion and GetSearchResults to retrieve the results
once the search reaches SUCCEEDED. The request is idempotent on
clientToken: repeating a call with the same token returns the
original search instead of starting a new one.
9973 9974 9975 9976 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9973 def start_search(params = {}, = {}) req = build_request(:start_search, 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.
10010 10011 10012 10013 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10010 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.
10038 10039 10040 10041 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10038 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_policy(params = {}) ⇒ Struct
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
10113 10114 10115 10116 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10113 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.
10186 10187 10188 10189 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10186 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
UpdateAssetModelrequest with the entire existing property removed.Submit a second
UpdateAssetModelrequest that includes the new property. The new asset property will have the samenameas the previous one and IoT SiteWise will generate a new uniqueid.
10522 10523 10524 10525 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10522 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
UpdateAssetModelCompositeModelrequest with the entire existing property removed.Submit a second
UpdateAssetModelCompositeModelrequest that includes the new property. The new asset property will have the samenameas the previous one and IoT SiteWise will generate a new uniqueid.
10726 10727 10728 10729 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10726 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.
10818 10819 10820 10821 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10818 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.
10897 10898 10899 10900 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10897 def update_computation_model(params = {}, = {}) req = build_request(:update_computation_model, params) req.send_request() end |
#update_dashboard(params = {}) ⇒ Struct
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an IoT SiteWise Monitor dashboard.
10959 10960 10961 10962 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10959 def update_dashboard(params = {}, = {}) req = build_request(:update_dashboard, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a dataset.
11049 11050 11051 11052 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11049 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_gateway(params = {}) ⇒ Struct
Updates a gateway's name.
11073 11074 11075 11076 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11073 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:opcuacollectorfor the OPC UA data source collector, orpublisherfor data publisher capability.version- The version number of the capability. Option include2for Classic streams, V2 gateways, and3for 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.
11146 11147 11148 11149 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11146 def update_gateway_capability_configuration(params = {}, = {}) req = build_request(:update_gateway_capability_configuration, params) req.send_request() end |
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse
Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.
11207 11208 11209 11210 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11207 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |
#update_portal(params = {}) ⇒ Types::UpdatePortalResponse
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an IoT SiteWise Monitor portal.
11328 11329 11330 11331 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11328 def update_portal(params = {}, = {}) req = build_request(:update_portal, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an IoT SiteWise Monitor project.
11375 11376 11377 11378 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11375 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#update_task(params = {}) ⇒ Types::UpdateTaskResponse
Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.
11448 11449 11450 11451 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11448 def update_task(params = {}, = {}) req = build_request(:update_task, params) req.send_request() end |
#update_workspace(params = {}) ⇒ Types::UpdateWorkspaceResponse
Updates a workspace. You can update only workspaces in the ACTIVE or
FAILED state. Fields that you omit from the request are left
unchanged. To recover a workspace in the FAILED state, call this
operation and supply its encryption configuration again.
11503 11504 11505 11506 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11503 def update_workspace(params = {}, = {}) req = build_request(:update_workspace, 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 |
11623 11624 11625 11626 11627 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11623 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |