Iotsitewise

This page documents function available when using the Iotsitewise module, created with @service Iotsitewise.

Index

Documentation

Main.Iotsitewise.associate_assetsMethod
associate_assets(asset_id, child_asset_id, hierarchy_id)
associate_assets(asset_id, child_asset_id, hierarchy_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the parent asset.
  • child_asset_id: The ID of the child asset to be associated.
  • hierarchy_id: The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.associate_time_series_to_asset_propertyMethod
associate_time_series_to_asset_property(alias, asset_id, property_id)
associate_time_series_to_asset_property(alias, asset_id, property_id, params::Dict{String,<:Any})

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

Arguments

  • alias: The alias that identifies the time series.
  • asset_id: The ID of the asset in which the asset property was created.
  • property_id: The ID of the asset property.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.batch_associate_project_assetsMethod
batch_associate_project_assets(asset_ids, project_id)
batch_associate_project_assets(asset_ids, project_id, params::Dict{String,<:Any})

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

Arguments

  • asset_ids: The IDs of the assets to be associated to the project.
  • project_id: The ID of the project to which to associate the assets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.batch_disassociate_project_assetsMethod
batch_disassociate_project_assets(asset_ids, project_id)
batch_disassociate_project_assets(asset_ids, project_id, params::Dict{String,<:Any})

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

Arguments

  • asset_ids: The IDs of the assets to be disassociated from the project.
  • project_id: The ID of the project from which to disassociate the assets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.batch_get_asset_property_aggregatesMethod
batch_get_asset_property_aggregates(entries)
batch_get_asset_property_aggregates(entries, params::Dict{String,<:Any})

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.

Arguments

  • entries: The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 1 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 4000.
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.batch_get_asset_property_valueMethod
batch_get_asset_property_value(entries)
batch_get_asset_property_value(entries, params::Dict{String,<:Any})

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

Arguments

  • entries: The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.batch_get_asset_property_value_historyMethod
batch_get_asset_property_value_history(entries)
batch_get_asset_property_value_history(entries, params::Dict{String,<:Any})

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

Arguments

  • entries: The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 4 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.batch_put_asset_property_valueMethod
batch_put_asset_property_value(entries)
batch_put_asset_property_value(entries, params::Dict{String,<:Any})

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.

Arguments

  • entries: The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.
Main.Iotsitewise.create_access_policyMethod
create_access_policy(access_policy_identity, access_policy_permission, access_policy_resource)
create_access_policy(access_policy_identity, access_policy_permission, access_policy_resource, params::Dict{String,<:Any})

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.

Arguments

  • access_policy_identity: The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
  • access_policy_permission: The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
  • access_policy_resource: The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "tags": A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.create_assetMethod
create_asset(asset_model_id, asset_name)
create_asset(asset_model_id, asset_name, params::Dict{String,<:Any})

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

Arguments

  • asset_model_id: The ID of the asset model from which to create the asset.
  • asset_name: A friendly name for the asset.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetDescription": A description for the asset.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "tags": A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.create_asset_modelMethod
create_asset_model(asset_model_name)
create_asset_model(asset_model_name, params::Dict{String,<:Any})

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.

Arguments

  • asset_model_name: A unique, friendly name for the asset model.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetModelCompositeModels": The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
  • "assetModelDescription": A description for the asset model.
  • "assetModelHierarchies": The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
  • "assetModelProperties": The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "tags": A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.create_bulk_import_jobMethod
create_bulk_import_job(error_report_location, files, job_configuration, job_name, job_role_arn)
create_bulk_import_job(error_report_location, files, job_configuration, job_name, job_role_arn, params::Dict{String,<:Any})

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. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.

Arguments

  • error_report_location: The Amazon S3 destination where errors associated with the job creation request are saved.
  • files: The files in the specified Amazon S3 bucket that contain your data.
  • job_configuration: Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
  • job_name: The unique name that helps identify the job request.
  • job_role_arn: The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
Main.Iotsitewise.create_dashboardMethod
create_dashboard(dashboard_definition, dashboard_name, project_id)
create_dashboard(dashboard_definition, dashboard_name, project_id, params::Dict{String,<:Any})

Creates a dashboard in an IoT SiteWise Monitor project.

Arguments

  • dashboard_definition: The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
  • dashboard_name: A friendly name for the dashboard.
  • project_id: The ID of the project in which to create the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "dashboardDescription": A description for the dashboard.
  • "tags": A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.create_gatewayMethod
create_gateway(gateway_name, gateway_platform)
create_gateway(gateway_name, gateway_platform, params::Dict{String,<:Any})

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.

Arguments

  • gateway_name: A unique, friendly name for the gateway.
  • gateway_platform: The gateway's platform. You can only specify one platform in a gateway.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.create_portalMethod
create_portal(portal_contact_email, portal_name, role_arn)
create_portal(portal_contact_email, portal_name, role_arn, params::Dict{String,<:Any})

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.

Arguments

  • portal_contact_email: The Amazon Web Services administrator's contact email address.
  • portal_name: A friendly name for the portal.
  • role_arn: The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alarms": Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "notificationSenderEmail": The email address that sends alarm notifications. If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
  • "portalAuthMode": The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses IAM Identity Center (successor to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: SSO
  • "portalDescription": A description for the portal.
  • "portalLogoImageFile": A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
  • "tags": A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.create_projectMethod
create_project(portal_id, project_name)
create_project(portal_id, project_name, params::Dict{String,<:Any})

Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information.

Arguments

  • portal_id: The ID of the portal in which to create the project.
  • project_name: A friendly name for the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "projectDescription": A description for the project.
  • "tags": A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.delete_access_policyMethod
delete_access_policy(access_policy_id)
delete_access_policy(access_policy_id, params::Dict{String,<:Any})

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.

Arguments

  • access_policy_id: The ID of the access policy to be deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.delete_assetMethod
delete_asset(asset_id)
delete_asset(asset_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the asset to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.delete_asset_modelMethod
delete_asset_model(asset_model_id)
delete_asset_model(asset_model_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_model_id: The ID of the asset model to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.delete_dashboardMethod
delete_dashboard(dashboard_id)
delete_dashboard(dashboard_id, params::Dict{String,<:Any})

Deletes a dashboard from IoT SiteWise Monitor.

Arguments

  • dashboard_id: The ID of the dashboard to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.delete_gatewayMethod
delete_gateway(gateway_id)
delete_gateway(gateway_id, params::Dict{String,<:Any})

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

Arguments

  • gateway_id: The ID of the gateway to delete.
Main.Iotsitewise.delete_portalMethod
delete_portal(portal_id)
delete_portal(portal_id, params::Dict{String,<:Any})

Deletes a portal from IoT SiteWise Monitor.

Arguments

  • portal_id: The ID of the portal to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.delete_projectMethod
delete_project(project_id)
delete_project(project_id, params::Dict{String,<:Any})

Deletes a project from IoT SiteWise Monitor.

Arguments

  • project_id: The ID of the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.delete_time_seriesMethod
delete_time_series()
delete_time_series(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": The alias that identifies the time series.
  • "assetId": The ID of the asset in which the asset property was created.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "propertyId": The ID of the asset property.
Main.Iotsitewise.describe_access_policyMethod
describe_access_policy(access_policy_id)
describe_access_policy(access_policy_id, params::Dict{String,<:Any})

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

Arguments

  • access_policy_id: The ID of the access policy.
Main.Iotsitewise.describe_assetMethod
describe_asset(asset_id)
describe_asset(asset_id, params::Dict{String,<:Any})

Retrieves information about an asset.

Arguments

  • asset_id: The ID of the asset.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "excludeProperties": Whether or not to exclude asset properties from the response.
Main.Iotsitewise.describe_asset_modelMethod
describe_asset_model(asset_model_id)
describe_asset_model(asset_model_id, params::Dict{String,<:Any})

Retrieves information about an asset model.

Arguments

  • asset_model_id: The ID of the asset model.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "excludeProperties": Whether or not to exclude asset model properties from the response.
Main.Iotsitewise.describe_asset_propertyMethod
describe_asset_property(asset_id, property_id)
describe_asset_property(asset_id, property_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the asset.
  • property_id: The ID of the asset property.
Main.Iotsitewise.describe_bulk_import_jobMethod
describe_bulk_import_job(job_id)
describe_bulk_import_job(job_id, params::Dict{String,<:Any})

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.

Arguments

  • job_id: The ID of the job.
Main.Iotsitewise.describe_dashboardMethod
describe_dashboard(dashboard_id)
describe_dashboard(dashboard_id, params::Dict{String,<:Any})

Retrieves information about a dashboard.

Arguments

  • dashboard_id: The ID of the dashboard.
Main.Iotsitewise.describe_default_encryption_configurationMethod
describe_default_encryption_configuration()
describe_default_encryption_configuration(params::Dict{String,<:Any})

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.

Main.Iotsitewise.describe_gatewayMethod
describe_gateway(gateway_id)
describe_gateway(gateway_id, params::Dict{String,<:Any})

Retrieves information about a gateway.

Arguments

  • gateway_id: The ID of the gateway device.
Main.Iotsitewise.describe_gateway_capability_configurationMethod
describe_gateway_capability_configuration(capability_namespace, gateway_id)
describe_gateway_capability_configuration(capability_namespace, gateway_id, params::Dict{String,<:Any})

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.

Arguments

  • capability_namespace: The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.
  • gateway_id: The ID of the gateway that defines the capability configuration.
Main.Iotsitewise.describe_portalMethod
describe_portal(portal_id)
describe_portal(portal_id, params::Dict{String,<:Any})

Retrieves information about a portal.

Arguments

  • portal_id: The ID of the portal.
Main.Iotsitewise.describe_projectMethod
describe_project(project_id)
describe_project(project_id, params::Dict{String,<:Any})

Retrieves information about a project.

Arguments

  • project_id: The ID of the project.
Main.Iotsitewise.describe_time_seriesMethod
describe_time_series()
describe_time_series(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": The alias that identifies the time series.
  • "assetId": The ID of the asset in which the asset property was created.
  • "propertyId": The ID of the asset property.
Main.Iotsitewise.disassociate_assetsMethod
disassociate_assets(asset_id, child_asset_id, hierarchy_id)
disassociate_assets(asset_id, child_asset_id, hierarchy_id, params::Dict{String,<:Any})

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

Arguments

  • asset_id: The ID of the parent asset from which to disassociate the child asset.
  • child_asset_id: The ID of the child asset to disassociate.
  • hierarchy_id: The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.disassociate_time_series_from_asset_propertyMethod
disassociate_time_series_from_asset_property(alias, asset_id, property_id)
disassociate_time_series_from_asset_property(alias, asset_id, property_id, params::Dict{String,<:Any})

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

Arguments

  • alias: The alias that identifies the time series.
  • asset_id: The ID of the asset in which the asset property was created.
  • property_id: The ID of the asset property.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.get_asset_property_aggregatesMethod
get_asset_property_aggregates(aggregate_types, end_date, resolution, start_date)
get_asset_property_aggregates(aggregate_types, end_date, resolution, start_date, params::Dict{String,<:Any})

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.

Arguments

  • aggregate_types: The data aggregating function.
  • end_date: The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • resolution: The time interval over which to aggregate data.
  • start_date: The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetId": The ID of the asset.
  • "maxResults": The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 1 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 250.
  • "nextToken": The token to be used for the next set of paginated results.
  • "propertyAlias": The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
  • "propertyId": The ID of the asset property.
  • "qualities": The quality by which to filter asset data.
  • "timeOrdering": The chronological sorting order of the requested information. Default: ASCENDING
Main.Iotsitewise.get_asset_property_valueMethod
get_asset_property_value()
get_asset_property_value(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetId": The ID of the asset.
  • "propertyAlias": The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
  • "propertyId": The ID of the asset property.
Main.Iotsitewise.get_asset_property_value_historyMethod
get_asset_property_value_history()
get_asset_property_value_history(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetId": The ID of the asset.
  • "endDate": The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • "maxResults": The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 4 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
  • "nextToken": The token to be used for the next set of paginated results.
  • "propertyAlias": The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
  • "propertyId": The ID of the asset property.
  • "qualities": The quality by which to filter asset data.
  • "startDate": The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • "timeOrdering": The chronological sorting order of the requested information. Default: ASCENDING
Main.Iotsitewise.get_interpolated_asset_property_valuesMethod
get_interpolated_asset_property_values(end_time_in_seconds, interval_in_seconds, quality, start_time_in_seconds, type)
get_interpolated_asset_property_values(end_time_in_seconds, interval_in_seconds, quality, start_time_in_seconds, type, params::Dict{String,<:Any})

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.

Arguments

  • end_time_in_seconds: The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
  • interval_in_seconds: The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
  • quality: The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
  • start_time_in_seconds: The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
  • type: The interpolation type. Valid values: LINEARINTERPOLATION | LOCFINTERPOLATION LINEARINTERPOLATION – Estimates missing data using linear interpolation. 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. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on. LOCFINTERPOLATION – Estimates missing data using last observation carried forward interpolation If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found. For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetId": The ID of the asset.
  • "endTimeOffsetInNanos": The nanosecond offset converted from endTimeInSeconds.
  • "intervalWindowInSeconds": The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval. If you specify a value for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION. If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points. For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
  • "maxResults": The maximum number of results to return for each paginated request. If not specified, the default value is 10.
  • "nextToken": The token to be used for the next set of paginated results.
  • "propertyAlias": The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
  • "propertyId": The ID of the asset property.
  • "startTimeOffsetInNanos": The nanosecond offset converted from startTimeInSeconds.
Main.Iotsitewise.list_access_policiesMethod
list_access_policies()
list_access_policies(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "iamArn": The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.
  • "identityId": The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.
  • "identityType": The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.
  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
  • "resourceId": The ID of the resource. This parameter is required if you specify resourceType.
  • "resourceType": The type of resource (portal or project). This parameter is required if you specify resourceId.
Main.Iotsitewise.list_asset_model_propertiesMethod
list_asset_model_properties(asset_model_id)
list_asset_model_properties(asset_model_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_model_id: The ID of the asset model.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": Filters the requested list of asset model properties. You can choose one of the following options: ALL – The list includes all asset model properties for a given asset model ID. BASE – The list includes only base asset model properties for a given asset model ID. Default: BASE
  • "maxResults": The maximum number of results to return for each paginated request. If not specified, the default value is 50.
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_asset_modelsMethod
list_asset_models()
list_asset_models(params::Dict{String,<:Any})

Retrieves a paginated list of summaries of all asset models.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_asset_propertiesMethod
list_asset_properties(asset_id)
list_asset_properties(asset_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the asset.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": Filters the requested list of asset properties. You can choose one of the following options: ALL – The list includes all asset properties for a given asset model ID. BASE – The list includes only base asset properties for a given asset model ID. Default: BASE
  • "maxResults": The maximum number of results to return for each paginated request. If not specified, the default value is 50.
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_asset_relationshipsMethod
list_asset_relationships(asset_id, traversal_type)
list_asset_relationships(asset_id, traversal_type, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the asset.
  • traversal_type: The type of traversal to use to identify asset relationships. Choose the following option: PATHTOROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request.
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_assetsMethod
list_assets()
list_assets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetModelId": The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.
  • "filter": The filter for the requested list of assets. Choose one of the following options: ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL. TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree. Default: ALL
  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_associated_assetsMethod
list_associated_assets(asset_id)
list_associated_assets(asset_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the asset to query.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "hierarchyId": The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
  • "traversalDirection": The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes the asset's parent asset. Default: CHILD
Main.Iotsitewise.list_bulk_import_jobsMethod
list_bulk_import_jobs()
list_bulk_import_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": You can use a filter to select the bulk import jobs that you want to retrieve.
  • "maxResults": The maximum number of results to return for each paginated request.
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_dashboardsMethod
list_dashboards(project_id)
list_dashboards(project_id, params::Dict{String,<:Any})

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

Arguments

  • project_id: The ID of the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_gatewaysMethod
list_gateways()
list_gateways(params::Dict{String,<:Any})

Retrieves a paginated list of gateways.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_portalsMethod
list_portals()
list_portals(params::Dict{String,<:Any})

Retrieves a paginated list of IoT SiteWise Monitor portals.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_project_assetsMethod
list_project_assets(project_id)
list_project_assets(project_id, params::Dict{String,<:Any})

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

Arguments

  • project_id: The ID of the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_projectsMethod
list_projects(portal_id)
list_projects(portal_id, params::Dict{String,<:Any})

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

Arguments

  • portal_id: The ID of the portal.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for each paginated request. Default: 50
  • "nextToken": The token to be used for the next set of paginated results.
Main.Iotsitewise.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Retrieves the list of tags for an IoT SiteWise resource.

Arguments

  • resource_arn: The ARN of the resource.
Main.Iotsitewise.list_time_seriesMethod
list_time_series()
list_time_series(params::Dict{String,<:Any})

Retrieves a paginated list of time series (data streams).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "aliasPrefix": The alias prefix of the time series.
  • "assetId": The ID of the asset in which the asset property was created.
  • "maxResults": The maximum number of results to return for each paginated request.
  • "nextToken": The token to be used for the next set of paginated results.
  • "timeSeriesType": The type of the time series. The time series type can be one of the following values: ASSOCIATED – The time series is associated with an asset property. DISASSOCIATED – The time series isn't associated with any asset property.
Main.Iotsitewise.put_default_encryption_configurationMethod
put_default_encryption_configuration(encryption_type)
put_default_encryption_configuration(encryption_type, params::Dict{String,<:Any})

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

Arguments

  • encryption_type: The type of encryption used for the encryption configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "kmsKeyId": The Key ID of the customer managed key used for KMS encryption. This is required if you use KMSBASEDENCRYPTION.
Main.Iotsitewise.put_logging_optionsMethod
put_logging_options(logging_options)
put_logging_options(logging_options, params::Dict{String,<:Any})

Sets logging options for IoT SiteWise.

Arguments

  • logging_options: The logging options to set.
Main.Iotsitewise.put_storage_configurationMethod
put_storage_configuration(storage_type)
put_storage_configuration(storage_type, params::Dict{String,<:Any})

Configures storage settings for IoT SiteWise.

Arguments

  • storage_type: The storage tier that you specified for your data. The storageType parameter can be one of the following values: SITEWISEDEFAULTSTORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database. MULTILAYERSTORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "disassociatedDataStorage": Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values: ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties. After the disassociatedDataStorage is enabled, you can't disable it. DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties. For more information, see Data streams in the IoT SiteWise User Guide.
  • "multiLayerStorage": Identifies a storage destination. If you specified MULTILAYERSTORAGE for the storage type, you must specify a MultiLayerStorage object.
  • "retentionPeriod":
Main.Iotsitewise.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the resource to tag.
  • tags: A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Main.Iotsitewise.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from an IoT SiteWise resource.

Arguments

  • resource_arn: The ARN of the resource to untag.
  • tag_keys: A list of keys for tags to remove from the resource.
Main.Iotsitewise.update_access_policyMethod
update_access_policy(access_policy_id, access_policy_identity, access_policy_permission, access_policy_resource)
update_access_policy(access_policy_id, access_policy_identity, access_policy_permission, access_policy_resource, params::Dict{String,<:Any})

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

Arguments

  • access_policy_id: The ID of the access policy.
  • access_policy_identity: The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
  • access_policy_permission: The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
  • access_policy_resource: The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.update_assetMethod
update_asset(asset_id, asset_name)
update_asset(asset_id, asset_name, params::Dict{String,<:Any})

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

Arguments

  • asset_id: The ID of the asset to update.
  • asset_name: A friendly name for the asset.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetDescription": A description for the asset.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.update_asset_modelMethod
update_asset_model(asset_model_id, asset_model_name)
update_asset_model(asset_model_id, asset_model_name, params::Dict{String,<:Any})

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.

Arguments

  • asset_model_id: The ID of the asset model to update.
  • asset_model_name: A unique, friendly name for the asset model.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assetModelCompositeModels": The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
  • "assetModelDescription": A description for the asset model.
  • "assetModelHierarchies": The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
  • "assetModelProperties": The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Main.Iotsitewise.update_asset_propertyMethod
update_asset_property(asset_id, property_id)
update_asset_property(asset_id, property_id, params::Dict{String,<:Any})

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.

Arguments

  • asset_id: The ID of the asset to be updated.
  • property_id: The ID of the asset property to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "propertyAlias": The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. If you omit this parameter, the alias is removed from the property.
  • "propertyNotificationState": The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide. If you omit this parameter, the notification state is set to DISABLED.
  • "propertyUnit": The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
Main.Iotsitewise.update_dashboardMethod
update_dashboard(dashboard_definition, dashboard_id, dashboard_name)
update_dashboard(dashboard_definition, dashboard_id, dashboard_name, params::Dict{String,<:Any})

Updates an IoT SiteWise Monitor dashboard.

Arguments

  • dashboard_definition: The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
  • dashboard_id: The ID of the dashboard to update.
  • dashboard_name: A new friendly name for the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "dashboardDescription": A new description for the dashboard.
Main.Iotsitewise.update_gatewayMethod
update_gateway(gateway_id, gateway_name)
update_gateway(gateway_id, gateway_name, params::Dict{String,<:Any})

Updates a gateway's name.

Arguments

  • gateway_id: The ID of the gateway to update.
  • gateway_name: A unique, friendly name for the gateway.
Main.Iotsitewise.update_gateway_capability_configurationMethod
update_gateway_capability_configuration(capability_configuration, capability_namespace, gateway_id)
update_gateway_capability_configuration(capability_configuration, capability_namespace, gateway_id, params::Dict{String,<:Any})

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.

Arguments

  • capability_configuration: The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
  • capability_namespace: The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.
  • gateway_id: The ID of the gateway to be updated.
Main.Iotsitewise.update_portalMethod
update_portal(portal_contact_email, portal_id, portal_name, role_arn)
update_portal(portal_contact_email, portal_id, portal_name, role_arn, params::Dict{String,<:Any})

Updates an IoT SiteWise Monitor portal.

Arguments

  • portal_contact_email: The Amazon Web Services administrator's contact email address.
  • portal_id: The ID of the portal to update.
  • portal_name: A new friendly name for the portal.
  • role_arn: The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alarms": Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "notificationSenderEmail": The email address that sends alarm notifications.
  • "portalDescription": A new description for the portal.
  • "portalLogoImage":
Main.Iotsitewise.update_projectMethod
update_project(project_id, project_name)
update_project(project_id, project_name, params::Dict{String,<:Any})

Updates an IoT SiteWise Monitor project.

Arguments

  • project_id: The ID of the project to update.
  • project_name: A new friendly name for the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • "projectDescription": A new description for the project.