{ "version": "2.0", "metadata": { "apiVersion": "2019-12-02", "endpointPrefix": "iotsitewise", "jsonVersion": "1.1", "protocol": "rest-json", "serviceFullName": "AWS IoT SiteWise", "serviceId": "IoTSiteWise", "signatureVersion": "v4", "signingName": "iotsitewise", "uid": "iotsitewise-2019-12-02" }, "operations": { "AssociateAssets": { "http": { "requestUri": "/assets/{assetId}/associate" }, "input": { "type": "structure", "required": [ "assetId", "hierarchyId", "childAssetId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "hierarchyId": {}, "childAssetId": {}, "clientToken": { "idempotencyToken": true } } }, "endpoint": { "hostPrefix": "model." } }, "BatchAssociateProjectAssets": { "http": { "requestUri": "/projects/{projectId}/assets/associate", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId", "assetIds" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" }, "assetIds": { "shape": "S5" }, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": { "errors": { "type": "list", "member": { "shape": "S8" } } } }, "endpoint": { "hostPrefix": "monitor." } }, "BatchDisassociateProjectAssets": { "http": { "requestUri": "/projects/{projectId}/assets/disassociate", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId", "assetIds" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" }, "assetIds": { "shape": "S5" }, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": { "errors": { "type": "list", "member": { "shape": "S8" } } } }, "endpoint": { "hostPrefix": "monitor." } }, "BatchPutAssetPropertyValue": { "http": { "requestUri": "/properties" }, "input": { "type": "structure", "required": [ "entries" ], "members": { "entries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "propertyValues" ], "members": { "entryId": {}, "assetId": {}, "propertyId": {}, "propertyAlias": {}, "propertyValues": { "type": "list", "member": { "shape": "Sk" } } } } } } }, "output": { "type": "structure", "required": [ "errorEntries" ], "members": { "errorEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "errors" ], "members": { "entryId": {}, "errors": { "type": "list", "member": { "type": "structure", "required": [ "errorCode", "errorMessage", "timestamps" ], "members": { "errorCode": {}, "errorMessage": {}, "timestamps": { "type": "list", "member": { "shape": "Sq" } } } } } } } } } }, "endpoint": { "hostPrefix": "data." } }, "CreateAccessPolicy": { "http": { "requestUri": "/access-policies", "responseCode": 201 }, "input": { "type": "structure", "required": [ "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission" ], "members": { "accessPolicyIdentity": { "shape": "S13" }, "accessPolicyResource": { "shape": "S1a" }, "accessPolicyPermission": {}, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "required": [ "accessPolicyId", "accessPolicyArn" ], "members": { "accessPolicyId": {}, "accessPolicyArn": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "CreateAsset": { "http": { "requestUri": "/assets", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetName", "assetModelId" ], "members": { "assetName": {}, "assetModelId": {}, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "required": [ "assetId", "assetArn", "assetStatus" ], "members": { "assetId": {}, "assetArn": {}, "assetStatus": { "shape": "S1l" } } }, "endpoint": { "hostPrefix": "model." } }, "CreateAssetModel": { "http": { "requestUri": "/asset-models", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetModelName" ], "members": { "assetModelName": {}, "assetModelDescription": {}, "assetModelProperties": { "shape": "S1r" }, "assetModelHierarchies": { "type": "list", "member": { "type": "structure", "required": [ "name", "childAssetModelId" ], "members": { "name": {}, "childAssetModelId": {} } } }, "assetModelCompositeModels": { "type": "list", "member": { "type": "structure", "required": [ "name", "type" ], "members": { "name": {}, "description": {}, "type": {}, "properties": { "shape": "S1r" } } } }, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "required": [ "assetModelId", "assetModelArn", "assetModelStatus" ], "members": { "assetModelId": {}, "assetModelArn": {}, "assetModelStatus": { "shape": "S2f" } } }, "endpoint": { "hostPrefix": "model." } }, "CreateDashboard": { "http": { "requestUri": "/dashboards", "responseCode": 201 }, "input": { "type": "structure", "required": [ "projectId", "dashboardName", "dashboardDefinition" ], "members": { "projectId": {}, "dashboardName": {}, "dashboardDescription": {}, "dashboardDefinition": {}, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "required": [ "dashboardId", "dashboardArn" ], "members": { "dashboardId": {}, "dashboardArn": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "CreateGateway": { "http": { "requestUri": "/20200301/gateways", "responseCode": 201 }, "input": { "type": "structure", "required": [ "gatewayName", "gatewayPlatform" ], "members": { "gatewayName": {}, "gatewayPlatform": { "shape": "S2l" }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "required": [ "gatewayId", "gatewayArn" ], "members": { "gatewayId": {}, "gatewayArn": {} } }, "endpoint": { "hostPrefix": "edge." } }, "CreatePortal": { "http": { "requestUri": "/portals", "responseCode": 202 }, "input": { "type": "structure", "required": [ "portalName", "portalContactEmail", "roleArn" ], "members": { "portalName": {}, "portalDescription": {}, "portalContactEmail": {}, "clientToken": { "idempotencyToken": true }, "portalLogoImageFile": { "shape": "S2q" }, "roleArn": {}, "tags": { "shape": "S1e" }, "portalAuthMode": {}, "notificationSenderEmail": {}, "alarms": { "shape": "S2u" } } }, "output": { "type": "structure", "required": [ "portalId", "portalArn", "portalStartUrl", "portalStatus", "ssoApplicationId" ], "members": { "portalId": {}, "portalArn": {}, "portalStartUrl": {}, "portalStatus": { "shape": "S2x" }, "ssoApplicationId": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "CreateProject": { "http": { "requestUri": "/projects", "responseCode": 201 }, "input": { "type": "structure", "required": [ "portalId", "projectName" ], "members": { "portalId": {}, "projectName": {}, "projectDescription": {}, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "required": [ "projectId", "projectArn" ], "members": { "projectId": {}, "projectArn": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "DeleteAccessPolicy": { "http": { "method": "DELETE", "requestUri": "/access-policies/{accessPolicyId}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "accessPolicyId" ], "members": { "accessPolicyId": { "location": "uri", "locationName": "accessPolicyId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "monitor." } }, "DeleteAsset": { "http": { "method": "DELETE", "requestUri": "/assets/{assetId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" } } }, "output": { "type": "structure", "required": [ "assetStatus" ], "members": { "assetStatus": { "shape": "S1l" } } }, "endpoint": { "hostPrefix": "model." } }, "DeleteAssetModel": { "http": { "method": "DELETE", "requestUri": "/asset-models/{assetModelId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetModelId" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" } } }, "output": { "type": "structure", "required": [ "assetModelStatus" ], "members": { "assetModelStatus": { "shape": "S2f" } } }, "endpoint": { "hostPrefix": "model." } }, "DeleteDashboard": { "http": { "method": "DELETE", "requestUri": "/dashboards/{dashboardId}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "dashboardId" ], "members": { "dashboardId": { "location": "uri", "locationName": "dashboardId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "monitor." } }, "DeleteGateway": { "http": { "method": "DELETE", "requestUri": "/20200301/gateways/{gatewayId}" }, "input": { "type": "structure", "required": [ "gatewayId" ], "members": { "gatewayId": { "location": "uri", "locationName": "gatewayId" } } }, "endpoint": { "hostPrefix": "edge." } }, "DeletePortal": { "http": { "method": "DELETE", "requestUri": "/portals/{portalId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "portalId" ], "members": { "portalId": { "location": "uri", "locationName": "portalId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" } } }, "output": { "type": "structure", "required": [ "portalStatus" ], "members": { "portalStatus": { "shape": "S2x" } } }, "endpoint": { "hostPrefix": "monitor." } }, "DeleteProject": { "http": { "method": "DELETE", "requestUri": "/projects/{projectId}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "projectId" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "monitor." } }, "DescribeAccessPolicy": { "http": { "method": "GET", "requestUri": "/access-policies/{accessPolicyId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "accessPolicyId" ], "members": { "accessPolicyId": { "location": "uri", "locationName": "accessPolicyId" } } }, "output": { "type": "structure", "required": [ "accessPolicyId", "accessPolicyArn", "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission", "accessPolicyCreationDate", "accessPolicyLastUpdateDate" ], "members": { "accessPolicyId": {}, "accessPolicyArn": {}, "accessPolicyIdentity": { "shape": "S13" }, "accessPolicyResource": { "shape": "S1a" }, "accessPolicyPermission": {}, "accessPolicyCreationDate": { "type": "timestamp" }, "accessPolicyLastUpdateDate": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "monitor." } }, "DescribeAsset": { "http": { "method": "GET", "requestUri": "/assets/{assetId}" }, "input": { "type": "structure", "required": [ "assetId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" } } }, "output": { "type": "structure", "required": [ "assetId", "assetArn", "assetName", "assetModelId", "assetProperties", "assetHierarchies", "assetCreationDate", "assetLastUpdateDate", "assetStatus" ], "members": { "assetId": {}, "assetArn": {}, "assetName": {}, "assetModelId": {}, "assetProperties": { "shape": "S3n" }, "assetHierarchies": { "shape": "S3t" }, "assetCompositeModels": { "type": "list", "member": { "type": "structure", "required": [ "name", "type", "properties" ], "members": { "name": {}, "description": {}, "type": {}, "properties": { "shape": "S3n" } } } }, "assetCreationDate": { "type": "timestamp" }, "assetLastUpdateDate": { "type": "timestamp" }, "assetStatus": { "shape": "S1l" } } }, "endpoint": { "hostPrefix": "model." } }, "DescribeAssetModel": { "http": { "method": "GET", "requestUri": "/asset-models/{assetModelId}" }, "input": { "type": "structure", "required": [ "assetModelId" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" } } }, "output": { "type": "structure", "required": [ "assetModelId", "assetModelArn", "assetModelName", "assetModelDescription", "assetModelProperties", "assetModelHierarchies", "assetModelCreationDate", "assetModelLastUpdateDate", "assetModelStatus" ], "members": { "assetModelId": {}, "assetModelArn": {}, "assetModelName": {}, "assetModelDescription": {}, "assetModelProperties": { "shape": "S3z" }, "assetModelHierarchies": { "shape": "S41" }, "assetModelCompositeModels": { "shape": "S43" }, "assetModelCreationDate": { "type": "timestamp" }, "assetModelLastUpdateDate": { "type": "timestamp" }, "assetModelStatus": { "shape": "S2f" } } }, "endpoint": { "hostPrefix": "model." } }, "DescribeAssetProperty": { "http": { "method": "GET", "requestUri": "/assets/{assetId}/properties/{propertyId}" }, "input": { "type": "structure", "required": [ "assetId", "propertyId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "propertyId": { "location": "uri", "locationName": "propertyId" } } }, "output": { "type": "structure", "required": [ "assetId", "assetName", "assetModelId" ], "members": { "assetId": {}, "assetName": {}, "assetModelId": {}, "assetProperty": { "shape": "S47" }, "compositeModel": { "type": "structure", "required": [ "name", "type", "assetProperty" ], "members": { "name": {}, "type": {}, "assetProperty": { "shape": "S47" } } } } }, "endpoint": { "hostPrefix": "model." } }, "DescribeDashboard": { "http": { "method": "GET", "requestUri": "/dashboards/{dashboardId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "dashboardId" ], "members": { "dashboardId": { "location": "uri", "locationName": "dashboardId" } } }, "output": { "type": "structure", "required": [ "dashboardId", "dashboardArn", "dashboardName", "projectId", "dashboardDefinition", "dashboardCreationDate", "dashboardLastUpdateDate" ], "members": { "dashboardId": {}, "dashboardArn": {}, "dashboardName": {}, "projectId": {}, "dashboardDescription": {}, "dashboardDefinition": {}, "dashboardCreationDate": { "type": "timestamp" }, "dashboardLastUpdateDate": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "monitor." } }, "DescribeDefaultEncryptionConfiguration": { "http": { "method": "GET", "requestUri": "/configuration/account/encryption" }, "input": { "type": "structure", "members": {} }, "output": { "type": "structure", "required": [ "encryptionType", "configurationStatus" ], "members": { "encryptionType": {}, "kmsKeyArn": {}, "configurationStatus": { "shape": "S4e" } } } }, "DescribeGateway": { "http": { "method": "GET", "requestUri": "/20200301/gateways/{gatewayId}" }, "input": { "type": "structure", "required": [ "gatewayId" ], "members": { "gatewayId": { "location": "uri", "locationName": "gatewayId" } } }, "output": { "type": "structure", "required": [ "gatewayId", "gatewayName", "gatewayArn", "gatewayCapabilitySummaries", "creationDate", "lastUpdateDate" ], "members": { "gatewayId": {}, "gatewayName": {}, "gatewayArn": {}, "gatewayPlatform": { "shape": "S2l" }, "gatewayCapabilitySummaries": { "shape": "S4j" }, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "edge." } }, "DescribeGatewayCapabilityConfiguration": { "http": { "method": "GET", "requestUri": "/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}" }, "input": { "type": "structure", "required": [ "gatewayId", "capabilityNamespace" ], "members": { "gatewayId": { "location": "uri", "locationName": "gatewayId" }, "capabilityNamespace": { "location": "uri", "locationName": "capabilityNamespace" } } }, "output": { "type": "structure", "required": [ "gatewayId", "capabilityNamespace", "capabilityConfiguration", "capabilitySyncStatus" ], "members": { "gatewayId": {}, "capabilityNamespace": {}, "capabilityConfiguration": {}, "capabilitySyncStatus": {} } }, "endpoint": { "hostPrefix": "edge." } }, "DescribeLoggingOptions": { "http": { "method": "GET", "requestUri": "/logging" }, "input": { "type": "structure", "members": {} }, "output": { "type": "structure", "required": [ "loggingOptions" ], "members": { "loggingOptions": { "shape": "S4s" } } }, "endpoint": { "hostPrefix": "model." } }, "DescribePortal": { "http": { "method": "GET", "requestUri": "/portals/{portalId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "portalId" ], "members": { "portalId": { "location": "uri", "locationName": "portalId" } } }, "output": { "type": "structure", "required": [ "portalId", "portalArn", "portalName", "portalClientId", "portalStartUrl", "portalContactEmail", "portalStatus", "portalCreationDate", "portalLastUpdateDate" ], "members": { "portalId": {}, "portalArn": {}, "portalName": {}, "portalDescription": {}, "portalClientId": {}, "portalStartUrl": {}, "portalContactEmail": {}, "portalStatus": { "shape": "S2x" }, "portalCreationDate": { "type": "timestamp" }, "portalLastUpdateDate": { "type": "timestamp" }, "portalLogoImageLocation": { "type": "structure", "required": [ "id", "url" ], "members": { "id": {}, "url": {} } }, "roleArn": {}, "portalAuthMode": {}, "notificationSenderEmail": {}, "alarms": { "shape": "S2u" } } }, "endpoint": { "hostPrefix": "monitor." } }, "DescribeProject": { "http": { "method": "GET", "requestUri": "/projects/{projectId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" } } }, "output": { "type": "structure", "required": [ "projectId", "projectArn", "projectName", "portalId", "projectCreationDate", "projectLastUpdateDate" ], "members": { "projectId": {}, "projectArn": {}, "projectName": {}, "portalId": {}, "projectDescription": {}, "projectCreationDate": { "type": "timestamp" }, "projectLastUpdateDate": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "monitor." } }, "DisassociateAssets": { "http": { "requestUri": "/assets/{assetId}/disassociate" }, "input": { "type": "structure", "required": [ "assetId", "hierarchyId", "childAssetId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "hierarchyId": {}, "childAssetId": {}, "clientToken": { "idempotencyToken": true } } }, "endpoint": { "hostPrefix": "model." } }, "GetAssetPropertyAggregates": { "http": { "method": "GET", "requestUri": "/properties/aggregates" }, "input": { "type": "structure", "required": [ "aggregateTypes", "resolution", "startDate", "endDate" ], "members": { "assetId": { "location": "querystring", "locationName": "assetId" }, "propertyId": { "location": "querystring", "locationName": "propertyId" }, "propertyAlias": { "location": "querystring", "locationName": "propertyAlias" }, "aggregateTypes": { "location": "querystring", "locationName": "aggregateTypes", "type": "list", "member": {} }, "resolution": { "location": "querystring", "locationName": "resolution" }, "qualities": { "shape": "S55", "location": "querystring", "locationName": "qualities" }, "startDate": { "location": "querystring", "locationName": "startDate", "type": "timestamp" }, "endDate": { "location": "querystring", "locationName": "endDate", "type": "timestamp" }, "timeOrdering": { "location": "querystring", "locationName": "timeOrdering" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "aggregatedValues" ], "members": { "aggregatedValues": { "type": "list", "member": { "type": "structure", "required": [ "timestamp", "value" ], "members": { "timestamp": { "type": "timestamp" }, "quality": {}, "value": { "type": "structure", "members": { "average": { "type": "double" }, "count": { "type": "double" }, "maximum": { "type": "double" }, "minimum": { "type": "double" }, "sum": { "type": "double" }, "standardDeviation": { "type": "double" } } } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "data." } }, "GetAssetPropertyValue": { "http": { "method": "GET", "requestUri": "/properties/latest" }, "input": { "type": "structure", "members": { "assetId": { "location": "querystring", "locationName": "assetId" }, "propertyId": { "location": "querystring", "locationName": "propertyId" }, "propertyAlias": { "location": "querystring", "locationName": "propertyAlias" } } }, "output": { "type": "structure", "members": { "propertyValue": { "shape": "Sk" } } }, "endpoint": { "hostPrefix": "data." } }, "GetAssetPropertyValueHistory": { "http": { "method": "GET", "requestUri": "/properties/history" }, "input": { "type": "structure", "members": { "assetId": { "location": "querystring", "locationName": "assetId" }, "propertyId": { "location": "querystring", "locationName": "propertyId" }, "propertyAlias": { "location": "querystring", "locationName": "propertyAlias" }, "startDate": { "location": "querystring", "locationName": "startDate", "type": "timestamp" }, "endDate": { "location": "querystring", "locationName": "endDate", "type": "timestamp" }, "qualities": { "shape": "S55", "location": "querystring", "locationName": "qualities" }, "timeOrdering": { "location": "querystring", "locationName": "timeOrdering" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "assetPropertyValueHistory" ], "members": { "assetPropertyValueHistory": { "type": "list", "member": { "shape": "Sk" } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "data." } }, "GetInterpolatedAssetPropertyValues": { "http": { "method": "GET", "requestUri": "/properties/interpolated" }, "input": { "type": "structure", "required": [ "startTimeInSeconds", "endTimeInSeconds", "quality", "intervalInSeconds", "type" ], "members": { "assetId": { "location": "querystring", "locationName": "assetId" }, "propertyId": { "location": "querystring", "locationName": "propertyId" }, "propertyAlias": { "location": "querystring", "locationName": "propertyAlias" }, "startTimeInSeconds": { "location": "querystring", "locationName": "startTimeInSeconds", "type": "long" }, "startTimeOffsetInNanos": { "location": "querystring", "locationName": "startTimeOffsetInNanos", "type": "integer" }, "endTimeInSeconds": { "location": "querystring", "locationName": "endTimeInSeconds", "type": "long" }, "endTimeOffsetInNanos": { "location": "querystring", "locationName": "endTimeOffsetInNanos", "type": "integer" }, "quality": { "location": "querystring", "locationName": "quality" }, "intervalInSeconds": { "location": "querystring", "locationName": "intervalInSeconds", "type": "long" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "type": { "location": "querystring", "locationName": "type" } } }, "output": { "type": "structure", "required": [ "interpolatedAssetPropertyValues" ], "members": { "interpolatedAssetPropertyValues": { "type": "list", "member": { "type": "structure", "required": [ "timestamp", "value" ], "members": { "timestamp": { "shape": "Sq" }, "value": { "shape": "Sl" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "data." } }, "ListAccessPolicies": { "http": { "method": "GET", "requestUri": "/access-policies", "responseCode": 200 }, "input": { "type": "structure", "members": { "identityType": { "location": "querystring", "locationName": "identityType" }, "identityId": { "location": "querystring", "locationName": "identityId" }, "resourceType": { "location": "querystring", "locationName": "resourceType" }, "resourceId": { "location": "querystring", "locationName": "resourceId" }, "iamArn": { "location": "querystring", "locationName": "iamArn" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "accessPolicySummaries" ], "members": { "accessPolicySummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "identity", "resource", "permission" ], "members": { "id": {}, "identity": { "shape": "S13" }, "resource": { "shape": "S1a" }, "permission": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "ListAssetModels": { "http": { "method": "GET", "requestUri": "/asset-models" }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "assetModelSummaries" ], "members": { "assetModelSummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "arn", "name", "description", "creationDate", "lastUpdateDate", "status" ], "members": { "id": {}, "arn": {}, "name": {}, "description": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" }, "status": { "shape": "S2f" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "model." } }, "ListAssetRelationships": { "http": { "method": "GET", "requestUri": "/assets/{assetId}/assetRelationships" }, "input": { "type": "structure", "required": [ "assetId", "traversalType" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "traversalType": { "location": "querystring", "locationName": "traversalType" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "assetRelationshipSummaries" ], "members": { "assetRelationshipSummaries": { "type": "list", "member": { "type": "structure", "required": [ "relationshipType" ], "members": { "hierarchyInfo": { "type": "structure", "members": { "parentAssetId": {}, "childAssetId": {} } }, "relationshipType": {} } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "model." } }, "ListAssets": { "http": { "method": "GET", "requestUri": "/assets" }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "assetModelId": { "location": "querystring", "locationName": "assetModelId" }, "filter": { "location": "querystring", "locationName": "filter" } } }, "output": { "type": "structure", "required": [ "assetSummaries" ], "members": { "assetSummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "arn", "name", "assetModelId", "creationDate", "lastUpdateDate", "status", "hierarchies" ], "members": { "id": {}, "arn": {}, "name": {}, "assetModelId": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" }, "status": { "shape": "S1l" }, "hierarchies": { "shape": "S3t" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "model." } }, "ListAssociatedAssets": { "http": { "method": "GET", "requestUri": "/assets/{assetId}/hierarchies" }, "input": { "type": "structure", "required": [ "assetId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "hierarchyId": { "location": "querystring", "locationName": "hierarchyId" }, "traversalDirection": { "location": "querystring", "locationName": "traversalDirection" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "assetSummaries" ], "members": { "assetSummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "arn", "name", "assetModelId", "creationDate", "lastUpdateDate", "status", "hierarchies" ], "members": { "id": {}, "arn": {}, "name": {}, "assetModelId": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" }, "status": { "shape": "S1l" }, "hierarchies": { "shape": "S3t" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "model." } }, "ListDashboards": { "http": { "method": "GET", "requestUri": "/dashboards", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId" ], "members": { "projectId": { "location": "querystring", "locationName": "projectId" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "dashboardSummaries" ], "members": { "dashboardSummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "name" ], "members": { "id": {}, "name": {}, "description": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "ListGateways": { "http": { "method": "GET", "requestUri": "/20200301/gateways" }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "gatewaySummaries" ], "members": { "gatewaySummaries": { "type": "list", "member": { "type": "structure", "required": [ "gatewayId", "gatewayName", "creationDate", "lastUpdateDate" ], "members": { "gatewayId": {}, "gatewayName": {}, "gatewayCapabilitySummaries": { "shape": "S4j" }, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "edge." } }, "ListPortals": { "http": { "method": "GET", "requestUri": "/portals", "responseCode": 200 }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "portalSummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "name", "startUrl", "status" ], "members": { "id": {}, "name": {}, "description": {}, "startUrl": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" }, "roleArn": {}, "status": { "shape": "S2x" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "ListProjectAssets": { "http": { "method": "GET", "requestUri": "/projects/{projectId}/assets", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "assetIds" ], "members": { "assetIds": { "type": "list", "member": {} }, "nextToken": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "ListProjects": { "http": { "method": "GET", "requestUri": "/projects", "responseCode": 200 }, "input": { "type": "structure", "required": [ "portalId" ], "members": { "portalId": { "location": "querystring", "locationName": "portalId" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "projectSummaries" ], "members": { "projectSummaries": { "type": "list", "member": { "type": "structure", "required": [ "id", "name" ], "members": { "id": {}, "name": {}, "description": {}, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "monitor." } }, "ListTagsForResource": { "http": { "method": "GET", "requestUri": "/tags" }, "input": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "location": "querystring", "locationName": "resourceArn" } } }, "output": { "type": "structure", "members": { "tags": { "shape": "S1e" } } } }, "PutDefaultEncryptionConfiguration": { "http": { "requestUri": "/configuration/account/encryption" }, "input": { "type": "structure", "required": [ "encryptionType" ], "members": { "encryptionType": {}, "kmsKeyId": {} } }, "output": { "type": "structure", "required": [ "encryptionType", "configurationStatus" ], "members": { "encryptionType": {}, "kmsKeyArn": {}, "configurationStatus": { "shape": "S4e" } } } }, "PutLoggingOptions": { "http": { "method": "PUT", "requestUri": "/logging" }, "input": { "type": "structure", "required": [ "loggingOptions" ], "members": { "loggingOptions": { "shape": "S4s" } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "model." } }, "TagResource": { "http": { "requestUri": "/tags" }, "input": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "location": "querystring", "locationName": "resourceArn" }, "tags": { "shape": "S1e" } } }, "output": { "type": "structure", "members": {} } }, "UntagResource": { "http": { "method": "DELETE", "requestUri": "/tags" }, "input": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "location": "querystring", "locationName": "resourceArn" }, "tagKeys": { "location": "querystring", "locationName": "tagKeys", "type": "list", "member": {} } } }, "output": { "type": "structure", "members": {} } }, "UpdateAccessPolicy": { "http": { "method": "PUT", "requestUri": "/access-policies/{accessPolicyId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "accessPolicyId", "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission" ], "members": { "accessPolicyId": { "location": "uri", "locationName": "accessPolicyId" }, "accessPolicyIdentity": { "shape": "S13" }, "accessPolicyResource": { "shape": "S1a" }, "accessPolicyPermission": {}, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "monitor." } }, "UpdateAsset": { "http": { "method": "PUT", "requestUri": "/assets/{assetId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetId", "assetName" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "assetName": {}, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "required": [ "assetStatus" ], "members": { "assetStatus": { "shape": "S1l" } } }, "endpoint": { "hostPrefix": "model." } }, "UpdateAssetModel": { "http": { "method": "PUT", "requestUri": "/asset-models/{assetModelId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetModelId", "assetModelName" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" }, "assetModelName": {}, "assetModelDescription": {}, "assetModelProperties": { "shape": "S3z" }, "assetModelHierarchies": { "shape": "S41" }, "assetModelCompositeModels": { "shape": "S43" }, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "required": [ "assetModelStatus" ], "members": { "assetModelStatus": { "shape": "S2f" } } }, "endpoint": { "hostPrefix": "model." } }, "UpdateAssetProperty": { "http": { "method": "PUT", "requestUri": "/assets/{assetId}/properties/{propertyId}" }, "input": { "type": "structure", "required": [ "assetId", "propertyId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "propertyId": { "location": "uri", "locationName": "propertyId" }, "propertyAlias": {}, "propertyNotificationState": {}, "clientToken": { "idempotencyToken": true } } }, "endpoint": { "hostPrefix": "model." } }, "UpdateDashboard": { "http": { "method": "PUT", "requestUri": "/dashboards/{dashboardId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "dashboardId", "dashboardName", "dashboardDefinition" ], "members": { "dashboardId": { "location": "uri", "locationName": "dashboardId" }, "dashboardName": {}, "dashboardDescription": {}, "dashboardDefinition": {}, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "monitor." } }, "UpdateGateway": { "http": { "method": "PUT", "requestUri": "/20200301/gateways/{gatewayId}" }, "input": { "type": "structure", "required": [ "gatewayId", "gatewayName" ], "members": { "gatewayId": { "location": "uri", "locationName": "gatewayId" }, "gatewayName": {} } }, "endpoint": { "hostPrefix": "edge." } }, "UpdateGatewayCapabilityConfiguration": { "http": { "requestUri": "/20200301/gateways/{gatewayId}/capability", "responseCode": 201 }, "input": { "type": "structure", "required": [ "gatewayId", "capabilityNamespace", "capabilityConfiguration" ], "members": { "gatewayId": { "location": "uri", "locationName": "gatewayId" }, "capabilityNamespace": {}, "capabilityConfiguration": {} } }, "output": { "type": "structure", "required": [ "capabilityNamespace", "capabilitySyncStatus" ], "members": { "capabilityNamespace": {}, "capabilitySyncStatus": {} } }, "endpoint": { "hostPrefix": "edge." } }, "UpdatePortal": { "http": { "method": "PUT", "requestUri": "/portals/{portalId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "portalId", "portalName", "portalContactEmail", "roleArn" ], "members": { "portalId": { "location": "uri", "locationName": "portalId" }, "portalName": {}, "portalDescription": {}, "portalContactEmail": {}, "portalLogoImage": { "type": "structure", "members": { "id": {}, "file": { "shape": "S2q" } } }, "roleArn": {}, "clientToken": { "idempotencyToken": true }, "notificationSenderEmail": {}, "alarms": { "shape": "S2u" } } }, "output": { "type": "structure", "required": [ "portalStatus" ], "members": { "portalStatus": { "shape": "S2x" } } }, "endpoint": { "hostPrefix": "monitor." } }, "UpdateProject": { "http": { "method": "PUT", "requestUri": "/projects/{projectId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId", "projectName" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" }, "projectName": {}, "projectDescription": {}, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": {} }, "endpoint": { "hostPrefix": "monitor." } } }, "shapes": { "S5": { "type": "list", "member": {} }, "S8": { "type": "structure", "required": [ "assetId", "code", "message" ], "members": { "assetId": {}, "code": {}, "message": {} } }, "Sk": { "type": "structure", "required": [ "value", "timestamp" ], "members": { "value": { "shape": "Sl" }, "timestamp": { "shape": "Sq" }, "quality": {} } }, "Sl": { "type": "structure", "members": { "stringValue": {}, "integerValue": { "type": "integer" }, "doubleValue": { "type": "double" }, "booleanValue": { "type": "boolean" } } }, "Sq": { "type": "structure", "required": [ "timeInSeconds" ], "members": { "timeInSeconds": { "type": "long" }, "offsetInNanos": { "type": "integer" } } }, "S13": { "type": "structure", "members": { "user": { "type": "structure", "required": [ "id" ], "members": { "id": {} } }, "group": { "type": "structure", "required": [ "id" ], "members": { "id": {} } }, "iamUser": { "type": "structure", "required": [ "arn" ], "members": { "arn": {} } }, "iamRole": { "type": "structure", "required": [ "arn" ], "members": { "arn": {} } } } }, "S1a": { "type": "structure", "members": { "portal": { "type": "structure", "required": [ "id" ], "members": { "id": {} } }, "project": { "type": "structure", "required": [ "id" ], "members": { "id": {} } } } }, "S1e": { "type": "map", "key": {}, "value": {} }, "S1l": { "type": "structure", "required": [ "state" ], "members": { "state": {}, "error": { "shape": "S1n" } } }, "S1n": { "type": "structure", "required": [ "code", "message" ], "members": { "code": {}, "message": {} } }, "S1r": { "type": "list", "member": { "type": "structure", "required": [ "name", "dataType", "type" ], "members": { "name": {}, "dataType": {}, "dataTypeSpec": {}, "unit": {}, "type": { "shape": "S1v" } } } }, "S1v": { "type": "structure", "members": { "attribute": { "type": "structure", "members": { "defaultValue": {} } }, "measurement": { "type": "structure", "members": {} }, "transform": { "type": "structure", "required": [ "expression", "variables" ], "members": { "expression": {}, "variables": { "shape": "S21" } } }, "metric": { "type": "structure", "required": [ "expression", "variables", "window" ], "members": { "expression": {}, "variables": { "shape": "S21" }, "window": { "type": "structure", "members": { "tumbling": { "type": "structure", "required": [ "interval" ], "members": { "interval": {} } } } } } } } }, "S21": { "type": "list", "member": { "type": "structure", "required": [ "name", "value" ], "members": { "name": {}, "value": { "type": "structure", "required": [ "propertyId" ], "members": { "propertyId": {}, "hierarchyId": {} } } } } }, "S2f": { "type": "structure", "required": [ "state" ], "members": { "state": {}, "error": { "shape": "S1n" } } }, "S2l": { "type": "structure", "required": [ "greengrass" ], "members": { "greengrass": { "type": "structure", "required": [ "groupArn" ], "members": { "groupArn": {} } } } }, "S2q": { "type": "structure", "required": [ "data", "type" ], "members": { "data": { "type": "blob" }, "type": {} } }, "S2u": { "type": "structure", "required": [ "alarmRoleArn" ], "members": { "alarmRoleArn": {}, "notificationLambdaArn": {} } }, "S2x": { "type": "structure", "required": [ "state" ], "members": { "state": {}, "error": { "type": "structure", "members": { "code": {}, "message": {} } } } }, "S3n": { "type": "list", "member": { "type": "structure", "required": [ "id", "name", "dataType" ], "members": { "id": {}, "name": {}, "alias": {}, "notification": { "shape": "S3q" }, "dataType": {}, "dataTypeSpec": {}, "unit": {} } } }, "S3q": { "type": "structure", "required": [ "topic", "state" ], "members": { "topic": {}, "state": {} } }, "S3t": { "type": "list", "member": { "type": "structure", "required": [ "name" ], "members": { "id": {}, "name": {} } } }, "S3z": { "type": "list", "member": { "type": "structure", "required": [ "name", "dataType", "type" ], "members": { "id": {}, "name": {}, "dataType": {}, "dataTypeSpec": {}, "unit": {}, "type": { "shape": "S1v" } } } }, "S41": { "type": "list", "member": { "type": "structure", "required": [ "name", "childAssetModelId" ], "members": { "id": {}, "name": {}, "childAssetModelId": {} } } }, "S43": { "type": "list", "member": { "type": "structure", "required": [ "name", "type" ], "members": { "name": {}, "description": {}, "type": {}, "properties": { "shape": "S3z" } } } }, "S47": { "type": "structure", "required": [ "id", "name", "dataType" ], "members": { "id": {}, "name": {}, "alias": {}, "notification": { "shape": "S3q" }, "dataType": {}, "unit": {}, "type": { "shape": "S1v" } } }, "S4e": { "type": "structure", "required": [ "state" ], "members": { "state": {}, "error": { "type": "structure", "required": [ "code", "message" ], "members": { "code": {}, "message": {} } } } }, "S4j": { "type": "list", "member": { "type": "structure", "required": [ "capabilityNamespace", "capabilitySyncStatus" ], "members": { "capabilityNamespace": {}, "capabilitySyncStatus": {} } } }, "S4s": { "type": "structure", "required": [ "level" ], "members": { "level": {} } }, "S55": { "type": "list", "member": {} } } }