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.

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 alias that identifies the time series.

The ID of the asset in which the asset property was created.

The ID of the asset property.

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.

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 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 less than 1 MB.
• The number of data points in the result set is less than the value of maxResults. The maximum value of maxResults is 4000.

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

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

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

The response's http status code.

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

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

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

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

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

The response's http status code.

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

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

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 less than 1 MB.
• The number of data points in the result set is less than the value of maxResults. The maximum value of maxResults is 4000.

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

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

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

The response's http status code.

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

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

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.

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 IAM Identity Center user, an IAM Identity Center 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 description for the asset.

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

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.

A description for the 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.

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.

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

The unique name that helps identify the job request.

The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

The files in the specified Amazon S3 bucket that contain your data.

The Amazon S3 destination where errors associated with the job creation request are saved.

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

The response's http status code.

The ID of the job.

The unique name that helps identify the job request.

The status of the bulk import job can be one of following values.

• PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
• CANCELLED – The bulk import job has been canceled.
• RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
• COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
• FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
• COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

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

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

A description for the portal.

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 IAM Identity Center 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 IAM Identity Center application ID, if the portal uses IAM Identity Center.

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.

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.

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

A friendly name for the project.

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}

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

The ID of the dashboard to delete.

The response's http status code.

The ID of the gateway to delete.

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.

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.

The alias that identifies the time series.

The ID of the asset in which the asset property was created.

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

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 (IAM Identity Center user, IAM Identity Center 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.

Whether or not to exclude asset properties from the response.

The ID of the asset.

The composite models for the asset.

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

Whether or not to exclude asset model properties from the response.

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 ID of the job.

The response's http status code.

The ID of the job.

The unique name that helps identify the job request.

The status of the bulk import job can be one of following values.

• PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
• CANCELLED – The bulk import job has been canceled.
• RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
• COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
• FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
• COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

The files in the specified Amazon S3 bucket that contain your data.

The Amazon S3 destination where errors associated with the job creation request are saved.

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

The date the job was created, in Unix epoch TIME.

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

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 key ARN of the customer managed key 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's an error, it also contains the ErrorDetails.

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 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 response's http status code.

The current logging options.

The ID of the portal.

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

The email address that sends alarm notifications.

The service to use to authenticate users to the portal.

The portal's description.

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

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 IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center 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.

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.

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.

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

Contains information about the storage destination.

How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

The response's http status code.

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

• SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
• MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

Undocumented member.

The alias that identifies the time series.

The ID of the asset in which the asset property was created.

The ID of the asset property.

The alias that identifies the time series.

The ID of the asset in which the asset property was created.

The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

The ID of the asset property.

The response's http status code.

The ID of the time series.

The data type of the time series.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

The date that the time series was created, in Unix epoch time.

The date that the time series 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.

The ID of the parent asset from which to disassociate the child 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. 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.

The ID of the child asset to disassociate.

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.