Package software.amazon.awssdk.services.iotsitewise

Interface IoTSiteWiseClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IoTSiteWiseClient
extends AwsClient

Service client for accessing AWS IoT SiteWise. This can be created using the static builder() method.

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateAssetsResponse	associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest)	Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
default AssociateAssetsResponse	associateAssets(AssociateAssetsRequest associateAssetsRequest)	Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
default AssociateTimeSeriesToAssetPropertyResponse	associateTimeSeriesToAssetProperty(Consumer<AssociateTimeSeriesToAssetPropertyRequest.Builder> associateTimeSeriesToAssetPropertyRequest)	Associates a time series (data stream) with an asset property.
default AssociateTimeSeriesToAssetPropertyResponse	associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest)	Associates a time series (data stream) with an asset property.
default BatchAssociateProjectAssetsResponse	batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest)	Associates a group (batch) of assets with an IoT SiteWise Monitor project.
default BatchAssociateProjectAssetsResponse	batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)	Associates a group (batch) of assets with an IoT SiteWise Monitor project.
default BatchDisassociateProjectAssetsResponse	batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest)	Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
default BatchDisassociateProjectAssetsResponse	batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)	Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
default BatchGetAssetPropertyAggregatesResponse	batchGetAssetPropertyAggregates(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest)	Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
default BatchGetAssetPropertyAggregatesResponse	batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)	Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
default BatchGetAssetPropertyAggregatesIterable	batchGetAssetPropertyAggregatesPaginator(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest)	This is a variant of batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest) operation.
default BatchGetAssetPropertyAggregatesIterable	batchGetAssetPropertyAggregatesPaginator(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)	This is a variant of batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest) operation.
default BatchGetAssetPropertyValueResponse	batchGetAssetPropertyValue(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest)	Gets the current value for one or more asset properties.
default BatchGetAssetPropertyValueResponse	batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)	Gets the current value for one or more asset properties.
default BatchGetAssetPropertyValueHistoryResponse	batchGetAssetPropertyValueHistory(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest)	Gets the historical values for one or more asset properties.
default BatchGetAssetPropertyValueHistoryResponse	batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)	Gets the historical values for one or more asset properties.
default BatchGetAssetPropertyValueHistoryIterable	batchGetAssetPropertyValueHistoryPaginator(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest)	This is a variant of batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest) operation.
default BatchGetAssetPropertyValueHistoryIterable	batchGetAssetPropertyValueHistoryPaginator(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)	This is a variant of batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest) operation.
default BatchGetAssetPropertyValueIterable	batchGetAssetPropertyValuePaginator(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest)	This is a variant of batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest) operation.
default BatchGetAssetPropertyValueIterable	batchGetAssetPropertyValuePaginator(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)	This is a variant of batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest) operation.
default BatchPutAssetPropertyValueResponse	batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest)	Sends a list of asset property values to IoT SiteWise.
default BatchPutAssetPropertyValueResponse	batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)	Sends a list of asset property values to IoT SiteWise.
static IoTSiteWiseClientBuilder	builder()	Create a builder that can be used to configure and create a IoTSiteWiseClient.
static IoTSiteWiseClient	create()	Create a IoTSiteWiseClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAccessPolicyResponse	createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)	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.
default CreateAccessPolicyResponse	createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)	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.
default CreateAssetResponse	createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest)	Creates an asset from an existing asset model.
default CreateAssetResponse	createAsset(CreateAssetRequest createAssetRequest)	Creates an asset from an existing asset model.
default CreateAssetModelResponse	createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest)	Creates an asset model from specified property and hierarchy definitions.
default CreateAssetModelResponse	createAssetModel(CreateAssetModelRequest createAssetModelRequest)	Creates an asset model from specified property and hierarchy definitions.
default CreateAssetModelCompositeModelResponse	createAssetModelCompositeModel(Consumer<CreateAssetModelCompositeModelRequest.Builder> createAssetModelCompositeModelRequest)	Creates a custom composite model from specified property and hierarchy definitions.
default CreateAssetModelCompositeModelResponse	createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest createAssetModelCompositeModelRequest)	Creates a custom composite model from specified property and hierarchy definitions.
default CreateBulkImportJobResponse	createBulkImportJob(Consumer<CreateBulkImportJobRequest.Builder> createBulkImportJobRequest)	Defines a job to ingest data to IoT SiteWise from Amazon S3.
default CreateBulkImportJobResponse	createBulkImportJob(CreateBulkImportJobRequest createBulkImportJobRequest)	Defines a job to ingest data to IoT SiteWise from Amazon S3.
default CreateDashboardResponse	createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)	Creates a dashboard in an IoT SiteWise Monitor project.
default CreateDashboardResponse	createDashboard(CreateDashboardRequest createDashboardRequest)	Creates a dashboard in an IoT SiteWise Monitor project.
default CreateGatewayResponse	createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)	Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.
default CreateGatewayResponse	createGateway(CreateGatewayRequest createGatewayRequest)	Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.
default CreatePortalResponse	createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)	Creates a portal, which can contain projects and dashboards.
default CreatePortalResponse	createPortal(CreatePortalRequest createPortalRequest)	Creates a portal, which can contain projects and dashboards.
default CreateProjectResponse	createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)	Creates a project in the specified portal.
default CreateProjectResponse	createProject(CreateProjectRequest createProjectRequest)	Creates a project in the specified portal.
default DeleteAccessPolicyResponse	deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)	Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
default DeleteAccessPolicyResponse	deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)	Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
default DeleteAssetResponse	deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest)	Deletes an asset.
default DeleteAssetResponse	deleteAsset(DeleteAssetRequest deleteAssetRequest)	Deletes an asset.
default DeleteAssetModelResponse	deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest)	Deletes an asset model.
default DeleteAssetModelResponse	deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)	Deletes an asset model.
default DeleteAssetModelCompositeModelResponse	deleteAssetModelCompositeModel(Consumer<DeleteAssetModelCompositeModelRequest.Builder> deleteAssetModelCompositeModelRequest)	Deletes a composite model.
default DeleteAssetModelCompositeModelResponse	deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest deleteAssetModelCompositeModelRequest)	Deletes a composite model.
default DeleteDashboardResponse	deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)	Deletes a dashboard from IoT SiteWise Monitor.
default DeleteDashboardResponse	deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)	Deletes a dashboard from IoT SiteWise Monitor.
default DeleteGatewayResponse	deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)	Deletes a gateway from IoT SiteWise.
default DeleteGatewayResponse	deleteGateway(DeleteGatewayRequest deleteGatewayRequest)	Deletes a gateway from IoT SiteWise.
default DeletePortalResponse	deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)	Deletes a portal from IoT SiteWise Monitor.
default DeletePortalResponse	deletePortal(DeletePortalRequest deletePortalRequest)	Deletes a portal from IoT SiteWise Monitor.
default DeleteProjectResponse	deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)	Deletes a project from IoT SiteWise Monitor.
default DeleteProjectResponse	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes a project from IoT SiteWise Monitor.
default DeleteTimeSeriesResponse	deleteTimeSeries(Consumer<DeleteTimeSeriesRequest.Builder> deleteTimeSeriesRequest)	Deletes a time series (data stream).
default DeleteTimeSeriesResponse	deleteTimeSeries(DeleteTimeSeriesRequest deleteTimeSeriesRequest)	Deletes a time series (data stream).
default DescribeAccessPolicyResponse	describeAccessPolicy(Consumer<DescribeAccessPolicyRequest.Builder> describeAccessPolicyRequest)	Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
default DescribeAccessPolicyResponse	describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)	Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
default DescribeActionResponse	describeAction(Consumer<DescribeActionRequest.Builder> describeActionRequest)	Retrieves information about an action.
default DescribeActionResponse	describeAction(DescribeActionRequest describeActionRequest)	Retrieves information about an action.
default DescribeAssetResponse	describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest)	Retrieves information about an asset.
default DescribeAssetResponse	describeAsset(DescribeAssetRequest describeAssetRequest)	Retrieves information about an asset.
default DescribeAssetCompositeModelResponse	describeAssetCompositeModel(Consumer<DescribeAssetCompositeModelRequest.Builder> describeAssetCompositeModelRequest)	Retrieves information about an asset composite model (also known as an asset component).
default DescribeAssetCompositeModelResponse	describeAssetCompositeModel(DescribeAssetCompositeModelRequest describeAssetCompositeModelRequest)	Retrieves information about an asset composite model (also known as an asset component).
default DescribeAssetModelResponse	describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest)	Retrieves information about an asset model.
default DescribeAssetModelResponse	describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)	Retrieves information about an asset model.
default DescribeAssetModelCompositeModelResponse	describeAssetModelCompositeModel(Consumer<DescribeAssetModelCompositeModelRequest.Builder> describeAssetModelCompositeModelRequest)	Retrieves information about an asset model composite model (also known as an asset model component).
default DescribeAssetModelCompositeModelResponse	describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest describeAssetModelCompositeModelRequest)	Retrieves information about an asset model composite model (also known as an asset model component).
default DescribeAssetPropertyResponse	describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest)	Retrieves information about an asset property.
default DescribeAssetPropertyResponse	describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)	Retrieves information about an asset property.
default DescribeBulkImportJobResponse	describeBulkImportJob(Consumer<DescribeBulkImportJobRequest.Builder> describeBulkImportJobRequest)	Retrieves information about a bulk import job request.
default DescribeBulkImportJobResponse	describeBulkImportJob(DescribeBulkImportJobRequest describeBulkImportJobRequest)	Retrieves information about a bulk import job request.
default DescribeDashboardResponse	describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)	Retrieves information about a dashboard.
default DescribeDashboardResponse	describeDashboard(DescribeDashboardRequest describeDashboardRequest)	Retrieves information about a dashboard.
default DescribeDefaultEncryptionConfigurationResponse	describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest)	Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
default DescribeDefaultEncryptionConfigurationResponse	describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)	Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
default DescribeGatewayResponse	describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest)	Retrieves information about a gateway.
default DescribeGatewayResponse	describeGateway(DescribeGatewayRequest describeGatewayRequest)	Retrieves information about a gateway.
default DescribeGatewayCapabilityConfigurationResponse	describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest)	Retrieves information about a gateway capability configuration.
default DescribeGatewayCapabilityConfigurationResponse	describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)	Retrieves information about a gateway capability configuration.
default DescribeLoggingOptionsResponse	describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)	Retrieves the current IoT SiteWise logging options.
default DescribeLoggingOptionsResponse	describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)	Retrieves the current IoT SiteWise logging options.
default DescribePortalResponse	describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest)	Retrieves information about a portal.
default DescribePortalResponse	describePortal(DescribePortalRequest describePortalRequest)	Retrieves information about a portal.
default DescribeProjectResponse	describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)	Retrieves information about a project.
default DescribeProjectResponse	describeProject(DescribeProjectRequest describeProjectRequest)	Retrieves information about a project.
default DescribeStorageConfigurationResponse	describeStorageConfiguration(Consumer<DescribeStorageConfigurationRequest.Builder> describeStorageConfigurationRequest)	Retrieves information about the storage configuration for IoT SiteWise.
default DescribeStorageConfigurationResponse	describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest)	Retrieves information about the storage configuration for IoT SiteWise.
default DescribeTimeSeriesResponse	describeTimeSeries(Consumer<DescribeTimeSeriesRequest.Builder> describeTimeSeriesRequest)	Retrieves information about a time series (data stream).
default DescribeTimeSeriesResponse	describeTimeSeries(DescribeTimeSeriesRequest describeTimeSeriesRequest)	Retrieves information about a time series (data stream).
default DisassociateAssetsResponse	disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest)	Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
default DisassociateAssetsResponse	disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)	Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
default DisassociateTimeSeriesFromAssetPropertyResponse	disassociateTimeSeriesFromAssetProperty(Consumer<DisassociateTimeSeriesFromAssetPropertyRequest.Builder> disassociateTimeSeriesFromAssetPropertyRequest)	Disassociates a time series (data stream) from an asset property.
default DisassociateTimeSeriesFromAssetPropertyResponse	disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest)	Disassociates a time series (data stream) from an asset property.
default ExecuteActionResponse	executeAction(Consumer<ExecuteActionRequest.Builder> executeActionRequest)	Executes an action on a target resource.
default ExecuteActionResponse	executeAction(ExecuteActionRequest executeActionRequest)	Executes an action on a target resource.
default ExecuteQueryResponse	executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)	Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
default ExecuteQueryResponse	executeQuery(ExecuteQueryRequest executeQueryRequest)	Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
default ExecuteQueryIterable	executeQueryPaginator(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)	This is a variant of executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest) operation.
default ExecuteQueryIterable	executeQueryPaginator(ExecuteQueryRequest executeQueryRequest)	This is a variant of executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest) operation.
default GetAssetPropertyAggregatesResponse	getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)	Gets aggregated values for an asset property.
default GetAssetPropertyAggregatesResponse	getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)	Gets aggregated values for an asset property.
default GetAssetPropertyAggregatesIterable	getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)	This is a variant of getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) operation.
default GetAssetPropertyAggregatesIterable	getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)	This is a variant of getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) operation.
default GetAssetPropertyValueResponse	getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest)	Gets an asset property's current value.
default GetAssetPropertyValueResponse	getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)	Gets an asset property's current value.
default GetAssetPropertyValueHistoryResponse	getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)	Gets the history of an asset property's values.
default GetAssetPropertyValueHistoryResponse	getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)	Gets the history of an asset property's values.
default GetAssetPropertyValueHistoryIterable	getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)	This is a variant of getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest) operation.
default GetAssetPropertyValueHistoryIterable	getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)	This is a variant of getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest) operation.
default GetInterpolatedAssetPropertyValuesResponse	getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)	Get interpolated values for an asset property for a specified time interval, during a period of time.
default GetInterpolatedAssetPropertyValuesResponse	getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)	Get interpolated values for an asset property for a specified time interval, during a period of time.
default GetInterpolatedAssetPropertyValuesIterable	getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)	This is a variant of getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest) operation.
default GetInterpolatedAssetPropertyValuesIterable	getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)	This is a variant of getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest) operation.
default ListAccessPoliciesResponse	listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)	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).
default ListAccessPoliciesResponse	listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)	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).
default ListAccessPoliciesIterable	listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)	This is a variant of listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest) operation.
default ListAccessPoliciesIterable	listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)	This is a variant of listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest) operation.
default ListActionsResponse	listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)	Retrieves a paginated list of actions for a specific target resource.
default ListActionsResponse	listActions(ListActionsRequest listActionsRequest)	Retrieves a paginated list of actions for a specific target resource.
default ListActionsIterable	listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)	This is a variant of listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest) operation.
default ListActionsIterable	listActionsPaginator(ListActionsRequest listActionsRequest)	This is a variant of listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest) operation.
default ListAssetModelCompositeModelsResponse	listAssetModelCompositeModels(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest)	Retrieves a paginated list of composite models associated with the asset model
default ListAssetModelCompositeModelsResponse	listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)	Retrieves a paginated list of composite models associated with the asset model
default ListAssetModelCompositeModelsIterable	listAssetModelCompositeModelsPaginator(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest)	This is a variant of listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest) operation.
default ListAssetModelCompositeModelsIterable	listAssetModelCompositeModelsPaginator(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)	This is a variant of listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest) operation.
default ListAssetModelPropertiesResponse	listAssetModelProperties(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest)	Retrieves a paginated list of properties associated with an asset model.
default ListAssetModelPropertiesResponse	listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)	Retrieves a paginated list of properties associated with an asset model.
default ListAssetModelPropertiesIterable	listAssetModelPropertiesPaginator(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest)	This is a variant of listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest) operation.
default ListAssetModelPropertiesIterable	listAssetModelPropertiesPaginator(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)	This is a variant of listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest) operation.
default ListAssetModelsResponse	listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)	Retrieves a paginated list of summaries of all asset models.
default ListAssetModelsResponse	listAssetModels(ListAssetModelsRequest listAssetModelsRequest)	Retrieves a paginated list of summaries of all asset models.
default ListAssetModelsIterable	listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)	This is a variant of listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation.
default ListAssetModelsIterable	listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest)	This is a variant of listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation.
default ListAssetPropertiesResponse	listAssetProperties(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest)	Retrieves a paginated list of properties associated with an asset.
default ListAssetPropertiesResponse	listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest)	Retrieves a paginated list of properties associated with an asset.
default ListAssetPropertiesIterable	listAssetPropertiesPaginator(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest)	This is a variant of listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest) operation.
default ListAssetPropertiesIterable	listAssetPropertiesPaginator(ListAssetPropertiesRequest listAssetPropertiesRequest)	This is a variant of listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest) operation.
default ListAssetRelationshipsResponse	listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)	Retrieves a paginated list of asset relationships for an asset.
default ListAssetRelationshipsResponse	listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)	Retrieves a paginated list of asset relationships for an asset.
default ListAssetRelationshipsIterable	listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)	This is a variant of listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest) operation.
default ListAssetRelationshipsIterable	listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest)	This is a variant of listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest) operation.
default ListAssetsResponse	listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest)	Retrieves a paginated list of asset summaries.
default ListAssetsResponse	listAssets(ListAssetsRequest listAssetsRequest)	Retrieves a paginated list of asset summaries.
default ListAssetsIterable	listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest)	This is a variant of listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation.
default ListAssetsIterable	listAssetsPaginator(ListAssetsRequest listAssetsRequest)	This is a variant of listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation.
default ListAssociatedAssetsResponse	listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)	Retrieves a paginated list of associated assets.
default ListAssociatedAssetsResponse	listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)	Retrieves a paginated list of associated assets.
default ListAssociatedAssetsIterable	listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)	This is a variant of listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest) operation.
default ListAssociatedAssetsIterable	listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest)	This is a variant of listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest) operation.
default ListBulkImportJobsResponse	listBulkImportJobs(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest)	Retrieves a paginated list of bulk import job requests.
default ListBulkImportJobsResponse	listBulkImportJobs(ListBulkImportJobsRequest listBulkImportJobsRequest)	Retrieves a paginated list of bulk import job requests.
default ListBulkImportJobsIterable	listBulkImportJobsPaginator(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest)	This is a variant of listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest) operation.
default ListBulkImportJobsIterable	listBulkImportJobsPaginator(ListBulkImportJobsRequest listBulkImportJobsRequest)	This is a variant of listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest) operation.
default ListCompositionRelationshipsResponse	listCompositionRelationships(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest)	Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
default ListCompositionRelationshipsResponse	listCompositionRelationships(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)	Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
default ListCompositionRelationshipsIterable	listCompositionRelationshipsPaginator(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest)	This is a variant of listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest) operation.
default ListCompositionRelationshipsIterable	listCompositionRelationshipsPaginator(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)	This is a variant of listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest) operation.
default ListDashboardsResponse	listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)	Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
default ListDashboardsResponse	listDashboards(ListDashboardsRequest listDashboardsRequest)	Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
default ListDashboardsIterable	listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)	This is a variant of listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation.
default ListDashboardsIterable	listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)	This is a variant of listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation.
default ListGatewaysResponse	listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)	Retrieves a paginated list of gateways.
default ListGatewaysResponse	listGateways(ListGatewaysRequest listGatewaysRequest)	Retrieves a paginated list of gateways.
default ListGatewaysIterable	listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)	This is a variant of listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation.
default ListGatewaysIterable	listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)	This is a variant of listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation.
default ListPortalsResponse	listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)	Retrieves a paginated list of IoT SiteWise Monitor portals.
default ListPortalsResponse	listPortals(ListPortalsRequest listPortalsRequest)	Retrieves a paginated list of IoT SiteWise Monitor portals.
default ListPortalsIterable	listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)	This is a variant of listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation.
default ListPortalsIterable	listPortalsPaginator(ListPortalsRequest listPortalsRequest)	This is a variant of listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation.
default ListProjectAssetsResponse	listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)	Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
default ListProjectAssetsResponse	listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)	Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
default ListProjectAssetsIterable	listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)	This is a variant of listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest) operation.
default ListProjectAssetsIterable	listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest)	This is a variant of listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest) operation.
default ListProjectsResponse	listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
default ListProjectsResponse	listProjects(ListProjectsRequest listProjectsRequest)	Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
default ListProjectsIterable	listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(ListProjectsRequest listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves the list of tags for an IoT SiteWise resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves the list of tags for an IoT SiteWise resource.
default ListTimeSeriesResponse	listTimeSeries(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest)	Retrieves a paginated list of time series (data streams).
default ListTimeSeriesResponse	listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest)	Retrieves a paginated list of time series (data streams).
default ListTimeSeriesIterable	listTimeSeriesPaginator(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest)	This is a variant of listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest) operation.
default ListTimeSeriesIterable	listTimeSeriesPaginator(ListTimeSeriesRequest listTimeSeriesRequest)	This is a variant of listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest) operation.
default PutDefaultEncryptionConfigurationResponse	putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest)	Sets the default encryption configuration for the Amazon Web Services account.
default PutDefaultEncryptionConfigurationResponse	putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)	Sets the default encryption configuration for the Amazon Web Services account.
default PutLoggingOptionsResponse	putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)	Sets logging options for IoT SiteWise.
default PutLoggingOptionsResponse	putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)	Sets logging options for IoT SiteWise.
default PutStorageConfigurationResponse	putStorageConfiguration(Consumer<PutStorageConfigurationRequest.Builder> putStorageConfigurationRequest)	Configures storage settings for IoT SiteWise.
default PutStorageConfigurationResponse	putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest)	Configures storage settings for IoT SiteWise.
default IoTSiteWiseServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to an IoT SiteWise resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to an IoT SiteWise resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag from an IoT SiteWise resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag from an IoT SiteWise resource.
default UpdateAccessPolicyResponse	updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)	Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
default UpdateAccessPolicyResponse	updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)	Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
default UpdateAssetResponse	updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest)	Updates an asset's name.
default UpdateAssetResponse	updateAsset(UpdateAssetRequest updateAssetRequest)	Updates an asset's name.
default UpdateAssetModelResponse	updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest)	Updates an asset model and all of the assets that were created from the model.
default UpdateAssetModelResponse	updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)	Updates an asset model and all of the assets that were created from the model.
default UpdateAssetModelCompositeModelResponse	updateAssetModelCompositeModel(Consumer<UpdateAssetModelCompositeModelRequest.Builder> updateAssetModelCompositeModelRequest)	Updates a composite model and all of the assets that were created from the model.
default UpdateAssetModelCompositeModelResponse	updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest updateAssetModelCompositeModelRequest)	Updates a composite model and all of the assets that were created from the model.
default UpdateAssetPropertyResponse	updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest)	Updates an asset property's alias and notification state.
default UpdateAssetPropertyResponse	updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)	Updates an asset property's alias and notification state.
default UpdateDashboardResponse	updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)	Updates an IoT SiteWise Monitor dashboard.
default UpdateDashboardResponse	updateDashboard(UpdateDashboardRequest updateDashboardRequest)	Updates an IoT SiteWise Monitor dashboard.
default UpdateGatewayResponse	updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)	Updates a gateway's name.
default UpdateGatewayResponse	updateGateway(UpdateGatewayRequest updateGatewayRequest)	Updates a gateway's name.
default UpdateGatewayCapabilityConfigurationResponse	updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest)	Updates a gateway capability configuration or defines a new capability configuration.
default UpdateGatewayCapabilityConfigurationResponse	updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)	Updates a gateway capability configuration or defines a new capability configuration.
default UpdatePortalResponse	updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)	Updates an IoT SiteWise Monitor portal.
default UpdatePortalResponse	updatePortal(UpdatePortalRequest updatePortalRequest)	Updates an IoT SiteWise Monitor portal.
default UpdateProjectResponse	updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)	Updates an IoT SiteWise Monitor project.
default UpdateProjectResponse	updateProject(UpdateProjectRequest updateProjectRequest)	Updates an IoT SiteWise Monitor project.
default IoTSiteWiseWaiter	waiter()	Create an instance of IoTSiteWiseWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

associateAssets

default AssociateAssetsResponse associateAssets(AssociateAssetsRequest associateAssetsRequest)
                                         throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
LimitExceededException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

associateAssetsRequest -

Returns:

Result of the AssociateAssets operation returned by the service.

See Also:

• AWS API Documentation

associateAssets

default AssociateAssetsResponse associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest)
                                         throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
LimitExceededException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the AssociateAssetsRequest.Builder avoiding the need to create one manually via AssociateAssetsRequest.builder()

Parameters:

associateAssetsRequest - A Consumer that will call methods on AssociateAssetsRequest.Builder to create a request.

Returns:

Result of the AssociateAssets operation returned by the service.

See Also:

• AWS API Documentation

associateTimeSeriesToAssetProperty

default AssociateTimeSeriesToAssetPropertyResponse associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest)
                                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Associates a time series (data stream) with an asset property.

Parameters:

associateTimeSeriesToAssetPropertyRequest -

Returns:

Result of the AssociateTimeSeriesToAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

associateTimeSeriesToAssetProperty

default AssociateTimeSeriesToAssetPropertyResponse associateTimeSeriesToAssetProperty(Consumer<AssociateTimeSeriesToAssetPropertyRequest.Builder> associateTimeSeriesToAssetPropertyRequest)
                                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Associates a time series (data stream) with an asset property.

This is a convenience which creates an instance of the AssociateTimeSeriesToAssetPropertyRequest.Builder avoiding the need to create one manually via AssociateTimeSeriesToAssetPropertyRequest.builder()

Parameters:

associateTimeSeriesToAssetPropertyRequest - A Consumer that will call methods on AssociateTimeSeriesToAssetPropertyRequest.Builder to create a request.

Returns:

Result of the AssociateTimeSeriesToAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

batchAssociateProjectAssets

default BatchAssociateProjectAssetsResponse batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
                                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

Parameters:

batchAssociateProjectAssetsRequest -

Returns:

Result of the BatchAssociateProjectAssets operation returned by the service.

See Also:

• AWS API Documentation

batchAssociateProjectAssets

default BatchAssociateProjectAssetsResponse batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest)
                                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

This is a convenience which creates an instance of the BatchAssociateProjectAssetsRequest.Builder avoiding the need to create one manually via BatchAssociateProjectAssetsRequest.builder()

Parameters:

batchAssociateProjectAssetsRequest - A Consumer that will call methods on BatchAssociateProjectAssetsRequest.Builder to create a request.

Returns:

Result of the BatchAssociateProjectAssets operation returned by the service.

See Also:

• AWS API Documentation

batchDisassociateProjectAssets

default BatchDisassociateProjectAssetsResponse batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
                                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

Parameters:

batchDisassociateProjectAssetsRequest -

Returns:

Result of the BatchDisassociateProjectAssets operation returned by the service.

See Also:

• AWS API Documentation

batchDisassociateProjectAssets

default BatchDisassociateProjectAssetsResponse batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest)
                                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

This is a convenience which creates an instance of the BatchDisassociateProjectAssetsRequest.Builder avoiding the need to create one manually via BatchDisassociateProjectAssetsRequest.builder()

Parameters:

batchDisassociateProjectAssetsRequest - A Consumer that will call methods on BatchDisassociateProjectAssetsRequest.Builder to create a request.

Returns:

Result of the BatchDisassociateProjectAssets operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyAggregates

default BatchGetAssetPropertyAggregatesResponse batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)
                                                                         throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

batchGetAssetPropertyAggregatesRequest -

Returns:

Result of the BatchGetAssetPropertyAggregates operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyAggregates

default BatchGetAssetPropertyAggregatesResponse batchGetAssetPropertyAggregates(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest)
                                                                         throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the BatchGetAssetPropertyAggregatesRequest.Builder avoiding the need to create one manually via BatchGetAssetPropertyAggregatesRequest.builder()

Parameters:

batchGetAssetPropertyAggregatesRequest - A Consumer that will call methods on BatchGetAssetPropertyAggregatesRequest.Builder to create a request.

Returns:

Result of the BatchGetAssetPropertyAggregates operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyAggregatesPaginator

default BatchGetAssetPropertyAggregatesIterable batchGetAssetPropertyAggregatesPaginator(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)
                                                                                  throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client
             .batchGetAssetPropertyAggregatesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest) operation.

Parameters:

batchGetAssetPropertyAggregatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchGetAssetPropertyAggregatesPaginator

default BatchGetAssetPropertyAggregatesIterable batchGetAssetPropertyAggregatesPaginator(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest)
                                                                                  throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client
             .batchGetAssetPropertyAggregatesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest) operation.

This is a convenience which creates an instance of the BatchGetAssetPropertyAggregatesRequest.Builder avoiding the need to create one manually via BatchGetAssetPropertyAggregatesRequest.builder()

Parameters:

batchGetAssetPropertyAggregatesRequest - A Consumer that will call methods on BatchGetAssetPropertyAggregatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchGetAssetPropertyValue

default BatchGetAssetPropertyValueResponse batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)
                                                               throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

Parameters:

batchGetAssetPropertyValueRequest -

Returns:

Result of the BatchGetAssetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyValue

default BatchGetAssetPropertyValueResponse batchGetAssetPropertyValue(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest)
                                                               throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the BatchGetAssetPropertyValueRequest.Builder avoiding the need to create one manually via BatchGetAssetPropertyValueRequest.builder()

Parameters:

batchGetAssetPropertyValueRequest - A Consumer that will call methods on BatchGetAssetPropertyValueRequest.Builder to create a request.

Returns:

Result of the BatchGetAssetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyValuePaginator

default BatchGetAssetPropertyValueIterable batchGetAssetPropertyValuePaginator(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)
                                                                        throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client
             .batchGetAssetPropertyValuePaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest) operation.

Parameters:

batchGetAssetPropertyValueRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchGetAssetPropertyValuePaginator

default BatchGetAssetPropertyValueIterable batchGetAssetPropertyValuePaginator(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest)
                                                                        throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client
             .batchGetAssetPropertyValuePaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest) operation.

This is a convenience which creates an instance of the BatchGetAssetPropertyValueRequest.Builder avoiding the need to create one manually via BatchGetAssetPropertyValueRequest.builder()

Parameters:

batchGetAssetPropertyValueRequest - A Consumer that will call methods on BatchGetAssetPropertyValueRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchGetAssetPropertyValueHistory

default BatchGetAssetPropertyValueHistoryResponse batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)
                                                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

Parameters:

batchGetAssetPropertyValueHistoryRequest -

Returns:

Result of the BatchGetAssetPropertyValueHistory operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyValueHistory

default BatchGetAssetPropertyValueHistoryResponse batchGetAssetPropertyValueHistory(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest)
                                                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the BatchGetAssetPropertyValueHistoryRequest.Builder avoiding the need to create one manually via BatchGetAssetPropertyValueHistoryRequest.builder()

Parameters:

batchGetAssetPropertyValueHistoryRequest - A Consumer that will call methods on BatchGetAssetPropertyValueHistoryRequest.Builder to create a request.

Returns:

Result of the BatchGetAssetPropertyValueHistory operation returned by the service.

See Also:

• AWS API Documentation

batchGetAssetPropertyValueHistoryPaginator

default BatchGetAssetPropertyValueHistoryIterable batchGetAssetPropertyValueHistoryPaginator(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)
                                                                                      throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client
             .batchGetAssetPropertyValueHistoryPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest) operation.

Parameters:

batchGetAssetPropertyValueHistoryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchGetAssetPropertyValueHistoryPaginator

default BatchGetAssetPropertyValueHistoryIterable batchGetAssetPropertyValueHistoryPaginator(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest)
                                                                                      throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client
             .batchGetAssetPropertyValueHistoryPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest) operation.

This is a convenience which creates an instance of the BatchGetAssetPropertyValueHistoryRequest.Builder avoiding the need to create one manually via BatchGetAssetPropertyValueHistoryRequest.builder()

Parameters:

batchGetAssetPropertyValueHistoryRequest - A Consumer that will call methods on BatchGetAssetPropertyValueHistoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchPutAssetPropertyValue

default BatchPutAssetPropertyValueResponse batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ServiceUnavailableException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.

For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.

Parameters:

batchPutAssetPropertyValueRequest -

Returns:

Result of the BatchPutAssetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

batchPutAssetPropertyValue

default BatchPutAssetPropertyValueResponse batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest)
                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ServiceUnavailableException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.

For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the BatchPutAssetPropertyValueRequest.Builder avoiding the need to create one manually via BatchPutAssetPropertyValueRequest.builder()

Parameters:

batchPutAssetPropertyValueRequest - A Consumer that will call methods on BatchPutAssetPropertyValueRequest.Builder to create a request.

Returns:

Result of the BatchPutAssetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

createAccessPolicy

default CreateAccessPolicyResponse createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

createAccessPolicyRequest -

Returns:

Result of the CreateAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

createAccessPolicy

default CreateAccessPolicyResponse createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the CreateAccessPolicyRequest.Builder avoiding the need to create one manually via CreateAccessPolicyRequest.builder()

Parameters:

createAccessPolicyRequest - A Consumer that will call methods on CreateAccessPolicyRequest.Builder to create a request.

Returns:

Result of the CreateAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

createAsset

default CreateAssetResponse createAsset(CreateAssetRequest createAssetRequest)
                                 throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

Parameters:

createAssetRequest -

Returns:

Result of the CreateAsset operation returned by the service.

See Also:

• AWS API Documentation

createAsset

default CreateAssetResponse createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest)
                                 throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the CreateAssetRequest.Builder avoiding the need to create one manually via CreateAssetRequest.builder()

Parameters:

createAssetRequest - A Consumer that will call methods on CreateAssetRequest.Builder to create a request.

Returns:

Result of the CreateAsset operation returned by the service.

See Also:

• AWS API Documentation

createAssetModel

default CreateAssetModelResponse createAssetModel(CreateAssetModelRequest createAssetModelRequest)
                                           throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Parameters:

createAssetModelRequest -

Returns:

Result of the CreateAssetModel operation returned by the service.

See Also:

• AWS API Documentation

createAssetModel

default CreateAssetModelResponse createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest)
                                           throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

This is a convenience which creates an instance of the CreateAssetModelRequest.Builder avoiding the need to create one manually via CreateAssetModelRequest.builder()

Parameters:

createAssetModelRequest - A Consumer that will call methods on CreateAssetModelRequest.Builder to create a request.

Returns:

Result of the CreateAssetModel operation returned by the service.

See Also:

• AWS API Documentation

createAssetModelCompositeModel

default CreateAssetModelCompositeModelResponse createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest createAssetModelCompositeModelRequest)
                                                                       throws ConflictingOperationException,
InternalFailureException,
InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

createAssetModelCompositeModelRequest -

Returns:

Result of the CreateAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

createAssetModelCompositeModel

default CreateAssetModelCompositeModelResponse createAssetModelCompositeModel(Consumer<CreateAssetModelCompositeModelRequest.Builder> createAssetModelCompositeModelRequest)
                                                                       throws ConflictingOperationException,
InternalFailureException,
InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the CreateAssetModelCompositeModelRequest.Builder avoiding the need to create one manually via CreateAssetModelCompositeModelRequest.builder()

Parameters:

createAssetModelCompositeModelRequest - A Consumer that will call methods on CreateAssetModelCompositeModelRequest.Builder to create a request.

Returns:

Result of the CreateAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

createBulkImportJob

default CreateBulkImportJobResponse createBulkImportJob(CreateBulkImportJobRequest createBulkImportJobRequest)
                                                 throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

Parameters:

createBulkImportJobRequest -

Returns:

Result of the CreateBulkImportJob operation returned by the service.

See Also:

• AWS API Documentation

createBulkImportJob

default CreateBulkImportJobResponse createBulkImportJob(Consumer<CreateBulkImportJobRequest.Builder> createBulkImportJobRequest)
                                                 throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

This is a convenience which creates an instance of the CreateBulkImportJobRequest.Builder avoiding the need to create one manually via CreateBulkImportJobRequest.builder()

Parameters:

createBulkImportJobRequest - A Consumer that will call methods on CreateBulkImportJobRequest.Builder to create a request.

Returns:

Result of the CreateBulkImportJob operation returned by the service.

See Also:

• AWS API Documentation

createDashboard

default CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates a dashboard in an IoT SiteWise Monitor project.

Parameters:

createDashboardRequest -

Returns:

Result of the CreateDashboard operation returned by the service.

See Also:

• AWS API Documentation

createDashboard

default CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates a dashboard in an IoT SiteWise Monitor project.

This is a convenience which creates an instance of the CreateDashboardRequest.Builder avoiding the need to create one manually via CreateDashboardRequest.builder()

Parameters:

createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.

Returns:

Result of the CreateDashboard operation returned by the service.

See Also:

• AWS API Documentation

createGateway

default CreateGatewayResponse createGateway(CreateGatewayRequest createGatewayRequest)
                                     throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

createGatewayRequest -

Returns:

Result of the CreateGateway operation returned by the service.

See Also:

• AWS API Documentation

createGateway

default CreateGatewayResponse createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
                                     throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the CreateGatewayRequest.Builder avoiding the need to create one manually via CreateGatewayRequest.builder()

Parameters:

createGatewayRequest - A Consumer that will call methods on CreateGatewayRequest.Builder to create a request.

Returns:

Result of the CreateGateway operation returned by the service.

See Also:

• AWS API Documentation

createPortal

default CreatePortalResponse createPortal(CreatePortalRequest createPortalRequest)
                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

Parameters:

createPortalRequest -

Returns:

Result of the CreatePortal operation returned by the service.

See Also:

• AWS API Documentation

createPortal

default CreatePortalResponse createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)
                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the CreatePortalRequest.Builder avoiding the need to create one manually via CreatePortalRequest.builder()

Parameters:

createPortalRequest - A Consumer that will call methods on CreatePortalRequest.Builder to create a request.

Returns:

Result of the CreatePortal operation returned by the service.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPolicy

default DeleteAccessPolicyResponse deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

deleteAccessPolicyRequest -

Returns:

Result of the DeleteAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPolicy

default DeleteAccessPolicyResponse deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DeleteAccessPolicyRequest.Builder avoiding the need to create one manually via DeleteAccessPolicyRequest.builder()

Parameters:

deleteAccessPolicyRequest - A Consumer that will call methods on DeleteAccessPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteAsset

default DeleteAssetResponse deleteAsset(DeleteAssetRequest deleteAssetRequest)
                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

Parameters:

deleteAssetRequest -

Returns:

Result of the DeleteAsset operation returned by the service.

See Also:

• AWS API Documentation

deleteAsset

default DeleteAssetResponse deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest)
                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

This is a convenience which creates an instance of the DeleteAssetRequest.Builder avoiding the need to create one manually via DeleteAssetRequest.builder()

Parameters:

deleteAssetRequest - A Consumer that will call methods on DeleteAssetRequest.Builder to create a request.

Returns:

Result of the DeleteAsset operation returned by the service.

See Also:

• AWS API Documentation

deleteAssetModel

default DeleteAssetModelResponse deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

deleteAssetModelRequest -

Returns:

Result of the DeleteAssetModel operation returned by the service.

See Also:

• AWS API Documentation

deleteAssetModel

default DeleteAssetModelResponse deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest)
                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DeleteAssetModelRequest.Builder avoiding the need to create one manually via DeleteAssetModelRequest.builder()

Parameters:

deleteAssetModelRequest - A Consumer that will call methods on DeleteAssetModelRequest.Builder to create a request.

Returns:

Result of the DeleteAssetModel operation returned by the service.

See Also:

• AWS API Documentation

deleteAssetModelCompositeModel

default DeleteAssetModelCompositeModelResponse deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest deleteAssetModelCompositeModelRequest)
                                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

deleteAssetModelCompositeModelRequest -

Returns:

Result of the DeleteAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

deleteAssetModelCompositeModel

default DeleteAssetModelCompositeModelResponse deleteAssetModelCompositeModel(Consumer<DeleteAssetModelCompositeModelRequest.Builder> deleteAssetModelCompositeModelRequest)
                                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DeleteAssetModelCompositeModelRequest.Builder avoiding the need to create one manually via DeleteAssetModelCompositeModelRequest.builder()

Parameters:

deleteAssetModelCompositeModelRequest - A Consumer that will call methods on DeleteAssetModelCompositeModelRequest.Builder to create a request.

Returns:

Result of the DeleteAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

deleteDashboard

default DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a dashboard from IoT SiteWise Monitor.

Parameters:

deleteDashboardRequest -

Returns:

Result of the DeleteDashboard operation returned by the service.

See Also:

• AWS API Documentation

deleteDashboard

default DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a dashboard from IoT SiteWise Monitor.

This is a convenience which creates an instance of the DeleteDashboardRequest.Builder avoiding the need to create one manually via DeleteDashboardRequest.builder()

Parameters:

deleteDashboardRequest - A Consumer that will call methods on DeleteDashboardRequest.Builder to create a request.

Returns:

Result of the DeleteDashboard operation returned by the service.

See Also:

• AWS API Documentation

deleteGateway

default DeleteGatewayResponse deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

Parameters:

deleteGatewayRequest -

Returns:

Result of the DeleteGateway operation returned by the service.

See Also:

• AWS API Documentation

deleteGateway

default DeleteGatewayResponse deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

This is a convenience which creates an instance of the DeleteGatewayRequest.Builder avoiding the need to create one manually via DeleteGatewayRequest.builder()

Parameters:

deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayRequest.Builder to create a request.

Returns:

Result of the DeleteGateway operation returned by the service.

See Also:

• AWS API Documentation

deletePortal

default DeletePortalResponse deletePortal(DeletePortalRequest deletePortalRequest)
                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a portal from IoT SiteWise Monitor.

Parameters:

deletePortalRequest -

Returns:

Result of the DeletePortal operation returned by the service.

See Also:

• AWS API Documentation

deletePortal

default DeletePortalResponse deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)
                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a portal from IoT SiteWise Monitor.

This is a convenience which creates an instance of the DeletePortalRequest.Builder avoiding the need to create one manually via DeletePortalRequest.builder()

Parameters:

deletePortalRequest - A Consumer that will call methods on DeletePortalRequest.Builder to create a request.

Returns:

Result of the DeletePortal operation returned by the service.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a project from IoT SiteWise Monitor.

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a project from IoT SiteWise Monitor.

This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

deleteTimeSeries

default DeleteTimeSeriesResponse deleteTimeSeries(DeleteTimeSeriesRequest deleteTimeSeriesRequest)
                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

To identify a time series, do one of the following:

• If the time series isn't associated with an asset property, specify the alias of the time series.

• If the time series is associated with an asset property, specify one of the following:

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

Parameters:

deleteTimeSeriesRequest -

Returns:

Result of the DeleteTimeSeries operation returned by the service.

See Also:

• AWS API Documentation

deleteTimeSeries

default DeleteTimeSeriesResponse deleteTimeSeries(Consumer<DeleteTimeSeriesRequest.Builder> deleteTimeSeriesRequest)
                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

To identify a time series, do one of the following:

• If the time series isn't associated with an asset property, specify the alias of the time series.

• If the time series is associated with an asset property, specify one of the following:

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

This is a convenience which creates an instance of the DeleteTimeSeriesRequest.Builder avoiding the need to create one manually via DeleteTimeSeriesRequest.builder()

Parameters:

deleteTimeSeriesRequest - A Consumer that will call methods on DeleteTimeSeriesRequest.Builder to create a request.

Returns:

Result of the DeleteTimeSeries operation returned by the service.

See Also:

• AWS API Documentation

describeAccessPolicy

default DescribeAccessPolicyResponse describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

Parameters:

describeAccessPolicyRequest -

Returns:

Result of the DescribeAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeAccessPolicy

default DescribeAccessPolicyResponse describeAccessPolicy(Consumer<DescribeAccessPolicyRequest.Builder> describeAccessPolicyRequest)
                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

This is a convenience which creates an instance of the DescribeAccessPolicyRequest.Builder avoiding the need to create one manually via DescribeAccessPolicyRequest.builder()

Parameters:

describeAccessPolicyRequest - A Consumer that will call methods on DescribeAccessPolicyRequest.Builder to create a request.

Returns:

Result of the DescribeAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeAction

default DescribeActionResponse describeAction(DescribeActionRequest describeActionRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an action.

Parameters:

describeActionRequest -

Returns:

Result of the DescribeAction operation returned by the service.

See Also:

• AWS API Documentation

describeAction

default DescribeActionResponse describeAction(Consumer<DescribeActionRequest.Builder> describeActionRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an action.

This is a convenience which creates an instance of the DescribeActionRequest.Builder avoiding the need to create one manually via DescribeActionRequest.builder()

Parameters:

describeActionRequest - A Consumer that will call methods on DescribeActionRequest.Builder to create a request.

Returns:

Result of the DescribeAction operation returned by the service.

See Also:

• AWS API Documentation

describeAsset

default DescribeAssetResponse describeAsset(DescribeAssetRequest describeAssetRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an asset.

Parameters:

describeAssetRequest -

Returns:

Result of the DescribeAsset operation returned by the service.

See Also:

• AWS API Documentation

describeAsset

default DescribeAssetResponse describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an asset.

This is a convenience which creates an instance of the DescribeAssetRequest.Builder avoiding the need to create one manually via DescribeAssetRequest.builder()

Parameters:

describeAssetRequest - A Consumer that will call methods on DescribeAssetRequest.Builder to create a request.

Returns:

Result of the DescribeAsset operation returned by the service.

See Also:

• AWS API Documentation

describeAssetCompositeModel

default DescribeAssetCompositeModelResponse describeAssetCompositeModel(DescribeAssetCompositeModelRequest describeAssetCompositeModelRequest)
                                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

describeAssetCompositeModelRequest -

Returns:

Result of the DescribeAssetCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

describeAssetCompositeModel

default DescribeAssetCompositeModelResponse describeAssetCompositeModel(Consumer<DescribeAssetCompositeModelRequest.Builder> describeAssetCompositeModelRequest)
                                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DescribeAssetCompositeModelRequest.Builder avoiding the need to create one manually via DescribeAssetCompositeModelRequest.builder()

Parameters:

describeAssetCompositeModelRequest - A Consumer that will call methods on DescribeAssetCompositeModelRequest.Builder to create a request.

Returns:

Result of the DescribeAssetCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

describeAssetModel

default DescribeAssetModelResponse describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an asset model.

Parameters:

describeAssetModelRequest -

Returns:

Result of the DescribeAssetModel operation returned by the service.

See Also:

• AWS API Documentation

describeAssetModel

default DescribeAssetModelResponse describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an asset model.

This is a convenience which creates an instance of the DescribeAssetModelRequest.Builder avoiding the need to create one manually via DescribeAssetModelRequest.builder()

Parameters:

describeAssetModelRequest - A Consumer that will call methods on DescribeAssetModelRequest.Builder to create a request.

Returns:

Result of the DescribeAssetModel operation returned by the service.

See Also:

• AWS API Documentation

describeAssetModelCompositeModel

default DescribeAssetModelCompositeModelResponse describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest describeAssetModelCompositeModelRequest)
                                                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

describeAssetModelCompositeModelRequest -

Returns:

Result of the DescribeAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

describeAssetModelCompositeModel

default DescribeAssetModelCompositeModelResponse describeAssetModelCompositeModel(Consumer<DescribeAssetModelCompositeModelRequest.Builder> describeAssetModelCompositeModelRequest)
                                                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DescribeAssetModelCompositeModelRequest.Builder avoiding the need to create one manually via DescribeAssetModelCompositeModelRequest.builder()

Parameters:

describeAssetModelCompositeModelRequest - A Consumer that will call methods on DescribeAssetModelCompositeModelRequest.Builder to create a request.

Returns:

Result of the DescribeAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

describeAssetProperty

default DescribeAssetPropertyResponse describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
                                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

Parameters:

describeAssetPropertyRequest -

Returns:

Result of the DescribeAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

describeAssetProperty

default DescribeAssetPropertyResponse describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest)
                                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

This is a convenience which creates an instance of the DescribeAssetPropertyRequest.Builder avoiding the need to create one manually via DescribeAssetPropertyRequest.builder()

Parameters:

describeAssetPropertyRequest - A Consumer that will call methods on DescribeAssetPropertyRequest.Builder to create a request.

Returns:

Result of the DescribeAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

describeBulkImportJob

default DescribeBulkImportJobResponse describeBulkImportJob(DescribeBulkImportJobRequest describeBulkImportJobRequest)
                                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

describeBulkImportJobRequest -

Returns:

Result of the DescribeBulkImportJob operation returned by the service.

See Also:

• AWS API Documentation

describeBulkImportJob

default DescribeBulkImportJobResponse describeBulkImportJob(Consumer<DescribeBulkImportJobRequest.Builder> describeBulkImportJobRequest)
                                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DescribeBulkImportJobRequest.Builder avoiding the need to create one manually via DescribeBulkImportJobRequest.builder()

Parameters:

describeBulkImportJobRequest - A Consumer that will call methods on DescribeBulkImportJobRequest.Builder to create a request.

Returns:

Result of the DescribeBulkImportJob operation returned by the service.

See Also:

• AWS API Documentation

describeDashboard

default DescribeDashboardResponse describeDashboard(DescribeDashboardRequest describeDashboardRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a dashboard.

Parameters:

describeDashboardRequest -

Returns:

Result of the DescribeDashboard operation returned by the service.

See Also:

• AWS API Documentation

describeDashboard

default DescribeDashboardResponse describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a dashboard.

This is a convenience which creates an instance of the DescribeDashboardRequest.Builder avoiding the need to create one manually via DescribeDashboardRequest.builder()

Parameters:

describeDashboardRequest - A Consumer that will call methods on DescribeDashboardRequest.Builder to create a request.

Returns:

Result of the DescribeDashboard operation returned by the service.

See Also:

• AWS API Documentation

describeDefaultEncryptionConfiguration

default DescribeDefaultEncryptionConfigurationResponse describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)
                                                                                       throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

describeDefaultEncryptionConfigurationRequest -

Returns:

Result of the DescribeDefaultEncryptionConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeDefaultEncryptionConfiguration

default DescribeDefaultEncryptionConfigurationResponse describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest)
                                                                                       throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the DescribeDefaultEncryptionConfigurationRequest.Builder avoiding the need to create one manually via DescribeDefaultEncryptionConfigurationRequest.builder()

Parameters:

describeDefaultEncryptionConfigurationRequest - A Consumer that will call methods on DescribeDefaultEncryptionConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeDefaultEncryptionConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeGateway

default DescribeGatewayResponse describeGateway(DescribeGatewayRequest describeGatewayRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a gateway.

Parameters:

describeGatewayRequest -

Returns:

Result of the DescribeGateway operation returned by the service.

See Also:

• AWS API Documentation

describeGateway

default DescribeGatewayResponse describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a gateway.

This is a convenience which creates an instance of the DescribeGatewayRequest.Builder avoiding the need to create one manually via DescribeGatewayRequest.builder()

Parameters:

describeGatewayRequest - A Consumer that will call methods on DescribeGatewayRequest.Builder to create a request.

Returns:

Result of the DescribeGateway operation returned by the service.

See Also:

• AWS API Documentation

describeGatewayCapabilityConfiguration

default DescribeGatewayCapabilityConfigurationResponse describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
                                                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

Parameters:

describeGatewayCapabilityConfigurationRequest -

Returns:

Result of the DescribeGatewayCapabilityConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeGatewayCapabilityConfiguration

default DescribeGatewayCapabilityConfigurationResponse describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest)
                                                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

This is a convenience which creates an instance of the DescribeGatewayCapabilityConfigurationRequest.Builder avoiding the need to create one manually via DescribeGatewayCapabilityConfigurationRequest.builder()

Parameters:

describeGatewayCapabilityConfigurationRequest - A Consumer that will call methods on DescribeGatewayCapabilityConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeGatewayCapabilityConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeLoggingOptions

default DescribeLoggingOptionsResponse describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
                                                       throws InvalidRequestException,
ThrottlingException,
InternalFailureException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves the current IoT SiteWise logging options.

Parameters:

describeLoggingOptionsRequest -

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

describeLoggingOptions

default DescribeLoggingOptionsResponse describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)
                                                       throws InvalidRequestException,
ThrottlingException,
InternalFailureException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves the current IoT SiteWise logging options.

This is a convenience which creates an instance of the DescribeLoggingOptionsRequest.Builder avoiding the need to create one manually via DescribeLoggingOptionsRequest.builder()

Parameters:

describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.Builder to create a request.

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

describePortal

default DescribePortalResponse describePortal(DescribePortalRequest describePortalRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a portal.

Parameters:

describePortalRequest -

Returns:

Result of the DescribePortal operation returned by the service.

See Also:

• AWS API Documentation

describePortal

default DescribePortalResponse describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a portal.

This is a convenience which creates an instance of the DescribePortalRequest.Builder avoiding the need to create one manually via DescribePortalRequest.builder()

Parameters:

describePortalRequest - A Consumer that will call methods on DescribePortalRequest.Builder to create a request.

Returns:

Result of the DescribePortal operation returned by the service.

See Also:

• AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a project.

Parameters:

describeProjectRequest -

Returns:

Result of the DescribeProject operation returned by the service.

See Also:

• AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a project.

This is a convenience which creates an instance of the DescribeProjectRequest.Builder avoiding the need to create one manually via DescribeProjectRequest.builder()

Parameters:

describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.

Returns:

Result of the DescribeProject operation returned by the service.

See Also:

• AWS API Documentation

describeStorageConfiguration

default DescribeStorageConfigurationResponse describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest)
                                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about the storage configuration for IoT SiteWise.

Parameters:

describeStorageConfigurationRequest -

Returns:

Result of the DescribeStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeStorageConfiguration

default DescribeStorageConfigurationResponse describeStorageConfiguration(Consumer<DescribeStorageConfigurationRequest.Builder> describeStorageConfigurationRequest)
                                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about the storage configuration for IoT SiteWise.

This is a convenience which creates an instance of the DescribeStorageConfigurationRequest.Builder avoiding the need to create one manually via DescribeStorageConfigurationRequest.builder()

Parameters:

describeStorageConfigurationRequest - A Consumer that will call methods on DescribeStorageConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeTimeSeries

default DescribeTimeSeriesResponse describeTimeSeries(DescribeTimeSeriesRequest describeTimeSeriesRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

• If the time series isn't associated with an asset property, specify the alias of the time series.

• If the time series is associated with an asset property, specify one of the following:

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

Parameters:

describeTimeSeriesRequest -

Returns:

Result of the DescribeTimeSeries operation returned by the service.

See Also:

• AWS API Documentation

describeTimeSeries

default DescribeTimeSeriesResponse describeTimeSeries(Consumer<DescribeTimeSeriesRequest.Builder> describeTimeSeriesRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

• If the time series isn't associated with an asset property, specify the alias of the time series.

• If the time series is associated with an asset property, specify one of the following:

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

This is a convenience which creates an instance of the DescribeTimeSeriesRequest.Builder avoiding the need to create one manually via DescribeTimeSeriesRequest.builder()

Parameters:

describeTimeSeriesRequest - A Consumer that will call methods on DescribeTimeSeriesRequest.Builder to create a request.

Returns:

Result of the DescribeTimeSeries operation returned by the service.

See Also:

• AWS API Documentation

disassociateAssets

default DisassociateAssetsResponse disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

Parameters:

disassociateAssetsRequest -

Returns:

Result of the DisassociateAssets operation returned by the service.

See Also:

• AWS API Documentation

disassociateAssets

default DisassociateAssetsResponse disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

This is a convenience which creates an instance of the DisassociateAssetsRequest.Builder avoiding the need to create one manually via DisassociateAssetsRequest.builder()

Parameters:

disassociateAssetsRequest - A Consumer that will call methods on DisassociateAssetsRequest.Builder to create a request.

Returns:

Result of the DisassociateAssets operation returned by the service.

See Also:

• AWS API Documentation

disassociateTimeSeriesFromAssetProperty

default DisassociateTimeSeriesFromAssetPropertyResponse disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest)
                                                                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Disassociates a time series (data stream) from an asset property.

Parameters:

disassociateTimeSeriesFromAssetPropertyRequest -

Returns:

Result of the DisassociateTimeSeriesFromAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

disassociateTimeSeriesFromAssetProperty

default DisassociateTimeSeriesFromAssetPropertyResponse disassociateTimeSeriesFromAssetProperty(Consumer<DisassociateTimeSeriesFromAssetPropertyRequest.Builder> disassociateTimeSeriesFromAssetPropertyRequest)
                                                                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Disassociates a time series (data stream) from an asset property.

This is a convenience which creates an instance of the DisassociateTimeSeriesFromAssetPropertyRequest.Builder avoiding the need to create one manually via DisassociateTimeSeriesFromAssetPropertyRequest.builder()

Parameters:

disassociateTimeSeriesFromAssetPropertyRequest - A Consumer that will call methods on DisassociateTimeSeriesFromAssetPropertyRequest.Builder to create a request.

Returns:

Result of the DisassociateTimeSeriesFromAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

executeAction

default ExecuteActionResponse executeAction(ExecuteActionRequest executeActionRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Executes an action on a target resource.

Parameters:

executeActionRequest -

Returns:

Result of the ExecuteAction operation returned by the service.

See Also:

• AWS API Documentation

executeAction

default ExecuteActionResponse executeAction(Consumer<ExecuteActionRequest.Builder> executeActionRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Executes an action on a target resource.

This is a convenience which creates an instance of the ExecuteActionRequest.Builder avoiding the need to create one manually via ExecuteActionRequest.builder()

Parameters:

executeActionRequest - A Consumer that will call methods on ExecuteActionRequest.Builder to create a request.

Returns:

Result of the ExecuteAction operation returned by the service.

See Also:

• AWS API Documentation

executeQuery

default ExecuteQueryResponse executeQuery(ExecuteQueryRequest executeQueryRequest)
                                   throws InvalidRequestException,
ThrottlingException,
AccessDeniedException,
ValidationException,
QueryTimeoutException,
InternalFailureException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Parameters:

executeQueryRequest -

Returns:

Result of the ExecuteQuery operation returned by the service.

See Also:

• AWS API Documentation

executeQuery

default ExecuteQueryResponse executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)
                                   throws InvalidRequestException,
ThrottlingException,
AccessDeniedException,
ValidationException,
QueryTimeoutException,
InternalFailureException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

This is a convenience which creates an instance of the ExecuteQueryRequest.Builder avoiding the need to create one manually via ExecuteQueryRequest.builder()

Parameters:

executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.

Returns:

Result of the ExecuteQuery operation returned by the service.

See Also:

• AWS API Documentation

executeQueryPaginator

default ExecuteQueryIterable executeQueryPaginator(ExecuteQueryRequest executeQueryRequest)
                                            throws InvalidRequestException,
ThrottlingException,
AccessDeniedException,
ValidationException,
QueryTimeoutException,
InternalFailureException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest) operation.

Parameters:

executeQueryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

executeQueryPaginator

default ExecuteQueryIterable executeQueryPaginator(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)
                                            throws InvalidRequestException,
ThrottlingException,
AccessDeniedException,
ValidationException,
QueryTimeoutException,
InternalFailureException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest) operation.

This is a convenience which creates an instance of the ExecuteQueryRequest.Builder avoiding the need to create one manually via ExecuteQueryRequest.builder()

Parameters:

executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAssetPropertyAggregates

default GetAssetPropertyAggregatesResponse getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Parameters:

getAssetPropertyAggregatesRequest -

Returns:

Result of the GetAssetPropertyAggregates operation returned by the service.

See Also:

• AWS API Documentation

getAssetPropertyAggregates

default GetAssetPropertyAggregatesResponse getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

This is a convenience which creates an instance of the GetAssetPropertyAggregatesRequest.Builder avoiding the need to create one manually via GetAssetPropertyAggregatesRequest.builder()

Parameters:

getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.Builder to create a request.

Returns:

Result of the GetAssetPropertyAggregates operation returned by the service.

See Also:

• AWS API Documentation

getAssetPropertyAggregatesPaginator

default GetAssetPropertyAggregatesIterable getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
                                                                        throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client
             .getAssetPropertyAggregatesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) operation.

Parameters:

getAssetPropertyAggregatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAssetPropertyAggregatesPaginator

default GetAssetPropertyAggregatesIterable getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
                                                                        throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client
             .getAssetPropertyAggregatesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) operation.

This is a convenience which creates an instance of the GetAssetPropertyAggregatesRequest.Builder avoiding the need to create one manually via GetAssetPropertyAggregatesRequest.builder()

Parameters:

getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAssetPropertyValue

default GetAssetPropertyValueResponse getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
                                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Parameters:

getAssetPropertyValueRequest -

Returns:

Result of the GetAssetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

getAssetPropertyValue

default GetAssetPropertyValueResponse getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest)
                                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

This is a convenience which creates an instance of the GetAssetPropertyValueRequest.Builder avoiding the need to create one manually via GetAssetPropertyValueRequest.builder()

Parameters:

getAssetPropertyValueRequest - A Consumer that will call methods on GetAssetPropertyValueRequest.Builder to create a request.

Returns:

Result of the GetAssetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

getAssetPropertyValueHistory

default GetAssetPropertyValueHistoryResponse getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
                                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Parameters:

getAssetPropertyValueHistoryRequest -

Returns:

Result of the GetAssetPropertyValueHistory operation returned by the service.

See Also:

• AWS API Documentation

getAssetPropertyValueHistory

default GetAssetPropertyValueHistoryResponse getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
                                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

This is a convenience which creates an instance of the GetAssetPropertyValueHistoryRequest.Builder avoiding the need to create one manually via GetAssetPropertyValueHistoryRequest.builder()

Parameters:

getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.Builder to create a request.

Returns:

Result of the GetAssetPropertyValueHistory operation returned by the service.

See Also:

• AWS API Documentation

getAssetPropertyValueHistoryPaginator

default GetAssetPropertyValueHistoryIterable getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
                                                                            throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client
             .getAssetPropertyValueHistoryPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest) operation.

Parameters:

getAssetPropertyValueHistoryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAssetPropertyValueHistoryPaginator

default GetAssetPropertyValueHistoryIterable getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
                                                                            throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client
             .getAssetPropertyValueHistoryPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest) operation.

This is a convenience which creates an instance of the GetAssetPropertyValueHistoryRequest.Builder avoiding the need to create one manually via GetAssetPropertyValueHistoryRequest.builder()

Parameters:

getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getInterpolatedAssetPropertyValues

default GetInterpolatedAssetPropertyValuesResponse getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
                                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Parameters:

getInterpolatedAssetPropertyValuesRequest -

Returns:

Result of the GetInterpolatedAssetPropertyValues operation returned by the service.

See Also:

• AWS API Documentation

getInterpolatedAssetPropertyValues

default GetInterpolatedAssetPropertyValuesResponse getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
                                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

To identify an asset property, you must specify one of the following:

• The assetId and propertyId of an asset property.

• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

This is a convenience which creates an instance of the GetInterpolatedAssetPropertyValuesRequest.Builder avoiding the need to create one manually via GetInterpolatedAssetPropertyValuesRequest.builder()

Parameters:

getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.Builder to create a request.

Returns:

Result of the GetInterpolatedAssetPropertyValues operation returned by the service.

See Also:

• AWS API Documentation

getInterpolatedAssetPropertyValuesPaginator

default GetInterpolatedAssetPropertyValuesIterable getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
                                                                                        throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client
             .getInterpolatedAssetPropertyValuesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest) operation.

Parameters:

getInterpolatedAssetPropertyValuesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getInterpolatedAssetPropertyValuesPaginator

default GetInterpolatedAssetPropertyValuesIterable getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
                                                                                        throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client
             .getInterpolatedAssetPropertyValuesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest) operation.

This is a convenience which creates an instance of the GetInterpolatedAssetPropertyValuesRequest.Builder avoiding the need to create one manually via GetInterpolatedAssetPropertyValuesRequest.builder()

Parameters:

getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAccessPolicies

default ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
                                               throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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).

Parameters:

listAccessPoliciesRequest -

Returns:

Result of the ListAccessPolicies operation returned by the service.

See Also:

• AWS API Documentation

listAccessPolicies

default ListAccessPoliciesResponse listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
                                               throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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).

This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the need to create one manually via ListAccessPoliciesRequest.builder()

Parameters:

listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.

Returns:

Result of the ListAccessPolicies operation returned by the service.

See Also:

• AWS API Documentation

listAccessPoliciesPaginator

default ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
                                                        throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client
             .listAccessPoliciesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest) operation.

Parameters:

listAccessPoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAccessPoliciesPaginator

default ListAccessPoliciesIterable listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
                                                        throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client
             .listAccessPoliciesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest) operation.

This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the need to create one manually via ListAccessPoliciesRequest.builder()

Parameters:

listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listActions

default ListActionsResponse listActions(ListActionsRequest listActionsRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of actions for a specific target resource.

Parameters:

listActionsRequest -

Returns:

Result of the ListActions operation returned by the service.

See Also:

• AWS API Documentation

listActions

default ListActionsResponse listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of actions for a specific target resource.

This is a convenience which creates an instance of the ListActionsRequest.Builder avoiding the need to create one manually via ListActionsRequest.builder()

Parameters:

listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.

Returns:

Result of the ListActions operation returned by the service.

See Also:

• AWS API Documentation

listActionsPaginator

default ListActionsIterable listActionsPaginator(ListActionsRequest listActionsRequest)
                                          throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest) operation.

Parameters:

listActionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listActionsPaginator

default ListActionsIterable listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)
                                          throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest) operation.

This is a convenience which creates an instance of the ListActionsRequest.Builder avoiding the need to create one manually via ListActionsRequest.builder()

Parameters:

listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetModelCompositeModels

default ListAssetModelCompositeModelsResponse listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)
                                                                     throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of composite models associated with the asset model

Parameters:

listAssetModelCompositeModelsRequest -

Returns:

Result of the ListAssetModelCompositeModels operation returned by the service.

See Also:

• AWS API Documentation

listAssetModelCompositeModels

default ListAssetModelCompositeModelsResponse listAssetModelCompositeModels(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest)
                                                                     throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of composite models associated with the asset model

This is a convenience which creates an instance of the ListAssetModelCompositeModelsRequest.Builder avoiding the need to create one manually via ListAssetModelCompositeModelsRequest.builder()

Parameters:

listAssetModelCompositeModelsRequest - A Consumer that will call methods on ListAssetModelCompositeModelsRequest.Builder to create a request.

Returns:

Result of the ListAssetModelCompositeModels operation returned by the service.

See Also:

• AWS API Documentation

listAssetModelCompositeModelsPaginator

default ListAssetModelCompositeModelsIterable listAssetModelCompositeModelsPaginator(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)
                                                                              throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client
             .listAssetModelCompositeModelsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest) operation.

Parameters:

listAssetModelCompositeModelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetModelCompositeModelsPaginator

default ListAssetModelCompositeModelsIterable listAssetModelCompositeModelsPaginator(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest)
                                                                              throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client
             .listAssetModelCompositeModelsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest) operation.

This is a convenience which creates an instance of the ListAssetModelCompositeModelsRequest.Builder avoiding the need to create one manually via ListAssetModelCompositeModelsRequest.builder()

Parameters:

listAssetModelCompositeModelsRequest - A Consumer that will call methods on ListAssetModelCompositeModelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetModelProperties

default ListAssetModelPropertiesResponse listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)
                                                           throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

listAssetModelPropertiesRequest -

Returns:

Result of the ListAssetModelProperties operation returned by the service.

See Also:

• AWS API Documentation

listAssetModelProperties

default ListAssetModelPropertiesResponse listAssetModelProperties(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest)
                                                           throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the ListAssetModelPropertiesRequest.Builder avoiding the need to create one manually via ListAssetModelPropertiesRequest.builder()

Parameters:

listAssetModelPropertiesRequest - A Consumer that will call methods on ListAssetModelPropertiesRequest.Builder to create a request.

Returns:

Result of the ListAssetModelProperties operation returned by the service.

See Also:

• AWS API Documentation

listAssetModelPropertiesPaginator

default ListAssetModelPropertiesIterable listAssetModelPropertiesPaginator(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)
                                                                    throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client
             .listAssetModelPropertiesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest) operation.

Parameters:

listAssetModelPropertiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetModelPropertiesPaginator

default ListAssetModelPropertiesIterable listAssetModelPropertiesPaginator(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest)
                                                                    throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client
             .listAssetModelPropertiesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest) operation.

This is a convenience which creates an instance of the ListAssetModelPropertiesRequest.Builder avoiding the need to create one manually via ListAssetModelPropertiesRequest.builder()

Parameters:

listAssetModelPropertiesRequest - A Consumer that will call methods on ListAssetModelPropertiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetModels

default ListAssetModelsResponse listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
                                         throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of summaries of all asset models.

Parameters:

listAssetModelsRequest -

Returns:

Result of the ListAssetModels operation returned by the service.

See Also:

• AWS API Documentation

listAssetModels

default ListAssetModelsResponse listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
                                         throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of summaries of all asset models.

This is a convenience which creates an instance of the ListAssetModelsRequest.Builder avoiding the need to create one manually via ListAssetModelsRequest.builder()

Parameters:

listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.

Returns:

Result of the ListAssetModels operation returned by the service.

See Also:

• AWS API Documentation

listAssetModelsPaginator

default ListAssetModelsIterable listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest)
                                                  throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client
             .listAssetModelsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation.

Parameters:

listAssetModelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetModelsPaginator

default ListAssetModelsIterable listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
                                                  throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client
             .listAssetModelsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation.

This is a convenience which creates an instance of the ListAssetModelsRequest.Builder avoiding the need to create one manually via ListAssetModelsRequest.builder()

Parameters:

listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetProperties

default ListAssetPropertiesResponse listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

listAssetPropertiesRequest -

Returns:

Result of the ListAssetProperties operation returned by the service.

See Also:

• AWS API Documentation

listAssetProperties

default ListAssetPropertiesResponse listAssetProperties(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the ListAssetPropertiesRequest.Builder avoiding the need to create one manually via ListAssetPropertiesRequest.builder()

Parameters:

listAssetPropertiesRequest - A Consumer that will call methods on ListAssetPropertiesRequest.Builder to create a request.

Returns:

Result of the ListAssetProperties operation returned by the service.

See Also:

• AWS API Documentation

listAssetPropertiesPaginator

default ListAssetPropertiesIterable listAssetPropertiesPaginator(ListAssetPropertiesRequest listAssetPropertiesRequest)
                                                          throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client
             .listAssetPropertiesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest) operation.

Parameters:

listAssetPropertiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetPropertiesPaginator

default ListAssetPropertiesIterable listAssetPropertiesPaginator(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest)
                                                          throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client
             .listAssetPropertiesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest) operation.

This is a convenience which creates an instance of the ListAssetPropertiesRequest.Builder avoiding the need to create one manually via ListAssetPropertiesRequest.builder()

Parameters:

listAssetPropertiesRequest - A Consumer that will call methods on ListAssetPropertiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetRelationships

default ListAssetRelationshipsResponse listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
                                                       throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

listAssetRelationshipsRequest -

Returns:

Result of the ListAssetRelationships operation returned by the service.

See Also:

• AWS API Documentation

listAssetRelationships

default ListAssetRelationshipsResponse listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
                                                       throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the ListAssetRelationshipsRequest.Builder avoiding the need to create one manually via ListAssetRelationshipsRequest.builder()

Parameters:

listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a request.

Returns:

Result of the ListAssetRelationships operation returned by the service.

See Also:

• AWS API Documentation

listAssetRelationshipsPaginator

default ListAssetRelationshipsIterable listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
                                                                throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client
             .listAssetRelationshipsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest) operation.

Parameters:

listAssetRelationshipsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetRelationshipsPaginator

default ListAssetRelationshipsIterable listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
                                                                throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client
             .listAssetRelationshipsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest) operation.

This is a convenience which creates an instance of the ListAssetRelationshipsRequest.Builder avoiding the need to create one manually via ListAssetRelationshipsRequest.builder()

Parameters:

listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssets

default ListAssetsResponse listAssets(ListAssetsRequest listAssetsRequest)
                               throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

listAssetsRequest -

Returns:

Result of the ListAssets operation returned by the service.

See Also:

• AWS API Documentation

listAssets

default ListAssetsResponse listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
                               throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the ListAssetsRequest.Builder avoiding the need to create one manually via ListAssetsRequest.builder()

Parameters:

listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.

Returns:

Result of the ListAssets operation returned by the service.

See Also:

• AWS API Documentation

listAssetsPaginator

default ListAssetsIterable listAssetsPaginator(ListAssetsRequest listAssetsRequest)
                                        throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation.

Parameters:

listAssetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetsPaginator

default ListAssetsIterable listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
                                        throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation.

This is a convenience which creates an instance of the ListAssetsRequest.Builder avoiding the need to create one manually via ListAssetsRequest.builder()

Parameters:

listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedAssets

default ListAssociatedAssetsResponse listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
                                                   throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

• List child assets associated to a parent asset by a hierarchy that you specify.

• List an asset's parent asset.

Parameters:

listAssociatedAssetsRequest -

Returns:

Result of the ListAssociatedAssets operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedAssets

default ListAssociatedAssetsResponse listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
                                                   throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

• List child assets associated to a parent asset by a hierarchy that you specify.

• List an asset's parent asset.

This is a convenience which creates an instance of the ListAssociatedAssetsRequest.Builder avoiding the need to create one manually via ListAssociatedAssetsRequest.builder()

Parameters:

listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.Builder to create a request.

Returns:

Result of the ListAssociatedAssets operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedAssetsPaginator

default ListAssociatedAssetsIterable listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
                                                            throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client
             .listAssociatedAssetsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest) operation.

Parameters:

listAssociatedAssetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedAssetsPaginator

default ListAssociatedAssetsIterable listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
                                                            throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client
             .listAssociatedAssetsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest) operation.

This is a convenience which creates an instance of the ListAssociatedAssetsRequest.Builder avoiding the need to create one manually via ListAssociatedAssetsRequest.builder()

Parameters:

listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBulkImportJobs

default ListBulkImportJobsResponse listBulkImportJobs(ListBulkImportJobsRequest listBulkImportJobsRequest)
                                               throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

Parameters:

listBulkImportJobsRequest -

Returns:

Result of the ListBulkImportJobs operation returned by the service.

See Also:

• AWS API Documentation

listBulkImportJobs

default ListBulkImportJobsResponse listBulkImportJobs(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest)
                                               throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the ListBulkImportJobsRequest.Builder avoiding the need to create one manually via ListBulkImportJobsRequest.builder()

Parameters:

listBulkImportJobsRequest - A Consumer that will call methods on ListBulkImportJobsRequest.Builder to create a request.

Returns:

Result of the ListBulkImportJobs operation returned by the service.

See Also:

• AWS API Documentation

listBulkImportJobsPaginator

default ListBulkImportJobsIterable listBulkImportJobsPaginator(ListBulkImportJobsRequest listBulkImportJobsRequest)
                                                        throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client
             .listBulkImportJobsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest) operation.

Parameters:

listBulkImportJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBulkImportJobsPaginator

default ListBulkImportJobsIterable listBulkImportJobsPaginator(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest)
                                                        throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client
             .listBulkImportJobsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest) operation.

This is a convenience which creates an instance of the ListBulkImportJobsRequest.Builder avoiding the need to create one manually via ListBulkImportJobsRequest.builder()

Parameters:

listBulkImportJobsRequest - A Consumer that will call methods on ListBulkImportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCompositionRelationships

default ListCompositionRelationshipsResponse listCompositionRelationships(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)
                                                                   throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

Parameters:

listCompositionRelationshipsRequest -

Returns:

Result of the ListCompositionRelationships operation returned by the service.

See Also:

• AWS API Documentation

listCompositionRelationships

default ListCompositionRelationshipsResponse listCompositionRelationships(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest)
                                                                   throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

This is a convenience which creates an instance of the ListCompositionRelationshipsRequest.Builder avoiding the need to create one manually via ListCompositionRelationshipsRequest.builder()

Parameters:

listCompositionRelationshipsRequest - A Consumer that will call methods on ListCompositionRelationshipsRequest.Builder to create a request.

Returns:

Result of the ListCompositionRelationships operation returned by the service.

See Also:

• AWS API Documentation

listCompositionRelationshipsPaginator

default ListCompositionRelationshipsIterable listCompositionRelationshipsPaginator(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)
                                                                            throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client
             .listCompositionRelationshipsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest) operation.

Parameters:

listCompositionRelationshipsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCompositionRelationshipsPaginator

default ListCompositionRelationshipsIterable listCompositionRelationshipsPaginator(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest)
                                                                            throws InvalidRequestException,
InternalFailureException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client
             .listCompositionRelationshipsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest) operation.

This is a convenience which creates an instance of the ListCompositionRelationshipsRequest.Builder avoiding the need to create one manually via ListCompositionRelationshipsRequest.builder()

Parameters:

listCompositionRelationshipsRequest - A Consumer that will call methods on ListCompositionRelationshipsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDashboards

default ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest)
                                       throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

Parameters:

listDashboardsRequest -

Returns:

Result of the ListDashboards operation returned by the service.

See Also:

• AWS API Documentation

listDashboards

default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
                                       throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to create one manually via ListDashboardsRequest.builder()

Parameters:

listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.

Returns:

Result of the ListDashboards operation returned by the service.

See Also:

• AWS API Documentation

listDashboardsPaginator

default ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
                                                throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client
             .listDashboardsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation.

Parameters:

listDashboardsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDashboardsPaginator

default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
                                                throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client
             .listDashboardsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation.

This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to create one manually via ListDashboardsRequest.builder()

Parameters:

listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGateways

default ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of gateways.

Parameters:

listGatewaysRequest -

Returns:

Result of the ListGateways operation returned by the service.

See Also:

• AWS API Documentation

listGateways

default ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of gateways.

This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to create one manually via ListGatewaysRequest.builder()

Parameters:

listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.

Returns:

Result of the ListGateways operation returned by the service.

See Also:

• AWS API Documentation

listGatewaysPaginator

default ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation.

Parameters:

listGatewaysRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGatewaysPaginator

default ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation.

This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to create one manually via ListGatewaysRequest.builder()

Parameters:

listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPortals

default ListPortalsResponse listPortals(ListPortalsRequest listPortalsRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of IoT SiteWise Monitor portals.

Parameters:

listPortalsRequest -

Returns:

Result of the ListPortals operation returned by the service.

See Also:

• AWS API Documentation

listPortals

default ListPortalsResponse listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of IoT SiteWise Monitor portals.

This is a convenience which creates an instance of the ListPortalsRequest.Builder avoiding the need to create one manually via ListPortalsRequest.builder()

Parameters:

listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.

Returns:

Result of the ListPortals operation returned by the service.

See Also:

• AWS API Documentation

listPortalsPaginator

default ListPortalsIterable listPortalsPaginator(ListPortalsRequest listPortalsRequest)
                                          throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation.

Parameters:

listPortalsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPortalsPaginator

default ListPortalsIterable listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
                                          throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation.

This is a convenience which creates an instance of the ListPortalsRequest.Builder avoiding the need to create one manually via ListPortalsRequest.builder()

Parameters:

listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjectAssets

default ListProjectAssetsResponse listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.

Parameters:

listProjectAssetsRequest -

Returns:

Result of the ListProjectAssets operation returned by the service.

See Also:

• AWS API Documentation

listProjectAssets

default ListProjectAssetsResponse listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.

This is a convenience which creates an instance of the ListProjectAssetsRequest.Builder avoiding the need to create one manually via ListProjectAssetsRequest.builder()

Parameters:

listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.Builder to create a request.

Returns:

Result of the ListProjectAssets operation returned by the service.

See Also:

• AWS API Documentation

listProjectAssetsPaginator

default ListProjectAssetsIterable listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest)
                                                      throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client
             .listProjectAssetsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest) operation.

Parameters:

listProjectAssetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjectAssetsPaginator

default ListProjectAssetsIterable listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
                                                      throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client
             .listProjectAssetsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest) operation.

This is a convenience which creates an instance of the ListProjectAssetsRequest.Builder avoiding the need to create one manually via ListProjectAssetsRequest.builder()

Parameters:

listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

Parameters:

listProjectsRequest -

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation.

Parameters:

listProjectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
ConflictingOperationException,
LimitExceededException,
UnauthorizedException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves the list of tags for an IoT SiteWise resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
ConflictingOperationException,
LimitExceededException,
UnauthorizedException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves the list of tags for an IoT SiteWise resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTimeSeries

default ListTimeSeriesResponse listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of time series (data streams).

Parameters:

listTimeSeriesRequest -

Returns:

Result of the ListTimeSeries operation returned by the service.

See Also:

• AWS API Documentation

listTimeSeries

default ListTimeSeriesResponse listTimeSeries(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Retrieves a paginated list of time series (data streams).

This is a convenience which creates an instance of the ListTimeSeriesRequest.Builder avoiding the need to create one manually via ListTimeSeriesRequest.builder()

Parameters:

listTimeSeriesRequest - A Consumer that will call methods on ListTimeSeriesRequest.Builder to create a request.

Returns:

Result of the ListTimeSeries operation returned by the service.

See Also:

• AWS API Documentation

listTimeSeriesPaginator

default ListTimeSeriesIterable listTimeSeriesPaginator(ListTimeSeriesRequest listTimeSeriesRequest)
                                                throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client
             .listTimeSeriesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest) operation.

Parameters:

listTimeSeriesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTimeSeriesPaginator

default ListTimeSeriesIterable listTimeSeriesPaginator(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest)
                                                throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

This is a variant of listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client
             .listTimeSeriesPaginator(request);
     for (software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest) operation.

This is a convenience which creates an instance of the ListTimeSeriesRequest.Builder avoiding the need to create one manually via ListTimeSeriesRequest.builder()

Parameters:

listTimeSeriesRequest - A Consumer that will call methods on ListTimeSeriesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putDefaultEncryptionConfiguration

default PutDefaultEncryptionConfigurationResponse putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)
                                                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

Parameters:

putDefaultEncryptionConfigurationRequest -

Returns:

Result of the PutDefaultEncryptionConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putDefaultEncryptionConfiguration

default PutDefaultEncryptionConfigurationResponse putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest)
                                                                             throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the PutDefaultEncryptionConfigurationRequest.Builder avoiding the need to create one manually via PutDefaultEncryptionConfigurationRequest.builder()

Parameters:

putDefaultEncryptionConfigurationRequest - A Consumer that will call methods on PutDefaultEncryptionConfigurationRequest.Builder to create a request.

Returns:

Result of the PutDefaultEncryptionConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putLoggingOptions

default PutLoggingOptionsResponse putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
                                             throws InvalidRequestException,
ThrottlingException,
InternalFailureException,
ConflictingOperationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Sets logging options for IoT SiteWise.

Parameters:

putLoggingOptionsRequest -

Returns:

Result of the PutLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

putLoggingOptions

default PutLoggingOptionsResponse putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)
                                             throws InvalidRequestException,
ThrottlingException,
InternalFailureException,
ConflictingOperationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Sets logging options for IoT SiteWise.

This is a convenience which creates an instance of the PutLoggingOptionsRequest.Builder avoiding the need to create one manually via PutLoggingOptionsRequest.builder()

Parameters:

putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.Builder to create a request.

Returns:

Result of the PutLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

putStorageConfiguration

default PutStorageConfigurationResponse putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest)
                                                         throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Configures storage settings for IoT SiteWise.

Parameters:

putStorageConfigurationRequest -

Returns:

Result of the PutStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putStorageConfiguration

default PutStorageConfigurationResponse putStorageConfiguration(Consumer<PutStorageConfigurationRequest.Builder> putStorageConfigurationRequest)
                                                         throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Configures storage settings for IoT SiteWise.

This is a convenience which creates an instance of the PutStorageConfigurationRequest.Builder avoiding the need to create one manually via PutStorageConfigurationRequest.builder()

Parameters:

putStorageConfigurationRequest - A Consumer that will call methods on PutStorageConfigurationRequest.Builder to create a request.

Returns:

Result of the PutStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
ConflictingOperationException,
LimitExceededException,
UnauthorizedException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
ConflictingOperationException,
LimitExceededException,
UnauthorizedException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
ConflictingOperationException,
LimitExceededException,
UnauthorizedException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Removes a tag from an IoT SiteWise resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InvalidRequestException,
InternalFailureException,
ThrottlingException,
ResourceNotFoundException,
ConflictingOperationException,
LimitExceededException,
UnauthorizedException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Removes a tag from an IoT SiteWise resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateAccessPolicy

default UpdateAccessPolicyResponse updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

Parameters:

updateAccessPolicyRequest -

Returns:

Result of the UpdateAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

updateAccessPolicy

default UpdateAccessPolicyResponse updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)
                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

This is a convenience which creates an instance of the UpdateAccessPolicyRequest.Builder avoiding the need to create one manually via UpdateAccessPolicyRequest.builder()

Parameters:

updateAccessPolicyRequest - A Consumer that will call methods on UpdateAccessPolicyRequest.Builder to create a request.

Returns:

Result of the UpdateAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

updateAsset

default UpdateAssetResponse updateAsset(UpdateAssetRequest updateAssetRequest)
                                 throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

Parameters:

updateAssetRequest -

Returns:

Result of the UpdateAsset operation returned by the service.

See Also:

• AWS API Documentation

updateAsset

default UpdateAssetResponse updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest)
                                 throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

This is a convenience which creates an instance of the UpdateAssetRequest.Builder avoiding the need to create one manually via UpdateAssetRequest.builder()

Parameters:

updateAssetRequest - A Consumer that will call methods on UpdateAssetRequest.Builder to create a request.

Returns:

Result of the UpdateAsset operation returned by the service.

See Also:

• AWS API Documentation

updateAssetModel

default UpdateAssetModelResponse updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
                                           throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
LimitExceededException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

Parameters:

updateAssetModelRequest -

Returns:

Result of the UpdateAssetModel operation returned by the service.

See Also:

• AWS API Documentation

updateAssetModel

default UpdateAssetModelResponse updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest)
                                           throws InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
InternalFailureException,
LimitExceededException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

This is a convenience which creates an instance of the UpdateAssetModelRequest.Builder avoiding the need to create one manually via UpdateAssetModelRequest.builder()

Parameters:

updateAssetModelRequest - A Consumer that will call methods on UpdateAssetModelRequest.Builder to create a request.

Returns:

Result of the UpdateAssetModel operation returned by the service.

See Also:

• AWS API Documentation

updateAssetModelCompositeModel

default UpdateAssetModelCompositeModelResponse updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest updateAssetModelCompositeModelRequest)
                                                                       throws ConflictingOperationException,
InternalFailureException,
InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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:

1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

2. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Parameters:

updateAssetModelCompositeModelRequest -

Returns:

Result of the UpdateAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

updateAssetModelCompositeModel

default UpdateAssetModelCompositeModelResponse updateAssetModelCompositeModel(Consumer<UpdateAssetModelCompositeModelRequest.Builder> updateAssetModelCompositeModelRequest)
                                                                       throws ConflictingOperationException,
InternalFailureException,
InvalidRequestException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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:

1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

2. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

This is a convenience which creates an instance of the UpdateAssetModelCompositeModelRequest.Builder avoiding the need to create one manually via UpdateAssetModelCompositeModelRequest.builder()

Parameters:

updateAssetModelCompositeModelRequest - A Consumer that will call methods on UpdateAssetModelCompositeModelRequest.Builder to create a request.

Returns:

Result of the UpdateAssetModelCompositeModel operation returned by the service.

See Also:

• AWS API Documentation

updateAssetProperty

default UpdateAssetPropertyResponse updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

Parameters:

updateAssetPropertyRequest -

Returns:

Result of the UpdateAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

updateAssetProperty

default UpdateAssetPropertyResponse updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest)
                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

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.

This is a convenience which creates an instance of the UpdateAssetPropertyRequest.Builder avoiding the need to create one manually via UpdateAssetPropertyRequest.builder()

Parameters:

updateAssetPropertyRequest - A Consumer that will call methods on UpdateAssetPropertyRequest.Builder to create a request.

Returns:

Result of the UpdateAssetProperty operation returned by the service.

See Also:

• AWS API Documentation

updateDashboard

default UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an IoT SiteWise Monitor dashboard.

Parameters:

updateDashboardRequest -

Returns:

Result of the UpdateDashboard operation returned by the service.

See Also:

• AWS API Documentation

updateDashboard

default UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an IoT SiteWise Monitor dashboard.

This is a convenience which creates an instance of the UpdateDashboardRequest.Builder avoiding the need to create one manually via UpdateDashboardRequest.builder()

Parameters:

updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.

Returns:

Result of the UpdateDashboard operation returned by the service.

See Also:

• AWS API Documentation

updateGateway

default UpdateGatewayResponse updateGateway(UpdateGatewayRequest updateGatewayRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
ConflictingOperationException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates a gateway's name.

Parameters:

updateGatewayRequest -

Returns:

Result of the UpdateGateway operation returned by the service.

See Also:

• AWS API Documentation

updateGateway

default UpdateGatewayResponse updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
ConflictingOperationException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates a gateway's name.

This is a convenience which creates an instance of the UpdateGatewayRequest.Builder avoiding the need to create one manually via UpdateGatewayRequest.builder()

Parameters:

updateGatewayRequest - A Consumer that will call methods on UpdateGatewayRequest.Builder to create a request.

Returns:

Result of the UpdateGateway operation returned by the service.

See Also:

• AWS API Documentation

updateGatewayCapabilityConfiguration

default UpdateGatewayCapabilityConfigurationResponse updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
                                                                                   throws InvalidRequestException,
ResourceNotFoundException,
ConflictingOperationException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

Parameters:

updateGatewayCapabilityConfigurationRequest -

Returns:

Result of the UpdateGatewayCapabilityConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateGatewayCapabilityConfiguration

default UpdateGatewayCapabilityConfigurationResponse updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest)
                                                                                   throws InvalidRequestException,
ResourceNotFoundException,
ConflictingOperationException,
InternalFailureException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

This is a convenience which creates an instance of the UpdateGatewayCapabilityConfigurationRequest.Builder avoiding the need to create one manually via UpdateGatewayCapabilityConfigurationRequest.builder()

Parameters:

updateGatewayCapabilityConfigurationRequest - A Consumer that will call methods on UpdateGatewayCapabilityConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateGatewayCapabilityConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updatePortal

default UpdatePortalResponse updatePortal(UpdatePortalRequest updatePortalRequest)
                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an IoT SiteWise Monitor portal.

Parameters:

updatePortalRequest -

Returns:

Result of the UpdatePortal operation returned by the service.

See Also:

• AWS API Documentation

updatePortal

default UpdatePortalResponse updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)
                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
ConflictingOperationException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an IoT SiteWise Monitor portal.

This is a convenience which creates an instance of the UpdatePortalRequest.Builder avoiding the need to create one manually via UpdatePortalRequest.builder()

Parameters:

updatePortalRequest - A Consumer that will call methods on UpdatePortalRequest.Builder to create a request.

Returns:

Result of the UpdatePortal operation returned by the service.

See Also:

• AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an IoT SiteWise Monitor project.

Parameters:

updateProjectRequest -

Returns:

Result of the UpdateProject operation returned by the service.

See Also:

• AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTSiteWiseException

Updates an IoT SiteWise Monitor project.

This is a convenience which creates an instance of the UpdateProjectRequest.Builder avoiding the need to create one manually via UpdateProjectRequest.builder()

Parameters:

updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.

Returns:

Result of the UpdateProject operation returned by the service.

See Also:

• AWS API Documentation

waiter

default IoTSiteWiseWaiter waiter()

Create an instance of IoTSiteWiseWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of IoTSiteWiseWaiter

create

static IoTSiteWiseClient create()

Create a IoTSiteWiseClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IoTSiteWiseClientBuilder builder()

Create a builder that can be used to configure and create a IoTSiteWiseClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IoTSiteWiseServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration