Iotsitewise

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

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

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

batch_put_asset_property_value(entries)
batch_put_asset_property_value(entries, params::Dict{String,<:Any})

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 7 days in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +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.

Arguments

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

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 (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

Arguments

• access_policy_identity: The identity for this access policy. Choose an AWS SSO user, an AWS SSO 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 AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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

Arguments

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

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 asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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 AWS 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 AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
• "assetModelProperties": The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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 AWS IoT SiteWise Monitor project.

Arguments

• dashboard_definition: The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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 AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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. AWS IoT SiteWise Monitor uses AWS SSO 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 AWS IoT SiteWise User Guide.

Arguments

• portal_contact_email: The AWS 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 AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS 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.
• "portalAuthMode": The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions. IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions. 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

create_project(portal_id, project_name)
create_project(portal_id, project_name, params::Dict{String,<:Any})

Creates a project in the specified portal.

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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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 AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS 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.

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

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

delete_dashboard(dashboard_id)
delete_dashboard(dashboard_id, params::Dict{String,<:Any})

Deletes a dashboard from AWS 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.

delete_gateway(gateway_id)
delete_gateway(gateway_id, params::Dict{String,<:Any})

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.

Arguments

• gateway_id: The ID of the gateway to delete.

delete_portal(portal_id)
delete_portal(portal_id, params::Dict{String,<:Any})

Deletes a portal from AWS 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.

delete_project(project_id)
delete_project(project_id, params::Dict{String,<:Any})

Deletes a project from AWS 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.

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 AWS IoT SiteWise Monitor portal or project.

Arguments

• access_policy_id: The ID of the access policy.

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.

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.

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.

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.

describe_default_encryption_configuration()
describe_default_encryption_configuration(params::Dict{String,<:Any})

Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.

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.

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

Arguments

• capability_namespace: The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS 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.

describe_logging_options()
describe_logging_options(params::Dict{String,<:Any})

Retrieves the current AWS IoT SiteWise logging options.

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.

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.

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

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

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 be returned per paginated request. Default: 100
• "nextToken": The token to be used for the next set of paginated results.
• "propertyAlias": The property 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 AWS 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

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

Optional Parameters

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

• "assetId": The ID of the asset.
• "propertyAlias": The property 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 AWS IoT SiteWise User Guide.
• "propertyId": The ID of the asset property.

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

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 be returned per paginated request. Default: 100
• "nextToken": The token to be used for the next set of paginated results.
• "propertyAlias": The property 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 AWS 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

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. For example, you can use the 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: LINEAR_INTERPOLATION

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.
• "maxResults": The maximum number of results to be returned per 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 property 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 AWS IoT SiteWise User Guide.
• "propertyId": The ID of the asset property.
• "startTimeOffsetInNanos": The nanosecond offset converted from startTimeInSeconds.

list_access_policies()
list_access_policies(params::Dict{String,<:Any})

Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS 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 (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify identityId.
• "maxResults": The maximum number of results to be returned per 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.

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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

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 be returned per paginated request.
• "nextToken": The token to be used for the next set of paginated results.

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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

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 AWS IoT SiteWise User Guide.
• "maxResults": The maximum number of results to be returned per 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

list_dashboards(project_id)
list_dashboards(project_id, params::Dict{String,<:Any})

Retrieves a paginated list of dashboards for an AWS 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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

list_portals()
list_portals(params::Dict{String,<:Any})

Retrieves a paginated list of AWS 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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

list_project_assets(project_id)
list_project_assets(project_id, params::Dict{String,<:Any})

Retrieves a paginated list of assets associated with an AWS 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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

list_projects(portal_id)
list_projects(portal_id, params::Dict{String,<:Any})

Retrieves a paginated list of projects for an AWS 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 be returned per paginated request. Default: 50
• "nextToken": The token to be used for the next set of paginated results.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The ARN of the resource.

put_default_encryption_configuration(encryption_type)
put_default_encryption_configuration(encryption_type, params::Dict{String,<:Any})

Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS 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 customer master key (CMK) used for AWS KMS encryption. This is required if you use KMSBASEDENCRYPTION.

put_logging_options(logging_options)
put_logging_options(logging_options, params::Dict{String,<:Any})

Sets logging options for AWS IoT SiteWise.

Arguments

• logging_options: The logging options to set.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds tags to an AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from an AWS 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.

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 AWS 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 AWS SSO user, an AWS SSO 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 AWS 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.

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

Arguments

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

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.

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

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 AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
• "assetModelProperties": The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS 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.

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 property 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 AWS 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, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide. If you omit this parameter, the notification state is set to DISABLED.

update_dashboard(dashboard_definition, dashboard_id, dashboard_name)
update_dashboard(dashboard_definition, dashboard_id, dashboard_name, params::Dict{String,<:Any})

Updates an AWS 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 AWS 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.

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.

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

Arguments

• capability_configuration: The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS 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 AWS 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.

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 AWS IoT SiteWise Monitor portal.

Arguments

• portal_contact_email: The AWS 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 AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS 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.
• "portalDescription": A new description for the portal.
• "portalLogoImage":

update_project(project_id, project_name)
update_project(project_id, project_name, params::Dict{String,<:Any})

Updates an AWS 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.