aws-sdk

{ "version": "2.0", "metadata": { "apiVersion": "2019-12-02", "endpointPrefix": "iotsitewise", "jsonVersion": "1.1", "protocol": "rest-json", "protocols": [ "rest-json" ], "serviceFullName": "AWS IoT SiteWise", "serviceId": "IoTSiteWise", "signatureVersion": "v4", "signingName": "iotsitewise", "uid": "iotsitewise-2019-12-02", "auth": [ "aws.auth#sigv4" ] }, "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": "api." } }, "AssociateTimeSeriesToAssetProperty": { "http": { "requestUri": "/timeseries/associate/" }, "input": { "type": "structure", "required": [ "alias", "assetId", "propertyId" ], "members": { "alias": { "location": "querystring", "locationName": "alias" }, "assetId": { "location": "querystring", "locationName": "assetId" }, "propertyId": { "location": "querystring", "locationName": "propertyId" }, "clientToken": { "idempotencyToken": true } } }, "endpoint": { "hostPrefix": "api." } }, "BatchAssociateProjectAssets": { "http": { "requestUri": "/projects/{projectId}/assets/associate", "responseCode": 200 }, "input": { "type": "structure", "required": [ "projectId", "assetIds" ], "members": { "projectId": { "location": "uri", "locationName": "projectId" }, "assetIds": { "shape": "S8" }, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": { "errors": { "type": "list", "member": { "shape": "Sb" } } } }, "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": "S8" }, "clientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": { "errors": { "type": "list", "member": { "shape": "Sb" } } } }, "endpoint": { "hostPrefix": "monitor." } }, "BatchGetAssetPropertyAggregates": { "http": { "requestUri": "/properties/batch/aggregates" }, "input": { "type": "structure", "required": [ "entries" ], "members": { "entries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "aggregateTypes", "resolution", "startDate", "endDate" ], "members": { "entryId": {}, "assetId": {}, "propertyId": {}, "propertyAlias": {}, "aggregateTypes": { "shape": "Sm" }, "resolution": {}, "startDate": { "type": "timestamp" }, "endDate": { "type": "timestamp" }, "qualities": { "shape": "Sq" }, "timeOrdering": {} } } }, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "required": [ "errorEntries", "successEntries", "skippedEntries" ], "members": { "errorEntries": { "type": "list", "member": { "type": "structure", "required": [ "errorCode", "errorMessage", "entryId" ], "members": { "errorCode": {}, "errorMessage": {}, "entryId": {} } } }, "successEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "aggregatedValues" ], "members": { "entryId": {}, "aggregatedValues": { "shape": "S12" } } } }, "skippedEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "completionStatus" ], "members": { "entryId": {}, "completionStatus": {}, "errorInfo": { "type": "structure", "required": [ "errorCode", "errorTimestamp" ], "members": { "errorCode": {}, "errorTimestamp": { "type": "timestamp" } } } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "data." } }, "BatchGetAssetPropertyValue": { "http": { "requestUri": "/properties/batch/latest" }, "input": { "type": "structure", "required": [ "entries" ], "members": { "entries": { "type": "list", "member": { "type": "structure", "required": [ "entryId" ], "members": { "entryId": {}, "assetId": {}, "propertyId": {}, "propertyAlias": {} } } }, "nextToken": {} } }, "output": { "type": "structure", "required": [ "errorEntries", "successEntries", "skippedEntries" ], "members": { "errorEntries": { "type": "list", "member": { "type": "structure", "required": [ "errorCode", "errorMessage", "entryId" ], "members": { "errorCode": {}, "errorMessage": {}, "entryId": {} } } }, "successEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId" ], "members": { "entryId": {}, "assetPropertyValue": { "shape": "S1j" } } } }, "skippedEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "completionStatus" ], "members": { "entryId": {}, "completionStatus": {}, "errorInfo": { "type": "structure", "required": [ "errorCode", "errorTimestamp" ], "members": { "errorCode": {}, "errorTimestamp": { "type": "timestamp" } } } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "data." } }, "BatchGetAssetPropertyValueHistory": { "http": { "requestUri": "/properties/batch/history" }, "input": { "type": "structure", "required": [ "entries" ], "members": { "entries": { "type": "list", "member": { "type": "structure", "required": [ "entryId" ], "members": { "entryId": {}, "assetId": {}, "propertyId": {}, "propertyAlias": {}, "startDate": { "type": "timestamp" }, "endDate": { "type": "timestamp" }, "qualities": { "shape": "Sq" }, "timeOrdering": {} } } }, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "required": [ "errorEntries", "successEntries", "skippedEntries" ], "members": { "errorEntries": { "type": "list", "member": { "type": "structure", "required": [ "errorCode", "errorMessage", "entryId" ], "members": { "errorCode": {}, "errorMessage": {}, "entryId": {} } } }, "successEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "assetPropertyValueHistory" ], "members": { "entryId": {}, "assetPropertyValueHistory": { "shape": "S25" } } } }, "skippedEntries": { "type": "list", "member": { "type": "structure", "required": [ "entryId", "completionStatus" ], "members": { "entryId": {}, "completionStatus": {}, "errorInfo": { "type": "structure", "required": [ "errorCode", "errorTimestamp" ], "members": { "errorCode": {}, "errorTimestamp": { "type": "timestamp" } } } } } }, "nextToken": {} } }, "endpoint": { "hostPrefix": "data." } }, "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": "S1j" } } } } } } }, "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": "S1p" } } } } } } } } } }, "endpoint": { "hostPrefix": "data." } }, "CreateAccessPolicy": { "http": { "requestUri": "/access-policies", "responseCode": 201 }, "input": { "type": "structure", "required": [ "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission" ], "members": { "accessPolicyIdentity": { "shape": "S2l" }, "accessPolicyResource": { "shape": "S2s" }, "accessPolicyPermission": {}, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S2w" } } }, "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": "S2w" }, "assetDescription": {}, "assetId": {}, "assetExternalId": {} } }, "output": { "type": "structure", "required": [ "assetId", "assetArn", "assetStatus" ], "members": { "assetId": {}, "assetArn": {}, "assetStatus": { "shape": "S35" } } }, "endpoint": { "hostPrefix": "api." } }, "CreateAssetModel": { "http": { "requestUri": "/asset-models", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetModelName" ], "members": { "assetModelName": {}, "assetModelType": {}, "assetModelId": {}, "assetModelExternalId": {}, "assetModelDescription": {}, "assetModelProperties": { "shape": "S3f" }, "assetModelHierarchies": { "type": "list", "member": { "type": "structure", "required": [ "name", "childAssetModelId" ], "members": { "id": {}, "externalId": {}, "name": {}, "childAssetModelId": {} } } }, "assetModelCompositeModels": { "type": "list", "member": { "type": "structure", "required": [ "name", "type" ], "members": { "id": {}, "externalId": {}, "name": {}, "description": {}, "type": {}, "properties": { "shape": "S3f" } } } }, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S2w" } } }, "output": { "type": "structure", "required": [ "assetModelId", "assetModelArn", "assetModelStatus" ], "members": { "assetModelId": {}, "assetModelArn": {}, "assetModelStatus": { "shape": "S4c" } } }, "endpoint": { "hostPrefix": "api." } }, "CreateAssetModelCompositeModel": { "http": { "requestUri": "/asset-models/{assetModelId}/composite-models", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetModelId", "assetModelCompositeModelName", "assetModelCompositeModelType" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" }, "assetModelCompositeModelExternalId": {}, "parentAssetModelCompositeModelId": {}, "assetModelCompositeModelId": {}, "assetModelCompositeModelDescription": {}, "assetModelCompositeModelName": {}, "assetModelCompositeModelType": {}, "clientToken": { "idempotencyToken": true }, "composedAssetModelId": {}, "assetModelCompositeModelProperties": { "shape": "S3f" }, "ifMatch": { "location": "header", "locationName": "If-Match" }, "ifNoneMatch": { "location": "header", "locationName": "If-None-Match" }, "matchForVersionType": { "location": "header", "locationName": "Match-For-Version-Type" } } }, "output": { "type": "structure", "required": [ "assetModelCompositeModelId", "assetModelCompositeModelPath", "assetModelStatus" ], "members": { "assetModelCompositeModelId": {}, "assetModelCompositeModelPath": { "shape": "S4j" }, "assetModelStatus": { "shape": "S4c" } } }, "endpoint": { "hostPrefix": "api." } }, "CreateBulkImportJob": { "http": { "requestUri": "/jobs", "responseCode": 202 }, "input": { "type": "structure", "required": [ "jobName", "jobRoleArn", "files", "errorReportLocation", "jobConfiguration" ], "members": { "jobName": {}, "jobRoleArn": {}, "files": { "shape": "S4m" }, "errorReportLocation": { "shape": "S4q" }, "jobConfiguration": { "shape": "S4r" }, "adaptiveIngestion": { "type": "boolean" }, "deleteFilesAfterImport": { "type": "boolean" } } }, "output": { "type": "structure", "required": [ "jobId", "jobName", "jobStatus" ], "members": { "jobId": {}, "jobName": {}, "jobStatus": {} } }, "endpoint": { "hostPrefix": "data." } }, "CreateDashboard": { "http": { "requestUri": "/dashboards", "responseCode": 201 }, "input": { "type": "structure", "required": [ "projectId", "dashboardName", "dashboardDefinition" ], "members": { "projectId": {}, "dashboardName": {}, "dashboardDescription": {}, "dashboardDefinition": {}, "clientToken": { "idempotencyToken": true }, "tags": { "shape": "S2w" } } }, "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": "S56" }, "tags": { "shape": "S2w" } } }, "output": { "type": "structure", "required": [ "gatewayId", "gatewayArn" ], "members": { "gatewayId": {}, "gatewayArn": {} } }, "endpoint": { "hostPrefix": "api." } }, "CreatePortal": { "http": { "requestUri": "/portals", "responseCode": 202 }, "input": { "type": "structure", "required": [ "portalName", "portalContactEmail", "roleArn" ], "members": { "portalName": {}, "portalDescription": {}, "portalContactEmail": {}, "clientToken": { "idempotencyToken": true }, "portalLogoImageFile": { "shape": "S5f" }, "roleArn": {}, "tags": { "shape": "S2w" }, "portalAuthMode": {}, "notificationSenderEmail": {}, "alarms": { "shape": "S5j" } } }, "output": { "type": "structure", "required": [ "portalId", "portalArn", "portalStartUrl", "portalStatus", "ssoApplicationId" ], "members": { "portalId": {}, "portalArn": {}, "portalStartUrl": {}, "portalStatus": { "shape": "S5m" }, "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": "S2w" } } }, "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": "S35" } } }, "endpoint": { "hostPrefix": "api." } }, "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" }, "ifMatch": { "location": "header", "locationName": "If-Match" }, "ifNoneMatch": { "location": "header", "locationName": "If-None-Match" }, "matchForVersionType": { "location": "header", "locationName": "Match-For-Version-Type" } } }, "output": { "type": "structure", "required": [ "assetModelStatus" ], "members": { "assetModelStatus": { "shape": "S4c" } } }, "endpoint": { "hostPrefix": "api." } }, "DeleteAssetModelCompositeModel": { "http": { "method": "DELETE", "requestUri": "/asset-models/{assetModelId}/composite-models/{assetModelCompositeModelId}", "responseCode": 202 }, "input": { "type": "structure", "required": [ "assetModelId", "assetModelCompositeModelId" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" }, "assetModelCompositeModelId": { "location": "uri", "locationName": "assetModelCompositeModelId" }, "clientToken": { "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" }, "ifMatch": { "location": "header", "locationName": "If-Match" }, "ifNoneMatch": { "location": "header", "locationName": "If-None-Match" }, "matchForVersionType": { "location": "header", "locationName": "Match-For-Version-Type" } } }, "output": { "type": "structure", "required": [ "assetModelStatus" ], "members": { "assetModelStatus": { "shape": "S4c" } } }, "endpoint": { "hostPrefix": "api." } }, "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": "api." } }, "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": "S5m" } } }, "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." } }, "DeleteTimeSeries": { "http": { "requestUri": "/timeseries/delete/" }, "input": { "type": "structure", "members": { "alias": { "location": "querystring", "locationName": "alias" }, "assetId": { "location": "querystring", "locationName": "assetId" }, "propertyId": { "location": "querystring", "locationName": "propertyId" }, "clientToken": { "idempotencyToken": true } } }, "endpoint": { "hostPrefix": "api." } }, "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": "S2l" }, "accessPolicyResource": { "shape": "S2s" }, "accessPolicyPermission": {}, "accessPolicyCreationDate": { "type": "timestamp" }, "accessPolicyLastUpdateDate": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "monitor." } }, "DescribeAction": { "http": { "method": "GET", "requestUri": "/actions/{actionId}" }, "input": { "type": "structure", "required": [ "actionId" ], "members": { "actionId": { "location": "uri", "locationName": "actionId" } } }, "output": { "type": "structure", "required": [ "actionId", "targetResource", "actionDefinitionId", "actionPayload", "executionTime" ], "members": { "actionId": {}, "targetResource": { "shape": "S6e" }, "actionDefinitionId": {}, "actionPayload": { "shape": "S6f" }, "executionTime": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "api." } }, "DescribeAsset": { "http": { "method": "GET", "requestUri": "/assets/{assetId}" }, "input": { "type": "structure", "required": [ "assetId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "excludeProperties": { "location": "querystring", "locationName": "excludeProperties", "type": "boolean" } } }, "output": { "type": "structure", "required": [ "assetId", "assetArn", "assetName", "assetModelId", "assetProperties", "assetHierarchies", "assetCreationDate", "assetLastUpdateDate", "assetStatus" ], "members": { "assetId": {}, "assetArn": {}, "assetName": {}, "assetModelId": {}, "assetProperties": { "shape": "S6k" }, "assetHierarchies": { "shape": "S6r" }, "assetCompositeModels": { "type": "list", "member": { "type": "structure", "required": [ "name", "type", "properties" ], "members": { "name": {}, "description": {}, "type": {}, "properties": { "shape": "S6k" }, "id": {}, "externalId": {} } } }, "assetCreationDate": { "type": "timestamp" }, "assetLastUpdateDate": { "type": "timestamp" }, "assetStatus": { "shape": "S35" }, "assetDescription": {}, "assetCompositeModelSummaries": { "shape": "S6v" }, "assetExternalId": {} } }, "endpoint": { "hostPrefix": "api." } }, "DescribeAssetCompositeModel": { "http": { "method": "GET", "requestUri": "/assets/{assetId}/composite-models/{assetCompositeModelId}" }, "input": { "type": "structure", "required": [ "assetId", "assetCompositeModelId" ], "members": { "assetId": { "location": "uri", "locationName": "assetId" }, "assetCompositeModelId": { "location": "uri", "locationName": "assetCompositeModelId" } } }, "output": { "type": "structure", "required": [ "assetId", "assetCompositeModelId", "assetCompositeModelPath", "assetCompositeModelName", "assetCompositeModelDescription", "assetCompositeModelType", "assetCompositeModelProperties", "assetCompositeModelSummaries" ], "members": { "assetId": {}, "assetCompositeModelId": {}, "assetCompositeModelExternalId": {}, "assetCompositeModelPath": { "shape": "S6x" }, "assetCompositeModelName": {}, "assetCompositeModelDescription": {}, "assetCompositeModelType": {}, "assetCompositeModelProperties": { "shape": "S6k" }, "assetCompositeModelSummaries": { "shape": "S6v" }, "actionDefinitions": { "shape": "S71" } } }, "endpoint": { "hostPrefix": "api." } }, "DescribeAssetModel": { "http": { "method": "GET", "requestUri": "/asset-models/{assetModelId}" }, "input": { "type": "structure", "required": [ "assetModelId" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" }, "excludeProperties": { "location": "querystring", "locationName": "excludeProperties", "type": "boolean" }, "assetModelVersion": { "location": "querystring", "locationName": "assetModelVersion" } } }, "output": { "type": "structure", "required": [ "assetModelId", "assetModelArn", "assetModelName", "assetModelDescription", "assetModelProperties", "assetModelHierarchies", "assetModelCreationDate", "assetModelLastUpdateDate", "assetModelStatus" ], "members": { "assetModelId": {}, "assetModelExternalId": {}, "assetModelArn": {}, "assetModelName": {}, "assetModelType": {}, "assetModelDescription": {}, "assetModelProperties": { "shape": "S76" }, "assetModelHierarchies": { "shape": "S78" }, "assetModelCompositeModels": { "shape": "S7a" }, "assetModelCompositeModelSummaries": { "shape": "S7c" }, "assetModelCreationDate": { "type": "timestamp" }, "assetModelLastUpdateDate": { "type": "timestamp" }, "assetModelStatus": { "shape": "S4c" }, "assetModelVersion": {}, "eTag": { "location": "header", "locationName": "ETag" } } }, "endpoint": { "hostPrefix": "api." } }, "DescribeAssetModelCompositeModel": { "http": { "method": "GET", "requestUri": "/asset-models/{assetModelId}/composite-models/{assetModelCompositeModelId}" }, "input": { "type": "structure", "required": [ "assetModelId", "assetModelCompositeModelId" ], "members": { "assetModelId": { "location": "uri", "locationName": "assetModelId" }, "assetModelCompositeModelId": { "location": "uri", "locationName": "assetModelCompositeModelId" }, "assetModelVersion": { "location": "querystring", "locationName": "assetModelVersion" } } }, "output": { "type": "structure", "required": [ "assetModelId", "assetModelCompositeModelId", "assetModelCompositeModelPath", "assetModelCompositeModelName", "assetModelCompositeModelDescription", "assetModelCompositeModelType", "assetModelCompositeModelProperties", "assetModelCompositeModelSummaries" ], "members": { "assetModelId": {}, "assetModelCompositeModelId": {}, "assetModelCompositeModelExternalId": {}, "assetModelCompositeModelPath": { "shape": "S4j" }, "assetModelCompositeModelName": {}, "assetModelCompositeModelDescription": {}, "assetModelCompositeModelType": {}, "assetModelCompositeModelProperties": { "shape": "S76" }, "compositionDetails": { "type": "structure", "members": { "compositionRelationship": { "type": "list", "member": { "type": "structure", "members": { "id": {} } } } } }, "assetModelCompositeModelSummaries": { "shape": "S7c" }, "actionDefinitions": { "shape": "S71" } } }, "endpoint": { "hostPrefix": "api." } }, "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": "S7m" }, "compositeModel": { "type": "structure", "required": [ "name", "type", "assetProperty" ], "members": { "name": {}, "type": {}, "assetProperty": { "shape": "S7m" }, "id": {}, "externalId": {} } }, "assetExternalId": {} } }, "endpoint": { "hostPrefix": "api." } }, "DescribeBulkImportJob": { "http": { "method": "GET", "requestUri": "/jobs/{jobId}" }, "input": { "type": "structure", "required": [ "jobId" ], "members": { "jobId": { "location": "uri", "locationName": "jobId" } } }, "output": { "type": "structure", "required": [ "jobId", "jobName", "jobStatus", "jobRoleArn", "files", "errorReportLocation", "jobConfiguration", "jobCreationDate", "jobLastUpdateDate" ], "members": { "jobId": {}, "jobName": {}, "jobStatus": {}, "jobRoleArn": {}, "files": { "shape": "S4m" }, "errorReportLocation": { "shape": "S4q" }, "jobConfiguration": { "shape": "S4r" }, "jobCreationDate": { "type": "timestamp" }, "jobLastUpdateDate": { "type": "timestamp" }, "adaptiveIngestion": { "type": "boolean" }, "deleteFilesAfterImport": { "type": "boolean" } } }, "endpoint": { "hostPrefix": "data." } }, "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": "S7v" } } }, "endpoint": { "hostPrefix": "api." } }, "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": "S56" }, "gatewayCapabilitySummaries": { "shape": "S80" }, "creationDate": { "type": "timestamp" }, "lastUpdateDate": { "type": "timestamp" } } }, "endpoint": { "hostPrefix": "api." } }, "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": "api." } }, "DescribeLoggingOptions": { "http": { "method": "GET", "requestUri": "/logging" }, "input": { "type": "structure", "members": {} }, "output": { "type": "structure", "required": [ "loggingOptions" ], "members": { "loggingOptions": { "shape": "S89" } } }, "endpoint": { "hostPrefix": "api." } }, "DescribePortal": { "http": { "method": "GET", "requestUri": "/portals/{portalId}", "responseCode": 200 }, "input": { "type": "structure", "required"