The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

The ID of the portal.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes each project in the portal.

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.

The ID of the project.

The response's http status code.

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.

A new description for the project.

The ID of the project to update.

A new friendly name for the project.

The response's http status code.

The logging options to set.

The response's http status code.

The ID of the asset model.

The list of composite asset models for the asset model.

The response's http status code.

The ID of the asset model.

The ARN of the asset model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

The name of the asset model.

The asset model's description.

The list of asset properties for the asset model.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

The date the asset model was created, in Unix epoch time.

The date the asset model was last updated, in Unix epoch time.

The current status of the asset model, which contains a state and any error message.

The ID of the asset.

The ID of the asset property.

The asset property's definition, alias, and notification state.

This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel.

The composite asset model that declares this asset property, if this asset property exists in a composite model.

The response's http status code.

The ID of the asset.

The name of the asset.

The ID of the asset model.

The ARN of the resource.

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

The response's http status code.

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.

The ID of the asset property.

The ID of the asset.

The current asset property value.

The response's http status code.

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.

The ID of the access policy to be deleted.

The response's http status code.

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.

The ID of the access policy.

The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.

The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

The response's http status code.

The ID of the gateway device.

The gateway's platform.

The response's http status code.

The ID of the gateway device.

The name of the gateway.

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

The date the gateway was created, in Unix epoch time.

The date the gateway was last updated, in Unix epoch time.

The ID of the asset.

The composite models for the asset.

The response's http status code.

The ID of the asset.

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

The name of the asset.

The ID of the asset model that was used to create the asset.

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

The date the asset was created, in Unix epoch time.

The date the asset was last updated, in Unix epoch time.

The current status of the asset, which contains a state and any error message.

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

The ID of the project.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes each dashboard in the project.

The ID of the resource. This parameter is required if you specify resourceType.

The type of resource (portal or project). This parameter is required if you specify resourceId.

The type of identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user). This parameter is required if you specify identityId.

The token to be used for the next set of paginated results.

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.

The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

The maximum number of results to return for each paginated request.

Default: 50

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes each access policy.

The ID of the project.

The project's description.

The response's http status code.

The ID of the project.

The ARN of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

The name of the project.

The ID of the portal that the project is in.

The date the project was created, in Unix epoch time.

The date the project was last updated, in Unix epoch time.

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

The quality by which to filter asset data.

The chronological sorting order of the requested information.

Default: ASCENDING

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.

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

The token to be used for the next set of paginated results.

The ID of the asset property.

The ID of the asset.

The maximum number of results to return for each paginated request.

Default: 100

The token for the next set of results, or null if there are no additional results.

The response's http status code.

The asset property's value history.

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.

A description for the dashboard.

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.

The ID of the project in which to create the dashboard.

A friendly name for the dashboard.

The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

The response's http status code.

The ID of the dashboard.

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

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.

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.

The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.

The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

The response's http status code.

The ID of the access policy.

The ARN of the access policy, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

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.

A description for the asset model.

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.

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.

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.

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.

A unique, friendly name for the asset model.

The response's http status code.

The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.

The ARN of the asset model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.

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.

The ID of the project to which to associate the assets.

The IDs of the assets to be associated to the project.

A list of associated error information, if any.

The response's http status code.

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes each asset model.

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.

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

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

The ID of the asset to query.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes the associated assets.

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

The response's http status code.

A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.

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.

The ID of the asset to delete.

The response's http status code.

The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.

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.

The ID of the asset to update.

A unique, friendly name for the asset.

The response's http status code.

The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.

The ID of the gateway to delete.

The ID of the access policy.

The response's http status code.

The ID of the access policy.

The ARN of the access policy, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) to which this access policy applies.

The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

The date the access policy was created, in Unix epoch time.

The date the access policy was last updated, in Unix epoch time.

The ID of the gateway to update.

A unique, friendly name for the gateway.

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

The ID of the project.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that contains the IDs of each asset associated with the project.

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.

A unique, friendly name for the gateway.

The gateway's platform. You can only specify one platform in a gateway.

The response's http status code.

The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

Contains information about the storage destination.

The date the storage configuration was last updated, in Unix epoch time.

The response's http status code.

The type of storage that you specified for your data. The storage type can be one of the following values:

• SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
• MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

Undocumented member.

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.

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.

A unique, friendly name for the asset.

The ID of the asset model from which to create the asset.

The response's http status code.

The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.

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.

The ID of the parent asset.

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.

The ID of the child asset to be associated.

The nanosecond offset converted from startTimeInSeconds.

The nanosecond offset converted from endTimeInSeconds.

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.

The token to be used for the next set of paginated results.

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 is between the start time minus the interval and the end time plus the interval.

• If you specify a value for the intervalWindowInSeconds parameter, the type parameter must be LINEAR_INTERPOLATION.
• If no data point is 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 - 2 hours) to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value, uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.

The ID of the asset property.

The ID of the asset.

The maximum number of results to return for each paginated request. If not specified, the default value is 10.

The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.

The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.

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.

The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.

The interpolation type.

Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION

• LINEAR_INTERPOLATION – 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 on 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.

• LOCF_INTERPOLATION – 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 on 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 no data point is found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

The requested interpolated values.

The ID of the gateway that defines the capability configuration.

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.

The response's http status code.

The ID of the gateway that defines the capability configuration.

The namespace of the gateway capability.

The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

The synchronization status of the capability configuration. The sync status can be one of the following:

• IN_SYNC – The gateway is running the capability configuration.
• OUT_OF_SYNC – The gateway hasn't received the capability configuration.
• SYNC_FAILED – The gateway rejected the capability configuration.

The Key ID of the customer managed customer master key (CMK) used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.

The type of encryption used for the encryption configuration.

The Key ARN of the KMS CMK used for KMS encryption if you use KMS_BASED_ENCRYPTION.

The response's http status code.

The type of encryption used for the encryption configuration.

The status of the account configuration. This contains the ConfigurationState. If there is an error, it also contains the ErrorDetails.

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.

The ID of the portal to delete.

The response's http status code.

The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

The ID of the asset.

The type of traversal to use to identify asset relationships. Choose the following option:

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

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes each asset relationship.

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.

A new description for the portal.

The email address that sends alarm notifications.

Undocumented member.

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.

The ID of the portal to update.

A new friendly name for the portal.

The Amazon Web Services administrator's contact email address.

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.

The response's http status code.

The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

A list that summarizes each portal.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

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.

The ID of the dashboard to delete.

The response's http status code.

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.

A new description for the dashboard.

The ID of the dashboard to update.

A new friendly name for the dashboard.

The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

The response's http status code.

Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

The type of storage that you specified for your data. The storage type can be one of the following values:

• SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
• MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

Contains information about the storage destination.

The response's http status code.

The type of storage that you specified for your data. The storage type can be one of the following values:

• SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
• MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

Undocumented member.

The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. For more information, see Enabling Amazon Web Services SSO 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. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

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.

A description for the portal.

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.

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.

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

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.

A friendly name for the portal.

The Amazon Web Services administrator's contact email address.

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.

The response's http status code.

The ID of the created portal.

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

The ARN of the resource to tag.

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.

The response's http status code.

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.

The ID of the project from which to disassociate the assets.

The IDs of the assets to be disassociated from the project.

A list of associated error information, if any.

The response's http status code.

The quality by which to filter asset data.

The chronological sorting order of the requested information.

Default: ASCENDING

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.

The token to be used for the next set of paginated results.

The ID of the asset property.

The ID of the asset.

The maximum number of results to return for each paginated request.

Default: 100

The data aggregating function.

The time interval over which to aggregate data.

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

The token for the next set of results, or null if there are no additional results.

The response's http status code.

The requested aggregated values.

The ARN of the resource to untag.

A list of keys for tags to remove from the resource.

The response's http status code.

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.

The ID of the asset model to delete.

The response's http status code.

The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.

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.

A description for the asset model.

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.

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.

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.

The ID of the asset model to update.

A unique, friendly name for the asset model.

The response's http status code.

The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.

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.

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.

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.

The ID of the asset to be updated.

The ID of the asset property to be updated.

The response's http status code.

The current logging options.

The token to be used for the next set of paginated results.

The maximum number of results to return for each paginated request.

Default: 50

The token for the next set of results, or null if there are no additional results.

The response's http status code.

A list that summarizes each gateway.

The ID of the gateway to be updated.

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.

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.

The response's http status code.

The namespace of the gateway capability.

The synchronization status of the capability configuration. The sync status can be one of the following:

• IN_SYNC – The gateway is running the capability configuration.
• OUT_OF_SYNC – The gateway hasn't received the capability configuration.
• SYNC_FAILED – The gateway rejected the capability configuration.

After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.

The ID of the dashboard.

The dashboard's description.

The response's http status code.

The ID of the dashboard.

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

The name of the dashboard.

The ID of the project that the dashboard is in.

The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

The date the dashboard was created, in Unix epoch time.

The date the dashboard was last updated, in Unix epoch time.

The ID of the portal.

The service to use to authenticate users to the portal.

The portal's description.

The email address that sends alarm notifications.

The portal's logo image, which is available at a URL.

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

The ARN of the 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.

The response's http status code.

The ID of the portal.

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

The name of the portal.

The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals that use Amazon Web Services SSO to authenticate users.

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

The Amazon Web Services administrator's contact email address.

The current status of the portal, which contains a state and any error message.

The date the portal was created, in Unix epoch time.

The date the portal was last updated, in Unix epoch time.

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.

A description for the project.