AWS IoT SiteWise endpoints - AWS IoT SiteWise

AWS IoT SiteWise endpoints

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

AWS IoT SiteWise supports the following endpoints.

data.iotsitewise.region.amazonaws.com

Use this endpoint to access the following data plane API operations: BatchPutAssetPropertyValue, GetAssetPropertyAggregates, GetAssetPropertyValue, GetAssetPropertyValueHistory and GetInterpolatedAssetPropertyValues. Replace region with your AWS Region.

api.iotsitewise.region.amazonaws.com

AWS 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. Replace region with your AWS Region.

Note
  • By default, AWS 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, UpdateGatewayCapabilityConfiguration, DescribeStorageConfiguration, PutStorageConfiguration, 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 AWS IoT SiteWise and interface VPC endpoints (AWS PrivateLink).

iotsitewise.region.amazonaws.com

You can use this endpoint to access the following API operations: DescribeStorageConfiguration, PutStorageConfiguration, DescribeDefaultEncryptionConfiguration, ListTagsForResource, PutDefaultEncryptionConfiguration, TagResource, and UntagResource. Replace region with your AWS Region.

model.iotsitewise.region.amazonaws.com

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. Replace region with your AWS Region.

edge.iotsitewise.region.amazonaws.com

You can use this endpoint to access the following API operations: CreateGateway, DeleteGateway, DescribeGateway, DescribeGatewayCapabilityConfiguration, ListGateways, UpdateGateway, and UpdateGatewayCapabilityConfiguration. Replace region with your AWS Region.

monitor.iotsitewise.region.amazonaws.com

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. Replace region with your AWS Region.