Amazon IoT SiteWise endpoints - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Amazon IoT SiteWise endpoints

To connect programmatically to Amazon IoT SiteWise, you use an endpoint. The Amazon SDKs and the Amazon Command Line Interface (Amazon CLI) automatically use the default endpoint in an Amazon Region. For more information about Regions where Amazon IoT SiteWise is available, see Amazon IoT SiteWise endpoints and quotas in the Amazon General Reference.

Amazon IoT SiteWise supports the following endpoints.

data.iotsitewise.cn-north-1.amazonaws.com.cn

Use this endpoint to access the following data plane API operations: BatchPutAssetPropertyValue, GetAssetPropertyAggregates, GetAssetPropertyValue, GetAssetPropertyValueHistory and GetInterpolatedAssetPropertyValues.

api.iotsitewise.cn-north-1.amazonaws.com.cn

Amazon IoT SiteWise offers this consolidated endpoint for the control plane API operations that you use to manage asset models, assets, gateways, tags, and account configurations.

Note
  • By default, Amazon IoT SiteWise uses the consolidated endpoint when you make calls to the supported control plane API operations.

  • We recommend that you use the consolidated endpoint for the supported control plane API operations.

  • You can't use the consolidated endpoint to access the SiteWise Monitor API operations.

The supported control plane API operations include AssociateAssets, CreateAsset, CreateAssetModel, DeleteAsset, DeleteAssetModel, DeleteDashboard, DescribeAsset, DescribeAssetModel, DescribeAssetProperty, DescribeDashboard, DescribeLoggingOptions, DisassociateAssets, ListAssetModels, ListAssetRelationships, ListAssets, ListAssociatedAssets, PutLoggingOptions, UpdateAsset, UpdateAssetModel, UpdateAssetProperty, CreateGateway, DeleteGateway, DescribeGateway, DescribeGatewayCapabilityConfiguration, ListGateways, UpdateGateway, , DescribeDefaultEncryptionConfiguration, ListTagsForResource, PutDefaultEncryptionConfiguration, TagResource, and UntagResource.

The interface VPC endpoint for the control plane API operations only supports the consolidated endpoint. For more information, see Amazon IoT SiteWise and interface VPC endpoints (Amazon PrivateLink).

iotsitewise.cn-north-1.amazonaws.com.cn

You can use this endpoint to access the following API operations: DescribeDefaultEncryptionConfiguration, ListTagsForResource, PutDefaultEncryptionConfiguration, TagResource, and UntagResource.

model.iotsitewise.cn-north-1.amazonaws.com.cn

You can use this endpoint to access the following API operations: AssociateAssets, CreateAsset, CreateAssetModel, DeleteAsset, DeleteAssetModel, DeleteDashboard, DescribeAsset, DescribeAssetModel, DescribeAssetProperty, DescribeDashboard, DescribeLoggingOptions, DisassociateAssets, ListAssetModels, ListAssetRelationships, ListAssets, ListAssociatedAssets, PutLoggingOptions, UpdateAsset, UpdateAssetModel, and UpdateAssetProperty.

edge.iotsitewise.cn-north-1.amazonaws.com.cn

You can use this endpoint to access the following API operations: CreateGateway, DeleteGateway, DescribeGateway, DescribeGatewayCapabilityConfiguration, ListGateways, UpdateGateway, and UpdateGatewayCapabilityConfiguration.

monitor.iotsitewise.cn-north-1.amazonaws.com.cn

Use this endpoint to access the following API operations: BatchAssociateProjectAssets, BatchDisassociateProjectAssets, CreateAccessPolicy, CreateDashboard, CreatePortal, CreateProject, DeleteAccessPolicy, DeletePortal, DeleteProject, DescribeAccessPolicy, DescribePortal, DescribeProject, ListAccessPolicies, ListDashboards, ListPortals, ListProjectAssets, ListProjects, UpdateAccessPolicy, UpdateDashboard, UpdatePortal, and UpdateProject.