IoTSiteWise

public struct IoTSiteWise

Client object for interacting with AWS IoTSiteWise service.

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

Member variables

Initialization

  • Initialize the IoTSiteWise client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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 AWS IoT SiteWise User Guide.

    Declaration

    Swift

    @discardableResult
public func associateAssets(_ input: AssociateAssetsRequest) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func batchAssociateProjectAssets(_ input: BatchAssociateProjectAssetsRequest) -> EventLoopFuture<BatchAssociateProjectAssetsResponse>

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

    Declaration

    Swift

    public func batchDisassociateProjectAssets(_ input: BatchDisassociateProjectAssetsRequest) -> EventLoopFuture<BatchDisassociateProjectAssetsResponse>

  • Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS 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, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error. For each asset property, AWS 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. AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public func batchPutAssetPropertyValue(_ input: BatchPutAssetPropertyValueRequest) -> EventLoopFuture<BatchPutAssetPropertyValueResponse>

  • Creates an access policy that grants the specified AWS Single Sign-On user or group access to the specified AWS IoT SiteWise Monitor portal or project resource.

    Declaration

    Swift

    public func createAccessPolicy(_ input: CreateAccessPolicyRequest) -> EventLoopFuture<CreateAccessPolicyResponse>

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

    Declaration

    Swift

    public func createAsset(_ input: CreateAssetRequest) -> EventLoopFuture<CreateAssetResponse>

  • 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 AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public func createAssetModel(_ input: CreateAssetModelRequest) -> EventLoopFuture<CreateAssetModelResponse>

  • Creates a dashboard in an AWS IoT SiteWise Monitor project.

    Declaration

    Swift

    public func createDashboard(_ input: CreateDashboardRequest) -> EventLoopFuture<CreateDashboardResponse>

  • Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public func createGateway(_ input: CreateGatewayRequest) -> EventLoopFuture<CreateGatewayResponse>

  • Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable AWS Single Sign-On. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. Before you can sign in to a new portal, you must add at least one AWS SSO user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public func createPortal(_ input: CreatePortalRequest) -> EventLoopFuture<CreatePortalResponse>

  • Creates a project in the specified portal.

    Declaration

    Swift

    public func createProject(_ input: CreateProjectRequest) -> EventLoopFuture<CreateProjectResponse>

  • Deletes an access policy that grants the specified AWS Single Sign-On identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.

    Declaration

    Swift

    public func deleteAccessPolicy(_ input: DeleteAccessPolicyRequest) -> EventLoopFuture<DeleteAccessPolicyResponse>

  • Deletes an asset. This action can’t be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide. You can’t delete an asset that’s associated to another asset. For more information, see DisassociateAssets.

    Declaration

    Swift

    public func deleteAsset(_ input: DeleteAssetRequest) -> EventLoopFuture<DeleteAssetResponse>

  • 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 AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public func deleteAssetModel(_ input: DeleteAssetModelRequest) -> EventLoopFuture<DeleteAssetModelResponse>

  • Deletes a dashboard from AWS IoT SiteWise Monitor.

    Declaration

    Swift

    public func deleteDashboard(_ input: DeleteDashboardRequest) -> EventLoopFuture<DeleteDashboardResponse>

  • Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway’s files remain in your gateway’s file system. For more information, see Data retention in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    @discardableResult
public func deleteGateway(_ input: DeleteGatewayRequest) -> EventLoopFuture<Void>

  • Deletes a portal from AWS IoT SiteWise Monitor.

    Declaration

    Swift

    public func deletePortal(_ input: DeletePortalRequest) -> EventLoopFuture<DeletePortalResponse>

  • Deletes a project from AWS IoT SiteWise Monitor.

    Declaration

    Swift

    public func deleteProject(_ input: DeleteProjectRequest) -> EventLoopFuture<DeleteProjectResponse>

  • Describes an access policy, which specifies an AWS SSO user or group’s access to an AWS IoT SiteWise Monitor portal or project.

    Declaration

    Swift

    public func describeAccessPolicy(_ input: DescribeAccessPolicyRequest) -> EventLoopFuture<DescribeAccessPolicyResponse>

  • Retrieves information about an asset.

    Declaration

    Swift

    public func describeAsset(_ input: DescribeAssetRequest) -> EventLoopFuture<DescribeAssetResponse>

  • Retrieves information about an asset model.

    Declaration

    Swift

    public func describeAssetModel(_ input: DescribeAssetModelRequest) -> EventLoopFuture<DescribeAssetModelResponse>

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

    Declaration

    Swift

    public func describeAssetProperty(_ input: DescribeAssetPropertyRequest) -> EventLoopFuture<DescribeAssetPropertyResponse>

  • Retrieves information about a dashboard.

    Declaration

    Swift

    public func describeDashboard(_ input: DescribeDashboardRequest) -> EventLoopFuture<DescribeDashboardResponse>

  • Retrieves information about a gateway.

    Declaration

    Swift

    public func describeGateway(_ input: DescribeGatewayRequest) -> EventLoopFuture<DescribeGatewayResponse>

  • 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 AWS 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.

    Declaration

    Swift

    public func describeGatewayCapabilityConfiguration(_ input: DescribeGatewayCapabilityConfigurationRequest) -> EventLoopFuture<DescribeGatewayCapabilityConfigurationResponse>

  • Retrieves the current AWS IoT SiteWise logging options.

    Declaration

    Swift

    public func describeLoggingOptions(_ input: DescribeLoggingOptionsRequest) -> EventLoopFuture<DescribeLoggingOptionsResponse>

  • Retrieves information about a portal.

    Declaration

    Swift

    public func describePortal(_ input: DescribePortalRequest) -> EventLoopFuture<DescribePortalResponse>

  • Retrieves information about a project.

    Declaration

    Swift

    public func describeProject(_ input: DescribeProjectRequest) -> EventLoopFuture<DescribeProjectResponse>

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

    Declaration

    Swift

    @discardableResult
public func disassociateAssets(_ input: DisassociateAssetsRequest) -> EventLoopFuture<Void>

  • Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS 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.

    Declaration

    Swift

    public func getAssetPropertyAggregates(_ input: GetAssetPropertyAggregatesRequest) -> EventLoopFuture<GetAssetPropertyAggregatesResponse>

  • Gets an asset property’s current value. For more information, see Querying current values in the AWS 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.

    Declaration

    Swift

    public func getAssetPropertyValue(_ input: GetAssetPropertyValueRequest) -> EventLoopFuture<GetAssetPropertyValueResponse>

  • Gets the history of an asset property’s values. For more information, see Querying historical values in the AWS 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.

    Declaration

    Swift

    public func getAssetPropertyValueHistory(_ input: GetAssetPropertyValueHistoryRequest) -> EventLoopFuture<GetAssetPropertyValueHistoryResponse>

  • Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or project).

    Declaration

    Swift

    public func listAccessPolicies(_ input: ListAccessPoliciesRequest) -> EventLoopFuture<ListAccessPoliciesResponse>

  • Retrieves a paginated list of summaries of all asset models.

    Declaration

    Swift

    public func listAssetModels(_ input: ListAssetModelsRequest) -> EventLoopFuture<ListAssetModelsResponse>

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

    Declaration

    Swift

    public func listAssets(_ input: ListAssetsRequest) -> EventLoopFuture<ListAssetsResponse>

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

    Declaration

    Swift

    public func listAssociatedAssets(_ input: ListAssociatedAssetsRequest) -> EventLoopFuture<ListAssociatedAssetsResponse>

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

    Declaration

    Swift

    public func listDashboards(_ input: ListDashboardsRequest) -> EventLoopFuture<ListDashboardsResponse>

  • Retrieves a paginated list of gateways.

    Declaration

    Swift

    public func listGateways(_ input: ListGatewaysRequest) -> EventLoopFuture<ListGatewaysResponse>

  • Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

    Declaration

    Swift

    public func listPortals(_ input: ListPortalsRequest) -> EventLoopFuture<ListPortalsResponse>

  • Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.

    Declaration

    Swift

    public func listProjectAssets(_ input: ListProjectAssetsRequest) -> EventLoopFuture<ListProjectAssetsResponse>

  • Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.

    Declaration

    Swift

    public func listProjects(_ input: ListProjectsRequest) -> EventLoopFuture<ListProjectsResponse>

  • Retrieves the list of tags for an AWS IoT SiteWise resource.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

  • Sets logging options for AWS IoT SiteWise.

    Declaration

    Swift

    public func putLoggingOptions(_ input: PutLoggingOptionsRequest) -> EventLoopFuture<PutLoggingOptionsResponse>

  • Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag’s value.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

  • Removes a tag from an AWS IoT SiteWise resource.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

  • Updates an existing access policy that specifies an AWS SSO user or group’s access to an AWS IoT SiteWise Monitor portal or project resource.

    Declaration

    Swift

    public func updateAccessPolicy(_ input: UpdateAccessPolicyRequest) -> EventLoopFuture<UpdateAccessPolicyResponse>

  • Updates an asset’s name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public func updateAsset(_ input: UpdateAssetRequest) -> EventLoopFuture<UpdateAssetResponse>

  • 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 AWS 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 or update a property’s formula expression, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can’t change the type or data type of an existing property.

    Declaration

    Swift

    public func updateAssetModel(_ input: UpdateAssetModelRequest) -> EventLoopFuture<UpdateAssetModelResponse>

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

    Declaration

    Swift

    @discardableResult
public func updateAssetProperty(_ input: UpdateAssetPropertyRequest) -> EventLoopFuture<Void>

  • Updates an AWS IoT SiteWise Monitor dashboard.

    Declaration

    Swift

    public func updateDashboard(_ input: UpdateDashboardRequest) -> EventLoopFuture<UpdateDashboardResponse>

  • Updates a gateway’s name.

    Declaration

    Swift

    @discardableResult
public func updateGateway(_ input: UpdateGatewayRequest) -> EventLoopFuture<Void>

  • 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 AWS 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.

    Declaration

    Swift

    public func updateGatewayCapabilityConfiguration(_ input: UpdateGatewayCapabilityConfigurationRequest) -> EventLoopFuture<UpdateGatewayCapabilityConfigurationResponse>

  • Updates an AWS IoT SiteWise Monitor portal.

    Declaration

    Swift

    public func updatePortal(_ input: UpdatePortalRequest) -> EventLoopFuture<UpdatePortalResponse>

  • Updates an AWS IoT SiteWise Monitor project.

    Declaration

    Swift

    public func updateProject(_ input: UpdateProjectRequest) -> EventLoopFuture<UpdateProjectResponse>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum AggregateType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum AssetErrorCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum AssetModelState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum AssetState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum BatchPutAssetPropertyValueErrorCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum CapabilitySyncStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ErrorCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum IdentityType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ImageFileType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ListAssetsFilter : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LoggingLevel : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum MonitorErrorCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Permission : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PortalState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PropertyDataType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PropertyNotificationState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Quality : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ResourceType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TimeOrdering : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TraversalDirection : String, CustomStringConvertible, Codable