UNPKG

@jgertig/aws-sdk

Version:
434 lines 8.85 kB
{ "version": "2.0", "metadata": { "apiVersion": "2018-10-30", "endpointPrefix": "comprehendmedical", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "ComprehendMedical", "serviceFullName": "AWS Comprehend Medical", "serviceId": "ComprehendMedical", "signatureVersion": "v4", "signingName": "comprehendmedical", "targetPrefix": "ComprehendMedical_20181030", "uid": "comprehendmedical-2018-10-30" }, "operations": { "DescribeEntitiesDetectionV2Job": { "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": {} } }, "output": { "type": "structure", "members": { "ComprehendMedicalAsyncJobProperties": { "shape": "S4" } } } }, "DescribePHIDetectionJob": { "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": {} } }, "output": { "type": "structure", "members": { "ComprehendMedicalAsyncJobProperties": { "shape": "S4" } } } }, "DetectEntities": { "input": { "type": "structure", "required": [ "Text" ], "members": { "Text": {} } }, "output": { "type": "structure", "required": [ "Entities", "ModelVersion" ], "members": { "Entities": { "shape": "Sn" }, "UnmappedAttributes": { "shape": "Sz" }, "PaginationToken": {}, "ModelVersion": {} } }, "deprecated": true, "deprecatedMessage": "This operation is deprecated, use DetectEntitiesV2 instead." }, "DetectEntitiesV2": { "input": { "type": "structure", "required": [ "Text" ], "members": { "Text": {} } }, "output": { "type": "structure", "required": [ "Entities", "ModelVersion" ], "members": { "Entities": { "shape": "Sn" }, "UnmappedAttributes": { "shape": "Sz" }, "PaginationToken": {}, "ModelVersion": {} } } }, "DetectPHI": { "input": { "type": "structure", "required": [ "Text" ], "members": { "Text": {} } }, "output": { "type": "structure", "required": [ "Entities", "ModelVersion" ], "members": { "Entities": { "shape": "Sn" }, "PaginationToken": {}, "ModelVersion": {} } } }, "ListEntitiesDetectionV2Jobs": { "input": { "type": "structure", "members": { "Filter": { "shape": "S16" }, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "ComprehendMedicalAsyncJobPropertiesList": { "shape": "S19" }, "NextToken": {} } } }, "ListPHIDetectionJobs": { "input": { "type": "structure", "members": { "Filter": { "shape": "S16" }, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "ComprehendMedicalAsyncJobPropertiesList": { "shape": "S19" }, "NextToken": {} } } }, "StartEntitiesDetectionV2Job": { "input": { "type": "structure", "required": [ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members": { "InputDataConfig": { "shape": "S9" }, "OutputDataConfig": { "shape": "Sc" }, "DataAccessRoleArn": {}, "JobName": {}, "ClientRequestToken": { "idempotencyToken": true }, "KMSKey": {}, "LanguageCode": {} } }, "output": { "type": "structure", "members": { "JobId": {} } } }, "StartPHIDetectionJob": { "input": { "type": "structure", "required": [ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members": { "InputDataConfig": { "shape": "S9" }, "OutputDataConfig": { "shape": "Sc" }, "DataAccessRoleArn": {}, "JobName": {}, "ClientRequestToken": { "idempotencyToken": true }, "KMSKey": {}, "LanguageCode": {} } }, "output": { "type": "structure", "members": { "JobId": {} } } }, "StopEntitiesDetectionV2Job": { "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": {} } }, "output": { "type": "structure", "members": { "JobId": {} } } }, "StopPHIDetectionJob": { "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": {} } }, "output": { "type": "structure", "members": { "JobId": {} } } } }, "shapes": { "S4": { "type": "structure", "members": { "JobId": {}, "JobName": {}, "JobStatus": {}, "Message": {}, "SubmitTime": { "type": "timestamp" }, "EndTime": { "type": "timestamp" }, "ExpirationTime": { "type": "timestamp" }, "InputDataConfig": { "shape": "S9" }, "OutputDataConfig": { "shape": "Sc" }, "LanguageCode": {}, "DataAccessRoleArn": {}, "ManifestFilePath": {}, "KMSKey": {}, "ModelVersion": {} } }, "S9": { "type": "structure", "required": [ "S3Bucket" ], "members": { "S3Bucket": {}, "S3Key": {} } }, "Sc": { "type": "structure", "required": [ "S3Bucket" ], "members": { "S3Bucket": {}, "S3Key": {} } }, "Sn": { "type": "list", "member": { "type": "structure", "members": { "Id": { "type": "integer" }, "BeginOffset": { "type": "integer" }, "EndOffset": { "type": "integer" }, "Score": { "type": "float" }, "Text": {}, "Category": {}, "Type": {}, "Traits": { "shape": "Su" }, "Attributes": { "type": "list", "member": { "shape": "Sy" } } } } }, "Su": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "Score": { "type": "float" } } } }, "Sy": { "type": "structure", "members": { "Type": {}, "Score": { "type": "float" }, "RelationshipScore": { "type": "float" }, "Id": { "type": "integer" }, "BeginOffset": { "type": "integer" }, "EndOffset": { "type": "integer" }, "Text": {}, "Traits": { "shape": "Su" } } }, "Sz": { "type": "list", "member": { "type": "structure", "members": { "Type": {}, "Attribute": { "shape": "Sy" } } } }, "S16": { "type": "structure", "members": { "JobName": {}, "JobStatus": {}, "SubmitTimeBefore": { "type": "timestamp" }, "SubmitTimeAfter": { "type": "timestamp" } } }, "S19": { "type": "list", "member": { "shape": "S4" } } } }