AWS iot-sitewise documentation change
Summary
Restructured quota tables to include 'Description' column, improved resource naming consistency, and added new section for AWS IoT SiteWise Assistant API throttling quotas
Security assessment
Changes focus on improving documentation clarity and structure. No explicit security vulnerabilities or security feature enhancements are mentioned. The new API throttling quotas describe operational limits rather than security controls.
Diff
diff --git a/iot-sitewise/latest/userguide/endpoints-and-quotas.md b/iot-sitewise/latest/userguide/endpoints-and-quotas.md index 635ae1d7a..33ddf4f93 100644 --- a/iot-sitewise/latest/userguide/endpoints-and-quotas.md +++ b/iot-sitewise/latest/userguide/endpoints-and-quotas.md @@ -28 +28 @@ The following tables describe quotas in AWS IoT SiteWise. For more information a -Quotas for assets and asset models Resource | Quota | Adjustable | Notes +Quotas for AWS IoT SiteWise assets and asset models Resource | Description | Quota | Adjustable @@ -30,19 +30,19 @@ Quotas for assets and asset models Resource | Quota | Adjustable | Notes -Number of asset models per Region per AWS account | 1000 | Yes | -Number of assets per asset model | 10,000 | Yes | -Number of child assets per parent asset | 2000 | Yes | -Depth of asset model hierarchy tree | 30 | Yes | -Number of hierarchy definitions per asset model | 30 | Yes | -Number of properties in the root level per asset model | 500 | Yes | This maximum number of `assetModelProperties` for each asset model. This count does not include `compositeModelProperties`. This quota also applies to any unique asset created from this asset model. -Number of properties per asset model | 5000 | Yes | The maximum number of properties of an asset model of type `ASSET_MODEL` or `COMPONENT_MODEL`. This number is determined by combining the properties of the root asset model and any included component-model-based or inline composite models. This quota also applies to any unique asset created from this asset model. -Number of properties per composite model | 100 | Yes | The maximum number of properties allowed for composite models. Also, the maximum number of properties allowed for an asset model of type `COMPONENT_MODEL`. -Depth of property tree per asset model | 10 | No | For example, a model with a transform property C that consumes a transform property B that consumes a measurement property A has a depth of 3. -Number of asset models per hierarchy tree | 100 | Yes | -Number of directly dependent properties per asset model | 20 | No | This quota limits how many properties can directly depend on a single property, as defined in property formula expressions. The Number of dependent properties for an asset model must be greater than the Number of directly dependent properties per asset model. You must request a quota increase for both if the limit for the Number of directly dependent properties per asset model is greater than the limit for the Number of dependent properties per asset model. -Number of dependent properties per asset model | 30 | No | This quota limits how many properties can directly or indirectly depend on a single property, as defined in property formula expressions. -Number of composite models per asset model | 50 | Yes | The maximum number of composite models allowed on a single asset model. -Composite model depth | 2 | Yes | The maximum depth of the composite model tree per asset model, including inline and component-model-based composite models. -Number of unique asset models that use the same component model | 20 | Yes | The maximum number of unique asset models that have at least one component-model-based composite model that directly references a specific asset model of type COMPONENT_MODEL. -Number of property variables per property formula expression | 10 | No | For example, there are two property variables, `power` and `temp`, in the expression `avg(power) + max(temp)`. This also applies for transform computation results. -Number of functions per property formula expression | 10 | No | For example, there are two functions, `avg` and `max`, in the expression `avg(power) + max(temp)`. - -Quotas for asset property data Resource | Quota | Adjustable | Notes +Number of asset models in each AWS Region for each AWS account | The maximum number of asset models that you can create in an AWS Region for an AWS account. | 1000 | Yes +Number of assets in each asset model | The maximum number of assets that you can create for each asset model. | 10,000 | Yes +Number of child assets in each parent asset | The maximum number of child assets that you can associate with a parent asset. | 2000 | Yes +Depth of asset model hierarchy tree | The maximum asset hierarchy tree depth for an asset model. | 30 | Yes +Number of hierarchy definitions in each asset model | The maximum number of hierarchy definitions you can have in an asset model. | 30 | Yes +Number of properties in the root level in each asset model | The maximum number of `assetModelProperties` for each asset model. This count does not include `compositeModelProperties`. This quota also applies to any unique asset created from this asset model. | 500 | Yes +Number of properties in an asset model | The maximum number of properties of an asset model of type `ASSET_MODEL` or `COMPONENT_MODEL`. This number is determined by combining the properties of the root asset model and any included component-model-based or inline composite models. This quota also applies to any unique asset created from this asset model. | 5000 | Yes +Number of properties in each composite model | The maximum number of properties allowed for composite models. Also, the maximum number of properties allowed for an asset model of type `COMPONENT_MODEL`. | 100 | Yes +Depth of property tree in an asset model | For example, a model with a transform property C that consumes a transform property B that consumes a measurement property A has a depth of 3. | 10 | No +Number of asset models in each hierarchy tree | The maximum number of asset models you can include in a single hierarchy tree. | 100 | Yes +Number of directly dependent properties for an asset model | This quota limits how many properties can directly depend on a single property, as defined in property formula expressions. The number of dependent properties must be greater than the number of directly dependent properties for an asset model. Request an increase for both quotas if there are more directly dependent properties than dependent properties for an asset model. | 20 | Yes +Number of dependent properties in an asset model | This quota limits how many properties can directly or indirectly depend on a single property, as defined in property formula expressions. | 30 | No +Number of composite models in an asset model | The maximum number of composite models you can have on a single asset model. | 50 | Yes +Composite model depth | The maximum depth of the composite model tree in each asset model, including inline and component-model-based composite models. | 2 | Yes +Number of unique asset models that use the same component model | The maximum number of unique asset models that have at least one component-model-based composite model that directly references a specific asset model of type COMPONENT_MODEL. | 20 | Yes +Number of property variables in a property formula expression | For example, there are two property variables, `power` and `temp`, in the expression `avg(power) + max(temp)`. This also applies for transform computation results. | 10 | No +Number of functions in a property formula expression | For example, there are two functions, `avg` and `max`, in the expression `avg(power) + max(temp)`. | 10 | No + +Quotas for AWS IoT SiteWise asset property data Resource | Description | Quota | Adjustable @@ -50,14 +50,14 @@ Quotas for asset property data Resource | Quota | Adjustable | Notes -Request rate for asset property data API operations | 1000 requests per second per Region per AWS account | Yes | This quota applies to API operations such as `GetAssetPropertyValue` and `BatchPutAssetPropertyValue`. -Number of data points per second per data quality per asset property | 10 data points | No | This quota applies to the maximum number of timestamp-quality-value (TQV) data points with the same timestamp in seconds per data quality for each asset property. You can store up to this number of good-quality, uncertain-quality, and bad-quality data points for any given second for each asset property. -Number of `BatchPutAssetPropertyValue` entries ingested per second per asset property per Region per AWS Account. | 10 entries per asset property | No | This quota applies to `BatchPutAssetPropertyValue` entries from all sources, including SiteWise Edge gateways, AWS IoT Core rules, and API calls. -Rate of data points ingested | 5000 data points per second per Region per AWS account | Yes | Timestamp-quality-value (TQV) data points. -Request rate for `BatchGetAssetPropertyAggregates` | 200 | Yes | The maximum number of `BatchGetAssetPropertyAggregates` requests per second that you can perform in this account in the current Region. -Request rate for `BatchGetAssetPropertyValue` | 500 | Yes | The maximum number of `BatchGetAssetPropertyValue` requests per second that you can perform in this account in the current Region. -Request rate for `BatchGetAssetPropertyValueHistory` | 200 | Yes | The maximum number of `BatchGetAssetPropertyValueHistory` requests per second that you can perform in this account in the current Region. -Number of `BatchPutAssetPropertyValue` entries ingested per second per asset property per Region per AWS Account. | 10 entries per asset property | No | This quota applies to `BatchPutAssetPropertyValue` entries from all sources, including SiteWise Edge gateways, AWS IoT Core rules, and API calls. -Rate of `GetAssetPropertyAggregates` requests and `BatchGetAssetPropertyAggregates` entry queries per asset property | 50 | No | The maximum number of total `GetAssetPropertyAggregates` requests and `BatchGetAssetPropertyAggregates` entries for each asset property per second in this account in the current Region. -Rate of `GetAssetPropertyValue` requests and `BatchGetAssetPropertyValue` entry queries per asset property | 500 | No | The maximum number of total `GetAssetPropertyValue` requests and `BatchGetAssetPropertyValue` entries for each asset property per second in this account in the current Region. -Rate of `GetAssetPropertyValueHistory` requests and `BatchGetAssetPropertyValueHistory` entry queries per asset property | 30 | No | The maximum number of total `GetAssetPropertyValueHistory` requests and `BatchGetAssetPropertyValueHistory` entries for each asset property per second in this account in the current Region. -Rate of `GetInterpolatedAssetPropertyValues` requests | 500 | Yes | The maximum number of `GetInterpolatedAssetPropertyValues` requests per second that you can perform in this account in the current Region. -Number of results per `GetInterpolatedAssetPropertyValues` request | 10 | Yes | The maximum number of results to return per paginated `GetInterpolatedAssetPropertyValues` request. -Rate of datapoints retrieved from `GetAssetPropertyValueHistory` and `BatchGetAssetPropertyValueHistory` | 100MB read response per second per Region per AWS account. | Yes | The maximum byte rate (MB/second) of datapoints retrieved per second per Region per AWS account across `GetAssetPropertyValueHistory` and `BatchGetAssetPropertyValueHistory`. The response payload evaluated for this quota uses Timestamp-Quality-Value (TQV) fields for each datapoint and rounds the byte size for each API request to the next 4KB increment. Timestamp-quality-value (TQV) datapoints retrieved per second varies as per data type: +Request rate for asset property data API operations | The maximum number of asset property data API requests each second that you can perform in each AWS Region in each AWS account. This quota applies to API operations such as `GetAssetPropertyValue` and `BatchPutAssetPropertyValue`. | 1000 | Yes +Number of data points each second for each data quality for each asset property | This quota applies to the maximum number of timestamp-quality-value (TQV) data points with the same timestamp in seconds for each data quality for each asset property. You can store up to this number of good-quality, uncertain-quality, and bad-quality data points for any given second for each asset property. | 10 | No +Number of `BatchPutAssetPropertyValue` entries ingested each second in each asset property for each AWS Region for an AWS account. | The maximum number of entries in each asset property for `BatchPutAssetPropertyValue` from all sources, including SiteWise Edge gateways, AWS IoT Core rules, and API calls. | 10 | No +Rate of data points ingested | The maximum number of timestamp-quality-value (TQV) data points ingested per second in each AWS Region for an AWS account. | 5000 | Yes +Request rate for `BatchGetAssetPropertyAggregates` | The maximum number of `BatchGetAssetPropertyAggregates` requests each second that you can perform in each AWS Region in each AWS account. | 200 | Yes +Request rate for `BatchGetAssetPropertyValue` | The maximum number of `BatchGetAssetPropertyValue` requests each second that you can perform in each AWS Region in each AWS account. | 500 | Yes +Request rate for `BatchGetAssetPropertyValueHistory` | The maximum number of `BatchGetAssetPropertyValueHistory` requests each second that you can perform . | 200 | Yes +Number of `BatchPutAssetPropertyValue` entries ingested each second for each asset property for each AWS Region in an AWS account. | This quota applies to entries in each asset property for `BatchPutAssetPropertyValue` from all sources, including SiteWise Edge gateways, AWS IoT Core rules, and API calls. | 10 | No +Rate of `GetAssetPropertyAggregates` requests and `BatchGetAssetPropertyAggregates` entry queries for each asset property | The maximum number of total `GetAssetPropertyAggregates` requests and `BatchGetAssetPropertyAggregates` entries for each asset property per second in each AWS Region in each AWS account. | 50 | No +Rate of `GetAssetPropertyValue` requests and `BatchGetAssetPropertyValue` entry queries for each asset property | The maximum number of total `GetAssetPropertyValue` requests and `BatchGetAssetPropertyValue` entries for each asset property each second in each AWS Region in each AWS account. | 500 | No +Rate of `GetAssetPropertyValueHistory` requests and `BatchGetAssetPropertyValueHistory` entry queries for each asset property | The maximum number of total `GetAssetPropertyValueHistory` requests and `BatchGetAssetPropertyValueHistory` entries for each asset property each second in each AWS Region in each AWS account. | 30 | No +Rate of `GetInterpolatedAssetPropertyValues` requests | The maximum number of `GetInterpolatedAssetPropertyValues` requests each second that you can perform in each AWS Region in each AWS account. | 500 | Yes +Number of results in each `GetInterpolatedAssetPropertyValues` request | The maximum number of results to return for a paginated `GetInterpolatedAssetPropertyValues` request. | 10 | Yes +Rate of data points retrieved from `GetAssetPropertyValueHistory` and `BatchGetAssetPropertyValueHistory` | The maximum byte rate (MB/second) of datapoints retrieved each second for each AWS Region in an AWS account across `GetAssetPropertyValueHistory` and `BatchGetAssetPropertyValueHistory`. The response payload evaluated for this quota uses Timestamp-Quality-Value (TQV) fields for each datapoint and rounds the byte size for each API request to the next 4KB increment. Timestamp-quality-value (TQV) datapoints retrieved each second varies for each data type: @@ -69,0 +70 @@ Rate of datapoints retrieved from `GetAssetPropertyValueHistory` and `BatchGetAs +| 100 | Yes @@ -70,0 +72,5 @@ Rate of datapoints retrieved from `GetAssetPropertyValueHistory` and `BatchGetAs +Quotas for SiteWise Edge gateways Resource | Description | Quota | Adjustable +---|---|---|--- +Number of SiteWise Edge gateways in each AWS Region for an AWS account | The maximum number of SiteWise Edge gateways that you can create in an AWS Region for an AWS account. | 100 | Yes +Number of OPC UA sources in a SiteWise Edge gateway | The maximum number of OPC UA sources you can configure in an SiteWise Edge gateway. | 100 | No +Total number of destinations in a SiteWise Edge gateway | The maximum number of destinations that you can configure in an SiteWise Edge gateway. | 100 | No @@ -72,15 +78,9 @@ Rate of datapoints retrieved from `GetAssetPropertyValueHistory` and `BatchGetAs -Quotas for SiteWise Edge gateways Resource | Quota | Adjustable ----|---|--- -Number of SiteWise Edge gateways per Region per AWS account | 100 | Yes -Number of OPC UA sources per SiteWise Edge gateway | 100 | No -Total number of destinations per SiteWise Edge gateway | 100 | No - -Quotas for AWS IoT SiteWise Monitor Resource | Quota | Adjustable ----|---|--- -Number of portals per Region per AWS account | 100 | Yes -Number of projects per portal | 100 | Yes -Number of dashboards per project | 100 | Yes -Number of root assets per project | 1 | No -Number of visualizations per dashboard | 10 | Yes -Number of metrics per dashboard visualization | 5 | Yes -Number of thresholds per dashboard visualization | 12 | No +Quotas for AWS IoT SiteWise Monitor Resource | Description | Quota | Adjustable +---|---|---|--- +Number of portals in each AWS Region for an AWS account | The maximum number of SiteWise Monitor portals that you can create in an AWS Region for an AWS account. | 100 | Yes +Number of projects in a portal | The maximum number of projects that you can create within a SiteWise Monitor portal. | 100 | Yes +Number of dashboards in a project | The maximum number of dashboards that you can create within a project in SiteWise Monitor. | 100 | Yes +Number of root assets in a project | The maximum number of top-level assets that you can add to a project in SiteWise Monitor. | 1 | No +Number of visualizations in a dashboard | The maximum number of visual elements (such as charts, graphs, or tables) that you can add to a dashboard in SiteWise Monitor. | 10 | Yes +Number of metrics in each dashboard visualization | The maximum number of metrics or data points that you can display in a single visualization on a dashboard in SiteWise Monitor. | 5 | Yes +Number of thresholds for each dashboard visualization | The maximum number of threshold levels that you can set for each visualization on a dashboard in SiteWise Monitor. | 12 | No @@ -91 +91 @@ Number of metadata transfer jobs in queue | The maximum number of `PENDING` meta -Size of the metadata transfer job import file | The maximum size of the imported file (in MB). | 100 MB | Yes +Size of the metadata transfer job import file | The maximum size of the imported file (in MB). | 100 | Yes @@ -95,12 +95,18 @@ Number of AWS IoT SiteWise export resources in a job | The maximum number of AWS -Quotas for AWS IoT SiteWise bulk import of data Resource | Quota | Adjustable ----|---|--- -Number of running bulk import jobs | 100 | No -Size of the CSV file | 10 GB | No -Size of the uncompressed parquet file | 256 MB | No -Size of the `CSV` file for buffered ingestion | 256 MB | No -Size of the uncompressed parquet row group | 64 MB | No -Number of unique measurements per parquet row group | 2000 | Yes -Number of days between the timestamp in the past and today for buffered ingestion | 30 | Yes -Request rate for `CreateBulkImportJobs` for each Region in each AWS account | 10 | Yes -Request rate for `ListBulkImportJobs` for each Region in each AWS account | 50 | Yes -Request rate for `DescribeBulkImportJobs` for each Region in each AWS account | 50 | Yes +Quotas for AWS IoT SiteWise bulk import of data Resource | Description | Quota | Adjustable +---|---|---|--- +Number of running bulk import jobs | The maximum number of bulk import jobs that can concurrently run. | 100 | No +Size of the CSV file | The maximum CSV file size (in GB) in a bulk import job. | 10 | No +Size of the uncompressed parquet file | The maximum file size (in MB) for an uncompressed parquet file in a bulk import job. | 256 MB | No +Size of the CSV file for buffered ingestion | The maximum CSV file size (in MB) when using buffered ingestion on a bulk import job. | 256 MB | No +Size of the uncompressed parquet row group | The maximum size of an uncompressed parquet row group. | 64 MB | No +Number of unique measurements in a parquet row group | The maximum number of unique measurements in a parquet row group. | 2000 | Yes +Number of days between the timestamp in the past and today for buffered ingestion | The maximum number of days between a timestamp in the past and today's date when using buffered ingestion. | 30 | Yes +Request rate for `CreateBulkImportJobs` in each AWS Region in each AWS account | | 10 | Yes +Request rate for `ListBulkImportJobs` for each AWS Region in each AWS account | | 50 | Yes +Request rate for `DescribeBulkImportJobs` for each AWS Region in each AWS account | | 50 | Yes + +### Quotas for AWS IoT SiteWise Assistant API throttling + +Quotas for AWS IoT SiteWise Assistant API throttling limits Resource | Description | Quota | Adjustable +---|---|---|--- +Request rate for `InvokeAssistant` operation | The maximum number of transactions each minute (TPM) that can be made to the AWS IoT SiteWise `InvokeAssistant` API in an AWS account. The TPM limits apply to all supported regions, and are adjustable in some regions. | 10 | No @@ -112,13 +117,0 @@ The quotas for anomaly detection are shared between AWS IoT SiteWise and Amazon -### AWS IoT SiteWise Assistant API throttling limits - -This topic describes the maximum number of transactions per minute (TPM) that can be made to AWS IoT SiteWise InvokeAssistant API per AWS account. - - * **Request rate for InvokeAssistant operation limit** : 10 TPM per AWS account. - - - - -###### Note - -The TPM limits apply to all supported regions, and are adjustable in some regions. -