aws-sdk-comprehendmedical 1.9.0 → 1.11.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -11,12 +11,23 @@ module Aws::ComprehendMedical
|
|
11
11
|
|
12
12
|
include Seahorse::Model
|
13
13
|
|
14
|
+
AnyLengthString = Shapes::StringShape.new(name: 'AnyLengthString')
|
14
15
|
Attribute = Shapes::StructureShape.new(name: 'Attribute')
|
15
16
|
AttributeList = Shapes::ListShape.new(name: 'AttributeList')
|
16
17
|
AttributeName = Shapes::StringShape.new(name: 'AttributeName')
|
17
18
|
BoundedLengthString = Shapes::StringShape.new(name: 'BoundedLengthString')
|
19
|
+
ClientRequestTokenString = Shapes::StringShape.new(name: 'ClientRequestTokenString')
|
20
|
+
ComprehendMedicalAsyncJobFilter = Shapes::StructureShape.new(name: 'ComprehendMedicalAsyncJobFilter')
|
21
|
+
ComprehendMedicalAsyncJobProperties = Shapes::StructureShape.new(name: 'ComprehendMedicalAsyncJobProperties')
|
22
|
+
ComprehendMedicalAsyncJobPropertiesList = Shapes::ListShape.new(name: 'ComprehendMedicalAsyncJobPropertiesList')
|
23
|
+
DescribeEntitiesDetectionV2JobRequest = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionV2JobRequest')
|
24
|
+
DescribeEntitiesDetectionV2JobResponse = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionV2JobResponse')
|
25
|
+
DescribePHIDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribePHIDetectionJobRequest')
|
26
|
+
DescribePHIDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribePHIDetectionJobResponse')
|
18
27
|
DetectEntitiesRequest = Shapes::StructureShape.new(name: 'DetectEntitiesRequest')
|
19
28
|
DetectEntitiesResponse = Shapes::StructureShape.new(name: 'DetectEntitiesResponse')
|
29
|
+
DetectEntitiesV2Request = Shapes::StructureShape.new(name: 'DetectEntitiesV2Request')
|
30
|
+
DetectEntitiesV2Response = Shapes::StructureShape.new(name: 'DetectEntitiesV2Response')
|
20
31
|
DetectPHIRequest = Shapes::StructureShape.new(name: 'DetectPHIRequest')
|
21
32
|
DetectPHIResponse = Shapes::StructureShape.new(name: 'DetectPHIResponse')
|
22
33
|
Entity = Shapes::StructureShape.new(name: 'Entity')
|
@@ -24,18 +35,46 @@ module Aws::ComprehendMedical
|
|
24
35
|
EntitySubType = Shapes::StringShape.new(name: 'EntitySubType')
|
25
36
|
EntityType = Shapes::StringShape.new(name: 'EntityType')
|
26
37
|
Float = Shapes::FloatShape.new(name: 'Float')
|
38
|
+
IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
|
39
|
+
InputDataConfig = Shapes::StructureShape.new(name: 'InputDataConfig')
|
27
40
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
28
41
|
InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
|
29
42
|
InvalidEncodingException = Shapes::StructureShape.new(name: 'InvalidEncodingException')
|
30
43
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
44
|
+
JobId = Shapes::StringShape.new(name: 'JobId')
|
45
|
+
JobName = Shapes::StringShape.new(name: 'JobName')
|
46
|
+
JobStatus = Shapes::StringShape.new(name: 'JobStatus')
|
47
|
+
KMSKey = Shapes::StringShape.new(name: 'KMSKey')
|
48
|
+
LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
|
49
|
+
ListEntitiesDetectionV2JobsRequest = Shapes::StructureShape.new(name: 'ListEntitiesDetectionV2JobsRequest')
|
50
|
+
ListEntitiesDetectionV2JobsResponse = Shapes::StructureShape.new(name: 'ListEntitiesDetectionV2JobsResponse')
|
51
|
+
ListPHIDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListPHIDetectionJobsRequest')
|
52
|
+
ListPHIDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListPHIDetectionJobsResponse')
|
53
|
+
ManifestFilePath = Shapes::StringShape.new(name: 'ManifestFilePath')
|
54
|
+
MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
|
55
|
+
ModelVersion = Shapes::StringShape.new(name: 'ModelVersion')
|
56
|
+
OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
|
57
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
58
|
+
S3Bucket = Shapes::StringShape.new(name: 'S3Bucket')
|
59
|
+
S3Key = Shapes::StringShape.new(name: 'S3Key')
|
31
60
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
61
|
+
StartEntitiesDetectionV2JobRequest = Shapes::StructureShape.new(name: 'StartEntitiesDetectionV2JobRequest')
|
62
|
+
StartEntitiesDetectionV2JobResponse = Shapes::StructureShape.new(name: 'StartEntitiesDetectionV2JobResponse')
|
63
|
+
StartPHIDetectionJobRequest = Shapes::StructureShape.new(name: 'StartPHIDetectionJobRequest')
|
64
|
+
StartPHIDetectionJobResponse = Shapes::StructureShape.new(name: 'StartPHIDetectionJobResponse')
|
65
|
+
StopEntitiesDetectionV2JobRequest = Shapes::StructureShape.new(name: 'StopEntitiesDetectionV2JobRequest')
|
66
|
+
StopEntitiesDetectionV2JobResponse = Shapes::StructureShape.new(name: 'StopEntitiesDetectionV2JobResponse')
|
67
|
+
StopPHIDetectionJobRequest = Shapes::StructureShape.new(name: 'StopPHIDetectionJobRequest')
|
68
|
+
StopPHIDetectionJobResponse = Shapes::StructureShape.new(name: 'StopPHIDetectionJobResponse')
|
32
69
|
String = Shapes::StringShape.new(name: 'String')
|
33
70
|
TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
|
71
|
+
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
34
72
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
35
73
|
Trait = Shapes::StructureShape.new(name: 'Trait')
|
36
74
|
TraitList = Shapes::ListShape.new(name: 'TraitList')
|
37
75
|
UnmappedAttribute = Shapes::StructureShape.new(name: 'UnmappedAttribute')
|
38
76
|
UnmappedAttributeList = Shapes::ListShape.new(name: 'UnmappedAttributeList')
|
77
|
+
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
39
78
|
|
40
79
|
Attribute.add_member(:type, Shapes::ShapeRef.new(shape: EntitySubType, location_name: "Type"))
|
41
80
|
Attribute.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
@@ -49,19 +88,66 @@ module Aws::ComprehendMedical
|
|
49
88
|
|
50
89
|
AttributeList.member = Shapes::ShapeRef.new(shape: Attribute)
|
51
90
|
|
91
|
+
ComprehendMedicalAsyncJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
92
|
+
ComprehendMedicalAsyncJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
93
|
+
ComprehendMedicalAsyncJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
94
|
+
ComprehendMedicalAsyncJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
95
|
+
ComprehendMedicalAsyncJobFilter.struct_class = Types::ComprehendMedicalAsyncJobFilter
|
96
|
+
|
97
|
+
ComprehendMedicalAsyncJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
98
|
+
ComprehendMedicalAsyncJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
99
|
+
ComprehendMedicalAsyncJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
100
|
+
ComprehendMedicalAsyncJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
101
|
+
ComprehendMedicalAsyncJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
102
|
+
ComprehendMedicalAsyncJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
103
|
+
ComprehendMedicalAsyncJobProperties.add_member(:expiration_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ExpirationTime"))
|
104
|
+
ComprehendMedicalAsyncJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
105
|
+
ComprehendMedicalAsyncJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
106
|
+
ComprehendMedicalAsyncJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
107
|
+
ComprehendMedicalAsyncJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
108
|
+
ComprehendMedicalAsyncJobProperties.add_member(:manifest_file_path, Shapes::ShapeRef.new(shape: ManifestFilePath, location_name: "ManifestFilePath"))
|
109
|
+
ComprehendMedicalAsyncJobProperties.add_member(:kms_key, Shapes::ShapeRef.new(shape: KMSKey, location_name: "KMSKey"))
|
110
|
+
ComprehendMedicalAsyncJobProperties.add_member(:model_version, Shapes::ShapeRef.new(shape: ModelVersion, location_name: "ModelVersion"))
|
111
|
+
ComprehendMedicalAsyncJobProperties.struct_class = Types::ComprehendMedicalAsyncJobProperties
|
112
|
+
|
113
|
+
ComprehendMedicalAsyncJobPropertiesList.member = Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobProperties)
|
114
|
+
|
115
|
+
DescribeEntitiesDetectionV2JobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
116
|
+
DescribeEntitiesDetectionV2JobRequest.struct_class = Types::DescribeEntitiesDetectionV2JobRequest
|
117
|
+
|
118
|
+
DescribeEntitiesDetectionV2JobResponse.add_member(:comprehend_medical_async_job_properties, Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobProperties, location_name: "ComprehendMedicalAsyncJobProperties"))
|
119
|
+
DescribeEntitiesDetectionV2JobResponse.struct_class = Types::DescribeEntitiesDetectionV2JobResponse
|
120
|
+
|
121
|
+
DescribePHIDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
122
|
+
DescribePHIDetectionJobRequest.struct_class = Types::DescribePHIDetectionJobRequest
|
123
|
+
|
124
|
+
DescribePHIDetectionJobResponse.add_member(:comprehend_medical_async_job_properties, Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobProperties, location_name: "ComprehendMedicalAsyncJobProperties"))
|
125
|
+
DescribePHIDetectionJobResponse.struct_class = Types::DescribePHIDetectionJobResponse
|
126
|
+
|
52
127
|
DetectEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: BoundedLengthString, required: true, location_name: "Text"))
|
53
128
|
DetectEntitiesRequest.struct_class = Types::DetectEntitiesRequest
|
54
129
|
|
55
130
|
DetectEntitiesResponse.add_member(:entities, Shapes::ShapeRef.new(shape: EntityList, required: true, location_name: "Entities"))
|
56
131
|
DetectEntitiesResponse.add_member(:unmapped_attributes, Shapes::ShapeRef.new(shape: UnmappedAttributeList, location_name: "UnmappedAttributes"))
|
57
132
|
DetectEntitiesResponse.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
|
133
|
+
DetectEntitiesResponse.add_member(:model_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ModelVersion"))
|
58
134
|
DetectEntitiesResponse.struct_class = Types::DetectEntitiesResponse
|
59
135
|
|
136
|
+
DetectEntitiesV2Request.add_member(:text, Shapes::ShapeRef.new(shape: BoundedLengthString, required: true, location_name: "Text"))
|
137
|
+
DetectEntitiesV2Request.struct_class = Types::DetectEntitiesV2Request
|
138
|
+
|
139
|
+
DetectEntitiesV2Response.add_member(:entities, Shapes::ShapeRef.new(shape: EntityList, required: true, location_name: "Entities"))
|
140
|
+
DetectEntitiesV2Response.add_member(:unmapped_attributes, Shapes::ShapeRef.new(shape: UnmappedAttributeList, location_name: "UnmappedAttributes"))
|
141
|
+
DetectEntitiesV2Response.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
|
142
|
+
DetectEntitiesV2Response.add_member(:model_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ModelVersion"))
|
143
|
+
DetectEntitiesV2Response.struct_class = Types::DetectEntitiesV2Response
|
144
|
+
|
60
145
|
DetectPHIRequest.add_member(:text, Shapes::ShapeRef.new(shape: BoundedLengthString, required: true, location_name: "Text"))
|
61
146
|
DetectPHIRequest.struct_class = Types::DetectPHIRequest
|
62
147
|
|
63
148
|
DetectPHIResponse.add_member(:entities, Shapes::ShapeRef.new(shape: EntityList, required: true, location_name: "Entities"))
|
64
149
|
DetectPHIResponse.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
|
150
|
+
DetectPHIResponse.add_member(:model_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ModelVersion"))
|
65
151
|
DetectPHIResponse.struct_class = Types::DetectPHIResponse
|
66
152
|
|
67
153
|
Entity.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
|
@@ -77,6 +163,10 @@ module Aws::ComprehendMedical
|
|
77
163
|
|
78
164
|
EntityList.member = Shapes::ShapeRef.new(shape: Entity)
|
79
165
|
|
166
|
+
InputDataConfig.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: S3Bucket, required: true, location_name: "S3Bucket"))
|
167
|
+
InputDataConfig.add_member(:s3_key, Shapes::ShapeRef.new(shape: S3Key, location_name: "S3Key"))
|
168
|
+
InputDataConfig.struct_class = Types::InputDataConfig
|
169
|
+
|
80
170
|
InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
81
171
|
InternalServerException.struct_class = Types::InternalServerException
|
82
172
|
|
@@ -86,9 +176,70 @@ module Aws::ComprehendMedical
|
|
86
176
|
InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
87
177
|
InvalidRequestException.struct_class = Types::InvalidRequestException
|
88
178
|
|
179
|
+
ListEntitiesDetectionV2JobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobFilter, location_name: "Filter"))
|
180
|
+
ListEntitiesDetectionV2JobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
181
|
+
ListEntitiesDetectionV2JobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
182
|
+
ListEntitiesDetectionV2JobsRequest.struct_class = Types::ListEntitiesDetectionV2JobsRequest
|
183
|
+
|
184
|
+
ListEntitiesDetectionV2JobsResponse.add_member(:comprehend_medical_async_job_properties_list, Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobPropertiesList, location_name: "ComprehendMedicalAsyncJobPropertiesList"))
|
185
|
+
ListEntitiesDetectionV2JobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
186
|
+
ListEntitiesDetectionV2JobsResponse.struct_class = Types::ListEntitiesDetectionV2JobsResponse
|
187
|
+
|
188
|
+
ListPHIDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobFilter, location_name: "Filter"))
|
189
|
+
ListPHIDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
190
|
+
ListPHIDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
191
|
+
ListPHIDetectionJobsRequest.struct_class = Types::ListPHIDetectionJobsRequest
|
192
|
+
|
193
|
+
ListPHIDetectionJobsResponse.add_member(:comprehend_medical_async_job_properties_list, Shapes::ShapeRef.new(shape: ComprehendMedicalAsyncJobPropertiesList, location_name: "ComprehendMedicalAsyncJobPropertiesList"))
|
194
|
+
ListPHIDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
195
|
+
ListPHIDetectionJobsResponse.struct_class = Types::ListPHIDetectionJobsResponse
|
196
|
+
|
197
|
+
OutputDataConfig.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: S3Bucket, required: true, location_name: "S3Bucket"))
|
198
|
+
OutputDataConfig.add_member(:s3_key, Shapes::ShapeRef.new(shape: S3Key, location_name: "S3Key"))
|
199
|
+
OutputDataConfig.struct_class = Types::OutputDataConfig
|
200
|
+
|
201
|
+
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
202
|
+
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
203
|
+
|
89
204
|
ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
90
205
|
ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
|
91
206
|
|
207
|
+
StartEntitiesDetectionV2JobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
208
|
+
StartEntitiesDetectionV2JobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
209
|
+
StartEntitiesDetectionV2JobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
210
|
+
StartEntitiesDetectionV2JobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
211
|
+
StartEntitiesDetectionV2JobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
212
|
+
StartEntitiesDetectionV2JobRequest.add_member(:kms_key, Shapes::ShapeRef.new(shape: KMSKey, location_name: "KMSKey"))
|
213
|
+
StartEntitiesDetectionV2JobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
214
|
+
StartEntitiesDetectionV2JobRequest.struct_class = Types::StartEntitiesDetectionV2JobRequest
|
215
|
+
|
216
|
+
StartEntitiesDetectionV2JobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
217
|
+
StartEntitiesDetectionV2JobResponse.struct_class = Types::StartEntitiesDetectionV2JobResponse
|
218
|
+
|
219
|
+
StartPHIDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
220
|
+
StartPHIDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
221
|
+
StartPHIDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
222
|
+
StartPHIDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
223
|
+
StartPHIDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
224
|
+
StartPHIDetectionJobRequest.add_member(:kms_key, Shapes::ShapeRef.new(shape: KMSKey, location_name: "KMSKey"))
|
225
|
+
StartPHIDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
226
|
+
StartPHIDetectionJobRequest.struct_class = Types::StartPHIDetectionJobRequest
|
227
|
+
|
228
|
+
StartPHIDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
229
|
+
StartPHIDetectionJobResponse.struct_class = Types::StartPHIDetectionJobResponse
|
230
|
+
|
231
|
+
StopEntitiesDetectionV2JobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
232
|
+
StopEntitiesDetectionV2JobRequest.struct_class = Types::StopEntitiesDetectionV2JobRequest
|
233
|
+
|
234
|
+
StopEntitiesDetectionV2JobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
235
|
+
StopEntitiesDetectionV2JobResponse.struct_class = Types::StopEntitiesDetectionV2JobResponse
|
236
|
+
|
237
|
+
StopPHIDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
238
|
+
StopPHIDetectionJobRequest.struct_class = Types::StopPHIDetectionJobRequest
|
239
|
+
|
240
|
+
StopPHIDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
241
|
+
StopPHIDetectionJobResponse.struct_class = Types::StopPHIDetectionJobResponse
|
242
|
+
|
92
243
|
TextSizeLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
93
244
|
TextSizeLimitExceededException.struct_class = Types::TextSizeLimitExceededException
|
94
245
|
|
@@ -107,6 +258,9 @@ module Aws::ComprehendMedical
|
|
107
258
|
|
108
259
|
UnmappedAttributeList.member = Shapes::ShapeRef.new(shape: UnmappedAttribute)
|
109
260
|
|
261
|
+
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
262
|
+
ValidationException.struct_class = Types::ValidationException
|
263
|
+
|
110
264
|
|
111
265
|
# @api private
|
112
266
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -127,10 +281,35 @@ module Aws::ComprehendMedical
|
|
127
281
|
"uid" => "comprehendmedical-2018-10-30",
|
128
282
|
}
|
129
283
|
|
284
|
+
api.add_operation(:describe_entities_detection_v2_job, Seahorse::Model::Operation.new.tap do |o|
|
285
|
+
o.name = "DescribeEntitiesDetectionV2Job"
|
286
|
+
o.http_method = "POST"
|
287
|
+
o.http_request_uri = "/"
|
288
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeEntitiesDetectionV2JobRequest)
|
289
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeEntitiesDetectionV2JobResponse)
|
290
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
291
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
292
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
293
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
294
|
+
end)
|
295
|
+
|
296
|
+
api.add_operation(:describe_phi_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
297
|
+
o.name = "DescribePHIDetectionJob"
|
298
|
+
o.http_method = "POST"
|
299
|
+
o.http_request_uri = "/"
|
300
|
+
o.input = Shapes::ShapeRef.new(shape: DescribePHIDetectionJobRequest)
|
301
|
+
o.output = Shapes::ShapeRef.new(shape: DescribePHIDetectionJobResponse)
|
302
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
303
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
304
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
305
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
306
|
+
end)
|
307
|
+
|
130
308
|
api.add_operation(:detect_entities, Seahorse::Model::Operation.new.tap do |o|
|
131
309
|
o.name = "DetectEntities"
|
132
310
|
o.http_method = "POST"
|
133
311
|
o.http_request_uri = "/"
|
312
|
+
o.deprecated = true
|
134
313
|
o.input = Shapes::ShapeRef.new(shape: DetectEntitiesRequest)
|
135
314
|
o.output = Shapes::ShapeRef.new(shape: DetectEntitiesResponse)
|
136
315
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
@@ -141,6 +320,20 @@ module Aws::ComprehendMedical
|
|
141
320
|
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
142
321
|
end)
|
143
322
|
|
323
|
+
api.add_operation(:detect_entities_v2, Seahorse::Model::Operation.new.tap do |o|
|
324
|
+
o.name = "DetectEntitiesV2"
|
325
|
+
o.http_method = "POST"
|
326
|
+
o.http_request_uri = "/"
|
327
|
+
o.input = Shapes::ShapeRef.new(shape: DetectEntitiesV2Request)
|
328
|
+
o.output = Shapes::ShapeRef.new(shape: DetectEntitiesV2Response)
|
329
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
330
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
331
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
332
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
333
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidEncodingException)
|
334
|
+
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
335
|
+
end)
|
336
|
+
|
144
337
|
api.add_operation(:detect_phi, Seahorse::Model::Operation.new.tap do |o|
|
145
338
|
o.name = "DetectPHI"
|
146
339
|
o.http_method = "POST"
|
@@ -154,6 +347,76 @@ module Aws::ComprehendMedical
|
|
154
347
|
o.errors << Shapes::ShapeRef.new(shape: InvalidEncodingException)
|
155
348
|
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
156
349
|
end)
|
350
|
+
|
351
|
+
api.add_operation(:list_entities_detection_v2_jobs, Seahorse::Model::Operation.new.tap do |o|
|
352
|
+
o.name = "ListEntitiesDetectionV2Jobs"
|
353
|
+
o.http_method = "POST"
|
354
|
+
o.http_request_uri = "/"
|
355
|
+
o.input = Shapes::ShapeRef.new(shape: ListEntitiesDetectionV2JobsRequest)
|
356
|
+
o.output = Shapes::ShapeRef.new(shape: ListEntitiesDetectionV2JobsResponse)
|
357
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
358
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
359
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
360
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
361
|
+
end)
|
362
|
+
|
363
|
+
api.add_operation(:list_phi_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
364
|
+
o.name = "ListPHIDetectionJobs"
|
365
|
+
o.http_method = "POST"
|
366
|
+
o.http_request_uri = "/"
|
367
|
+
o.input = Shapes::ShapeRef.new(shape: ListPHIDetectionJobsRequest)
|
368
|
+
o.output = Shapes::ShapeRef.new(shape: ListPHIDetectionJobsResponse)
|
369
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
370
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
371
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
372
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
373
|
+
end)
|
374
|
+
|
375
|
+
api.add_operation(:start_entities_detection_v2_job, Seahorse::Model::Operation.new.tap do |o|
|
376
|
+
o.name = "StartEntitiesDetectionV2Job"
|
377
|
+
o.http_method = "POST"
|
378
|
+
o.http_request_uri = "/"
|
379
|
+
o.input = Shapes::ShapeRef.new(shape: StartEntitiesDetectionV2JobRequest)
|
380
|
+
o.output = Shapes::ShapeRef.new(shape: StartEntitiesDetectionV2JobResponse)
|
381
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
382
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
383
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
384
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
385
|
+
end)
|
386
|
+
|
387
|
+
api.add_operation(:start_phi_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
388
|
+
o.name = "StartPHIDetectionJob"
|
389
|
+
o.http_method = "POST"
|
390
|
+
o.http_request_uri = "/"
|
391
|
+
o.input = Shapes::ShapeRef.new(shape: StartPHIDetectionJobRequest)
|
392
|
+
o.output = Shapes::ShapeRef.new(shape: StartPHIDetectionJobResponse)
|
393
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
394
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
395
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
396
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
397
|
+
end)
|
398
|
+
|
399
|
+
api.add_operation(:stop_entities_detection_v2_job, Seahorse::Model::Operation.new.tap do |o|
|
400
|
+
o.name = "StopEntitiesDetectionV2Job"
|
401
|
+
o.http_method = "POST"
|
402
|
+
o.http_request_uri = "/"
|
403
|
+
o.input = Shapes::ShapeRef.new(shape: StopEntitiesDetectionV2JobRequest)
|
404
|
+
o.output = Shapes::ShapeRef.new(shape: StopEntitiesDetectionV2JobResponse)
|
405
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
406
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
407
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
408
|
+
end)
|
409
|
+
|
410
|
+
api.add_operation(:stop_phi_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
411
|
+
o.name = "StopPHIDetectionJob"
|
412
|
+
o.http_method = "POST"
|
413
|
+
o.http_request_uri = "/"
|
414
|
+
o.input = Shapes::ShapeRef.new(shape: StopPHIDetectionJobRequest)
|
415
|
+
o.output = Shapes::ShapeRef.new(shape: StopPHIDetectionJobResponse)
|
416
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
417
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
418
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
419
|
+
end)
|
157
420
|
end
|
158
421
|
|
159
422
|
end
|
@@ -58,6 +58,22 @@ module Aws::ComprehendMedical
|
|
58
58
|
|
59
59
|
end
|
60
60
|
|
61
|
+
class ResourceNotFoundException < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::ComprehendMedical::Types::ResourceNotFoundException] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def message
|
72
|
+
@message || @data[:message]
|
73
|
+
end
|
74
|
+
|
75
|
+
end
|
76
|
+
|
61
77
|
class ServiceUnavailableException < ServiceError
|
62
78
|
|
63
79
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -106,5 +122,21 @@ module Aws::ComprehendMedical
|
|
106
122
|
|
107
123
|
end
|
108
124
|
|
125
|
+
class ValidationException < ServiceError
|
126
|
+
|
127
|
+
# @param [Seahorse::Client::RequestContext] context
|
128
|
+
# @param [String] message
|
129
|
+
# @param [Aws::ComprehendMedical::Types::ValidationException] data
|
130
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
131
|
+
super(context, message, data)
|
132
|
+
end
|
133
|
+
|
134
|
+
# @return [String]
|
135
|
+
def message
|
136
|
+
@message || @data[:message]
|
137
|
+
end
|
138
|
+
|
139
|
+
end
|
140
|
+
|
109
141
|
end
|
110
142
|
end
|
@@ -19,12 +19,12 @@ module Aws::ComprehendMedical
|
|
19
19
|
# @return [String]
|
20
20
|
#
|
21
21
|
# @!attribute [rw] score
|
22
|
-
# The level of confidence that Comprehend Medical has that the
|
23
|
-
# of text is correctly recognized as an attribute.
|
22
|
+
# The level of confidence that Amazon Comprehend Medical has that the
|
23
|
+
# segment of text is correctly recognized as an attribute.
|
24
24
|
# @return [Float]
|
25
25
|
#
|
26
26
|
# @!attribute [rw] relationship_score
|
27
|
-
# The level of confidence that Comprehend Medical has that this
|
27
|
+
# The level of confidence that Amazon Comprehend Medical has that this
|
28
28
|
# attribute is correctly related to this entity.
|
29
29
|
# @return [Float]
|
30
30
|
#
|
@@ -68,6 +68,204 @@ module Aws::ComprehendMedical
|
|
68
68
|
include Aws::Structure
|
69
69
|
end
|
70
70
|
|
71
|
+
# Provides information for filtering a list of detection jobs.
|
72
|
+
#
|
73
|
+
# @note When making an API call, you may pass ComprehendMedicalAsyncJobFilter
|
74
|
+
# data as a hash:
|
75
|
+
#
|
76
|
+
# {
|
77
|
+
# job_name: "JobName",
|
78
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
79
|
+
# submit_time_before: Time.now,
|
80
|
+
# submit_time_after: Time.now,
|
81
|
+
# }
|
82
|
+
#
|
83
|
+
# @!attribute [rw] job_name
|
84
|
+
# Filters on the name of the job.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] job_status
|
88
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
89
|
+
# the specified status.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] submit_time_before
|
93
|
+
# Filters the list of jobs based on the time that the job was
|
94
|
+
# submitted for processing. Returns only jobs submitted before the
|
95
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
96
|
+
# newest.
|
97
|
+
# @return [Time]
|
98
|
+
#
|
99
|
+
# @!attribute [rw] submit_time_after
|
100
|
+
# Filters the list of jobs based on the time that the job was
|
101
|
+
# submitted for processing. Returns only jobs submitted after the
|
102
|
+
# specified time. Jobs are returned in descending order, newest to
|
103
|
+
# oldest.
|
104
|
+
# @return [Time]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ComprehendMedicalAsyncJobFilter AWS API Documentation
|
107
|
+
#
|
108
|
+
class ComprehendMedicalAsyncJobFilter < Struct.new(
|
109
|
+
:job_name,
|
110
|
+
:job_status,
|
111
|
+
:submit_time_before,
|
112
|
+
:submit_time_after)
|
113
|
+
include Aws::Structure
|
114
|
+
end
|
115
|
+
|
116
|
+
# Provides information about a detection job.
|
117
|
+
#
|
118
|
+
# @!attribute [rw] job_id
|
119
|
+
# The identifier assigned to the detection job.
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] job_name
|
123
|
+
# The name that you assigned to the detection job.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] job_status
|
127
|
+
# The current status of the detection job. If the status is `FAILED`,
|
128
|
+
# the `Message` field shows the reason for the failure.
|
129
|
+
# @return [String]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] message
|
132
|
+
# A description of the status of a job.
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] submit_time
|
136
|
+
# The time that the detection job was submitted for processing.
|
137
|
+
# @return [Time]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] end_time
|
140
|
+
# The time that the detection job completed.
|
141
|
+
# @return [Time]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] expiration_time
|
144
|
+
# The date and time that job metadata is deleted from the server.
|
145
|
+
# Output files in your S3 bucket will not be deleted. After the
|
146
|
+
# metadata is deleted, the job will no longer appear in the results of
|
147
|
+
# the `ListEntitiesDetectionV2Job` or the `ListPHIDetectionJobs`
|
148
|
+
# operation.
|
149
|
+
# @return [Time]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] input_data_config
|
152
|
+
# The input data configuration that you supplied when you created the
|
153
|
+
# detection job.
|
154
|
+
# @return [Types::InputDataConfig]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] output_data_config
|
157
|
+
# The output data configuration that you supplied when you created the
|
158
|
+
# detection job.
|
159
|
+
# @return [Types::OutputDataConfig]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] language_code
|
162
|
+
# The language code of the input documents.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] data_access_role_arn
|
166
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical
|
167
|
+
# read access to your input data.
|
168
|
+
# @return [String]
|
169
|
+
#
|
170
|
+
# @!attribute [rw] manifest_file_path
|
171
|
+
# The path to the file that describes the results of a batch job.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] kms_key
|
175
|
+
# The AWS Key Management Service key, if any, used to encrypt the
|
176
|
+
# output files.
|
177
|
+
# @return [String]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] model_version
|
180
|
+
# The version of the model used to analyze the documents. The version
|
181
|
+
# number looks like X.X.X. You can use this information to track the
|
182
|
+
# model used for a particular batch of documents.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ComprehendMedicalAsyncJobProperties AWS API Documentation
|
186
|
+
#
|
187
|
+
class ComprehendMedicalAsyncJobProperties < Struct.new(
|
188
|
+
:job_id,
|
189
|
+
:job_name,
|
190
|
+
:job_status,
|
191
|
+
:message,
|
192
|
+
:submit_time,
|
193
|
+
:end_time,
|
194
|
+
:expiration_time,
|
195
|
+
:input_data_config,
|
196
|
+
:output_data_config,
|
197
|
+
:language_code,
|
198
|
+
:data_access_role_arn,
|
199
|
+
:manifest_file_path,
|
200
|
+
:kms_key,
|
201
|
+
:model_version)
|
202
|
+
include Aws::Structure
|
203
|
+
end
|
204
|
+
|
205
|
+
# @note When making an API call, you may pass DescribeEntitiesDetectionV2JobRequest
|
206
|
+
# data as a hash:
|
207
|
+
#
|
208
|
+
# {
|
209
|
+
# job_id: "JobId", # required
|
210
|
+
# }
|
211
|
+
#
|
212
|
+
# @!attribute [rw] job_id
|
213
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
214
|
+
# The `StartEntitiesDetectionV2Job` operation returns this identifier
|
215
|
+
# in its response.
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobRequest AWS API Documentation
|
219
|
+
#
|
220
|
+
class DescribeEntitiesDetectionV2JobRequest < Struct.new(
|
221
|
+
:job_id)
|
222
|
+
include Aws::Structure
|
223
|
+
end
|
224
|
+
|
225
|
+
# @!attribute [rw] comprehend_medical_async_job_properties
|
226
|
+
# An object that contains the properties associated with a detection
|
227
|
+
# job.
|
228
|
+
# @return [Types::ComprehendMedicalAsyncJobProperties]
|
229
|
+
#
|
230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobResponse AWS API Documentation
|
231
|
+
#
|
232
|
+
class DescribeEntitiesDetectionV2JobResponse < Struct.new(
|
233
|
+
:comprehend_medical_async_job_properties)
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# @note When making an API call, you may pass DescribePHIDetectionJobRequest
|
238
|
+
# data as a hash:
|
239
|
+
#
|
240
|
+
# {
|
241
|
+
# job_id: "JobId", # required
|
242
|
+
# }
|
243
|
+
#
|
244
|
+
# @!attribute [rw] job_id
|
245
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
246
|
+
# The `StartPHIDetectionJob` operation returns this identifier in its
|
247
|
+
# response.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJobRequest AWS API Documentation
|
251
|
+
#
|
252
|
+
class DescribePHIDetectionJobRequest < Struct.new(
|
253
|
+
:job_id)
|
254
|
+
include Aws::Structure
|
255
|
+
end
|
256
|
+
|
257
|
+
# @!attribute [rw] comprehend_medical_async_job_properties
|
258
|
+
# An object that contains the properties associated with a detection
|
259
|
+
# job.
|
260
|
+
# @return [Types::ComprehendMedicalAsyncJobProperties]
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJobResponse AWS API Documentation
|
263
|
+
#
|
264
|
+
class DescribePHIDetectionJobResponse < Struct.new(
|
265
|
+
:comprehend_medical_async_job_properties)
|
266
|
+
include Aws::Structure
|
267
|
+
end
|
268
|
+
|
71
269
|
# @note When making an API call, you may pass DetectEntitiesRequest
|
72
270
|
# data as a hash:
|
73
271
|
#
|
@@ -92,9 +290,9 @@ module Aws::ComprehendMedical
|
|
92
290
|
# The collection of medical entities extracted from the input text and
|
93
291
|
# their associated information. For each entity, the response provides
|
94
292
|
# the entity text, the entity category, where the entity text begins
|
95
|
-
# and ends, and the level of confidence that Comprehend Medical
|
96
|
-
# the detection and analysis. Attributes and traits of the
|
97
|
-
# also returned.
|
293
|
+
# and ends, and the level of confidence that Amazon Comprehend Medical
|
294
|
+
# has in the detection and analysis. Attributes and traits of the
|
295
|
+
# entity are also returned.
|
98
296
|
# @return [Array<Types::Entity>]
|
99
297
|
#
|
100
298
|
# @!attribute [rw] unmapped_attributes
|
@@ -103,17 +301,78 @@ module Aws::ComprehendMedical
|
|
103
301
|
# @return [Array<Types::UnmappedAttribute>]
|
104
302
|
#
|
105
303
|
# @!attribute [rw] pagination_token
|
106
|
-
# If the result of the previous request to DetectEntities was
|
107
|
-
# truncated, include the
|
304
|
+
# If the result of the previous request to `DetectEntities` was
|
305
|
+
# truncated, include the `PaginationToken` to fetch the next page of
|
108
306
|
# entities.
|
109
307
|
# @return [String]
|
110
308
|
#
|
309
|
+
# @!attribute [rw] model_version
|
310
|
+
# The version of the model used to analyze the documents. The version
|
311
|
+
# number looks like X.X.X. You can use this information to track the
|
312
|
+
# model used for a particular batch of documents.
|
313
|
+
# @return [String]
|
314
|
+
#
|
111
315
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesResponse AWS API Documentation
|
112
316
|
#
|
113
317
|
class DetectEntitiesResponse < Struct.new(
|
114
318
|
:entities,
|
115
319
|
:unmapped_attributes,
|
116
|
-
:pagination_token
|
320
|
+
:pagination_token,
|
321
|
+
:model_version)
|
322
|
+
include Aws::Structure
|
323
|
+
end
|
324
|
+
|
325
|
+
# @note When making an API call, you may pass DetectEntitiesV2Request
|
326
|
+
# data as a hash:
|
327
|
+
#
|
328
|
+
# {
|
329
|
+
# text: "BoundedLengthString", # required
|
330
|
+
# }
|
331
|
+
#
|
332
|
+
# @!attribute [rw] text
|
333
|
+
# A UTF-8 string containing the clinical content being examined for
|
334
|
+
# entities. Each string must contain fewer than 20,000 bytes of
|
335
|
+
# characters.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2Request AWS API Documentation
|
339
|
+
#
|
340
|
+
class DetectEntitiesV2Request < Struct.new(
|
341
|
+
:text)
|
342
|
+
include Aws::Structure
|
343
|
+
end
|
344
|
+
|
345
|
+
# @!attribute [rw] entities
|
346
|
+
# The collection of medical entities extracted from the input text and
|
347
|
+
# their associated information. For each entity, the response provides
|
348
|
+
# the entity text, the entity category, where the entity text begins
|
349
|
+
# and ends, and the level of confidence in the detection and analysis.
|
350
|
+
# Attributes and traits of the entity are also returned.
|
351
|
+
# @return [Array<Types::Entity>]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] unmapped_attributes
|
354
|
+
# Attributes extracted from the input text that couldn't be related
|
355
|
+
# to an entity.
|
356
|
+
# @return [Array<Types::UnmappedAttribute>]
|
357
|
+
#
|
358
|
+
# @!attribute [rw] pagination_token
|
359
|
+
# If the result to the `DetectEntitiesV2` operation was truncated,
|
360
|
+
# include the `PaginationToken` to fetch the next page of entities.
|
361
|
+
# @return [String]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] model_version
|
364
|
+
# The version of the model used to analyze the documents. The version
|
365
|
+
# number looks like X.X.X. You can use this information to track the
|
366
|
+
# model used for a particular batch of documents.
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2Response AWS API Documentation
|
370
|
+
#
|
371
|
+
class DetectEntitiesV2Response < Struct.new(
|
372
|
+
:entities,
|
373
|
+
:unmapped_attributes,
|
374
|
+
:pagination_token,
|
375
|
+
:model_version)
|
117
376
|
include Aws::Structure
|
118
377
|
end
|
119
378
|
|
@@ -141,20 +400,28 @@ module Aws::ComprehendMedical
|
|
141
400
|
# The collection of PHI entities extracted from the input text and
|
142
401
|
# their associated information. For each entity, the response provides
|
143
402
|
# the entity text, the entity category, where the entity text begins
|
144
|
-
# and ends, and the level of confidence that Comprehend Medical
|
145
|
-
# its detection.
|
403
|
+
# and ends, and the level of confidence that Amazon Comprehend Medical
|
404
|
+
# has in its detection.
|
146
405
|
# @return [Array<Types::Entity>]
|
147
406
|
#
|
148
407
|
# @!attribute [rw] pagination_token
|
149
|
-
# If the result of the previous request to DetectPHI was truncated,
|
150
|
-
# include the
|
408
|
+
# If the result of the previous request to `DetectPHI` was truncated,
|
409
|
+
# include the `PaginationToken` to fetch the next page of PHI
|
410
|
+
# entities.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] model_version
|
414
|
+
# The version of the model used to analyze the documents. The version
|
415
|
+
# number looks like X.X.X. You can use this information to track the
|
416
|
+
# model used for a particular batch of documents.
|
151
417
|
# @return [String]
|
152
418
|
#
|
153
419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHIResponse AWS API Documentation
|
154
420
|
#
|
155
421
|
class DetectPHIResponse < Struct.new(
|
156
422
|
:entities,
|
157
|
-
:pagination_token
|
423
|
+
:pagination_token,
|
424
|
+
:model_version)
|
158
425
|
include Aws::Structure
|
159
426
|
end
|
160
427
|
|
@@ -178,8 +445,8 @@ module Aws::ComprehendMedical
|
|
178
445
|
# @return [Integer]
|
179
446
|
#
|
180
447
|
# @!attribute [rw] score
|
181
|
-
# The level of confidence that Comprehend Medical has in the
|
182
|
-
# of the detection.
|
448
|
+
# The level of confidence that Amazon Comprehend Medical has in the
|
449
|
+
# accuracy of the detection.
|
183
450
|
# @return [Float]
|
184
451
|
#
|
185
452
|
# @!attribute [rw] text
|
@@ -217,6 +484,36 @@ module Aws::ComprehendMedical
|
|
217
484
|
include Aws::Structure
|
218
485
|
end
|
219
486
|
|
487
|
+
# The input properties for an entities detection job
|
488
|
+
#
|
489
|
+
# @note When making an API call, you may pass InputDataConfig
|
490
|
+
# data as a hash:
|
491
|
+
#
|
492
|
+
# {
|
493
|
+
# s3_bucket: "S3Bucket", # required
|
494
|
+
# s3_key: "S3Key",
|
495
|
+
# }
|
496
|
+
#
|
497
|
+
# @!attribute [rw] s3_bucket
|
498
|
+
# The URI of the S3 bucket that contains the input data. The bucket
|
499
|
+
# must be in the same region as the API endpoint that you are calling.
|
500
|
+
#
|
501
|
+
# Each file in the document collection must be less than 40 KB. You
|
502
|
+
# can store a maximum of 30 GB in the bucket.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] s3_key
|
506
|
+
# The path to the input data files in the S3 bucket.
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InputDataConfig AWS API Documentation
|
510
|
+
#
|
511
|
+
class InputDataConfig < Struct.new(
|
512
|
+
:s3_bucket,
|
513
|
+
:s3_key)
|
514
|
+
include Aws::Structure
|
515
|
+
end
|
516
|
+
|
220
517
|
# An internal server error occurred. Retry your request.
|
221
518
|
#
|
222
519
|
# @!attribute [rw] message
|
@@ -255,8 +552,162 @@ module Aws::ComprehendMedical
|
|
255
552
|
include Aws::Structure
|
256
553
|
end
|
257
554
|
|
258
|
-
#
|
259
|
-
#
|
555
|
+
# @note When making an API call, you may pass ListEntitiesDetectionV2JobsRequest
|
556
|
+
# data as a hash:
|
557
|
+
#
|
558
|
+
# {
|
559
|
+
# filter: {
|
560
|
+
# job_name: "JobName",
|
561
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
562
|
+
# submit_time_before: Time.now,
|
563
|
+
# submit_time_after: Time.now,
|
564
|
+
# },
|
565
|
+
# next_token: "String",
|
566
|
+
# max_results: 1,
|
567
|
+
# }
|
568
|
+
#
|
569
|
+
# @!attribute [rw] filter
|
570
|
+
# Filters the jobs that are returned. You can filter jobs based on
|
571
|
+
# their names, status, or the date and time that they were submitted.
|
572
|
+
# You can only set one filter at a time.
|
573
|
+
# @return [Types::ComprehendMedicalAsyncJobFilter]
|
574
|
+
#
|
575
|
+
# @!attribute [rw] next_token
|
576
|
+
# Identifies the next page of results to return.
|
577
|
+
# @return [String]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] max_results
|
580
|
+
# The maximum number of results to return in each page. The default is
|
581
|
+
# 100.
|
582
|
+
# @return [Integer]
|
583
|
+
#
|
584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2JobsRequest AWS API Documentation
|
585
|
+
#
|
586
|
+
class ListEntitiesDetectionV2JobsRequest < Struct.new(
|
587
|
+
:filter,
|
588
|
+
:next_token,
|
589
|
+
:max_results)
|
590
|
+
include Aws::Structure
|
591
|
+
end
|
592
|
+
|
593
|
+
# @!attribute [rw] comprehend_medical_async_job_properties_list
|
594
|
+
# A list containing the properties of each job returned.
|
595
|
+
# @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] next_token
|
598
|
+
# Identifies the next page of results to return.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2JobsResponse AWS API Documentation
|
602
|
+
#
|
603
|
+
class ListEntitiesDetectionV2JobsResponse < Struct.new(
|
604
|
+
:comprehend_medical_async_job_properties_list,
|
605
|
+
:next_token)
|
606
|
+
include Aws::Structure
|
607
|
+
end
|
608
|
+
|
609
|
+
# @note When making an API call, you may pass ListPHIDetectionJobsRequest
|
610
|
+
# data as a hash:
|
611
|
+
#
|
612
|
+
# {
|
613
|
+
# filter: {
|
614
|
+
# job_name: "JobName",
|
615
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
616
|
+
# submit_time_before: Time.now,
|
617
|
+
# submit_time_after: Time.now,
|
618
|
+
# },
|
619
|
+
# next_token: "String",
|
620
|
+
# max_results: 1,
|
621
|
+
# }
|
622
|
+
#
|
623
|
+
# @!attribute [rw] filter
|
624
|
+
# Filters the jobs that are returned. You can filter jobs based on
|
625
|
+
# their names, status, or the date and time that they were submitted.
|
626
|
+
# You can only set one filter at a time.
|
627
|
+
# @return [Types::ComprehendMedicalAsyncJobFilter]
|
628
|
+
#
|
629
|
+
# @!attribute [rw] next_token
|
630
|
+
# Identifies the next page of results to return.
|
631
|
+
# @return [String]
|
632
|
+
#
|
633
|
+
# @!attribute [rw] max_results
|
634
|
+
# The maximum number of results to return in each page. The default is
|
635
|
+
# 100.
|
636
|
+
# @return [Integer]
|
637
|
+
#
|
638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobsRequest AWS API Documentation
|
639
|
+
#
|
640
|
+
class ListPHIDetectionJobsRequest < Struct.new(
|
641
|
+
:filter,
|
642
|
+
:next_token,
|
643
|
+
:max_results)
|
644
|
+
include Aws::Structure
|
645
|
+
end
|
646
|
+
|
647
|
+
# @!attribute [rw] comprehend_medical_async_job_properties_list
|
648
|
+
# A list containing the properties of each job returned.
|
649
|
+
# @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] next_token
|
652
|
+
# Identifies the next page of results to return.
|
653
|
+
# @return [String]
|
654
|
+
#
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobsResponse AWS API Documentation
|
656
|
+
#
|
657
|
+
class ListPHIDetectionJobsResponse < Struct.new(
|
658
|
+
:comprehend_medical_async_job_properties_list,
|
659
|
+
:next_token)
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# The output properties for a detection job.
|
664
|
+
#
|
665
|
+
# @note When making an API call, you may pass OutputDataConfig
|
666
|
+
# data as a hash:
|
667
|
+
#
|
668
|
+
# {
|
669
|
+
# s3_bucket: "S3Bucket", # required
|
670
|
+
# s3_key: "S3Key",
|
671
|
+
# }
|
672
|
+
#
|
673
|
+
# @!attribute [rw] s3_bucket
|
674
|
+
# When you use the `OutputDataConfig` object with asynchronous
|
675
|
+
# operations, you specify the Amazon S3 location where you want to
|
676
|
+
# write the output data. The URI must be in the same region as the API
|
677
|
+
# endpoint that you are calling. The location is used as the prefix
|
678
|
+
# for the actual location of the output.
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] s3_key
|
682
|
+
# The path to the output data files in the S3 bucket. Amazon
|
683
|
+
# Comprehend Medical creates an output directory using the job ID so
|
684
|
+
# that the output from one job does not overwrite the output of
|
685
|
+
# another.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/OutputDataConfig AWS API Documentation
|
689
|
+
#
|
690
|
+
class OutputDataConfig < Struct.new(
|
691
|
+
:s3_bucket,
|
692
|
+
:s3_key)
|
693
|
+
include Aws::Structure
|
694
|
+
end
|
695
|
+
|
696
|
+
# The resource identified by the specified Amazon Resource Name (ARN)
|
697
|
+
# was not found. Check the ARN and try your request again.
|
698
|
+
#
|
699
|
+
# @!attribute [rw] message
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ResourceNotFoundException AWS API Documentation
|
703
|
+
#
|
704
|
+
class ResourceNotFoundException < Struct.new(
|
705
|
+
:message)
|
706
|
+
include Aws::Structure
|
707
|
+
end
|
708
|
+
|
709
|
+
# The Amazon Comprehend Medical service is temporarily unavailable.
|
710
|
+
# Please wait and then retry your request.
|
260
711
|
#
|
261
712
|
# @!attribute [rw] message
|
262
713
|
# @return [String]
|
@@ -268,6 +719,236 @@ module Aws::ComprehendMedical
|
|
268
719
|
include Aws::Structure
|
269
720
|
end
|
270
721
|
|
722
|
+
# @note When making an API call, you may pass StartEntitiesDetectionV2JobRequest
|
723
|
+
# data as a hash:
|
724
|
+
#
|
725
|
+
# {
|
726
|
+
# input_data_config: { # required
|
727
|
+
# s3_bucket: "S3Bucket", # required
|
728
|
+
# s3_key: "S3Key",
|
729
|
+
# },
|
730
|
+
# output_data_config: { # required
|
731
|
+
# s3_bucket: "S3Bucket", # required
|
732
|
+
# s3_key: "S3Key",
|
733
|
+
# },
|
734
|
+
# data_access_role_arn: "IamRoleArn", # required
|
735
|
+
# job_name: "JobName",
|
736
|
+
# client_request_token: "ClientRequestTokenString",
|
737
|
+
# kms_key: "KMSKey",
|
738
|
+
# language_code: "en", # required, accepts en
|
739
|
+
# }
|
740
|
+
#
|
741
|
+
# @!attribute [rw] input_data_config
|
742
|
+
# Specifies the format and location of the input data for the job.
|
743
|
+
# @return [Types::InputDataConfig]
|
744
|
+
#
|
745
|
+
# @!attribute [rw] output_data_config
|
746
|
+
# Specifies where to send the output files.
|
747
|
+
# @return [Types::OutputDataConfig]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] data_access_role_arn
|
750
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
751
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
752
|
+
# access to your input data. For more information, see [ Role-Based
|
753
|
+
# Permissions Required for Asynchronous Operations][1].
|
754
|
+
#
|
755
|
+
#
|
756
|
+
#
|
757
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] job_name
|
761
|
+
# The identifier of the job.
|
762
|
+
# @return [String]
|
763
|
+
#
|
764
|
+
# @!attribute [rw] client_request_token
|
765
|
+
# A unique identifier for the request. If you don't set the client
|
766
|
+
# request token, Amazon Comprehend Medical generates one.
|
767
|
+
#
|
768
|
+
# **A suitable default value is auto-generated.** You should normally
|
769
|
+
# not need to pass this option.
|
770
|
+
# @return [String]
|
771
|
+
#
|
772
|
+
# @!attribute [rw] kms_key
|
773
|
+
# An AWS Key Management Service key to encrypt your output files. If
|
774
|
+
# you do not specify a key, the files are written in plain text.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @!attribute [rw] language_code
|
778
|
+
# The language of the input documents. All documents must be in the
|
779
|
+
# same language.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobRequest AWS API Documentation
|
783
|
+
#
|
784
|
+
class StartEntitiesDetectionV2JobRequest < Struct.new(
|
785
|
+
:input_data_config,
|
786
|
+
:output_data_config,
|
787
|
+
:data_access_role_arn,
|
788
|
+
:job_name,
|
789
|
+
:client_request_token,
|
790
|
+
:kms_key,
|
791
|
+
:language_code)
|
792
|
+
include Aws::Structure
|
793
|
+
end
|
794
|
+
|
795
|
+
# @!attribute [rw] job_id
|
796
|
+
# The identifier generated for the job. To get the status of a job,
|
797
|
+
# use this identifier with the `DescribeEntitiesDetectionV2Job`
|
798
|
+
# operation.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobResponse AWS API Documentation
|
802
|
+
#
|
803
|
+
class StartEntitiesDetectionV2JobResponse < Struct.new(
|
804
|
+
:job_id)
|
805
|
+
include Aws::Structure
|
806
|
+
end
|
807
|
+
|
808
|
+
# @note When making an API call, you may pass StartPHIDetectionJobRequest
|
809
|
+
# data as a hash:
|
810
|
+
#
|
811
|
+
# {
|
812
|
+
# input_data_config: { # required
|
813
|
+
# s3_bucket: "S3Bucket", # required
|
814
|
+
# s3_key: "S3Key",
|
815
|
+
# },
|
816
|
+
# output_data_config: { # required
|
817
|
+
# s3_bucket: "S3Bucket", # required
|
818
|
+
# s3_key: "S3Key",
|
819
|
+
# },
|
820
|
+
# data_access_role_arn: "IamRoleArn", # required
|
821
|
+
# job_name: "JobName",
|
822
|
+
# client_request_token: "ClientRequestTokenString",
|
823
|
+
# kms_key: "KMSKey",
|
824
|
+
# language_code: "en", # required, accepts en
|
825
|
+
# }
|
826
|
+
#
|
827
|
+
# @!attribute [rw] input_data_config
|
828
|
+
# Specifies the format and location of the input data for the job.
|
829
|
+
# @return [Types::InputDataConfig]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] output_data_config
|
832
|
+
# Specifies where to send the output files.
|
833
|
+
# @return [Types::OutputDataConfig]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] data_access_role_arn
|
836
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
837
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
838
|
+
# access to your input data. For more information, see [ Role-Based
|
839
|
+
# Permissions Required for Asynchronous Operations][1].
|
840
|
+
#
|
841
|
+
#
|
842
|
+
#
|
843
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
|
844
|
+
# @return [String]
|
845
|
+
#
|
846
|
+
# @!attribute [rw] job_name
|
847
|
+
# The identifier of the job.
|
848
|
+
# @return [String]
|
849
|
+
#
|
850
|
+
# @!attribute [rw] client_request_token
|
851
|
+
# A unique identifier for the request. If you don't set the client
|
852
|
+
# request token, Amazon Comprehend Medical generates one.
|
853
|
+
#
|
854
|
+
# **A suitable default value is auto-generated.** You should normally
|
855
|
+
# not need to pass this option.
|
856
|
+
# @return [String]
|
857
|
+
#
|
858
|
+
# @!attribute [rw] kms_key
|
859
|
+
# An AWS Key Management Service key to encrypt your output files. If
|
860
|
+
# you do not specify a key, the files are written in plain text.
|
861
|
+
# @return [String]
|
862
|
+
#
|
863
|
+
# @!attribute [rw] language_code
|
864
|
+
# The language of the input documents. All documents must be in the
|
865
|
+
# same language.
|
866
|
+
# @return [String]
|
867
|
+
#
|
868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobRequest AWS API Documentation
|
869
|
+
#
|
870
|
+
class StartPHIDetectionJobRequest < Struct.new(
|
871
|
+
:input_data_config,
|
872
|
+
:output_data_config,
|
873
|
+
:data_access_role_arn,
|
874
|
+
:job_name,
|
875
|
+
:client_request_token,
|
876
|
+
:kms_key,
|
877
|
+
:language_code)
|
878
|
+
include Aws::Structure
|
879
|
+
end
|
880
|
+
|
881
|
+
# @!attribute [rw] job_id
|
882
|
+
# The identifier generated for the job. To get the status of a job,
|
883
|
+
# use this identifier with the `DescribePHIDetectionJob` operation.
|
884
|
+
# @return [String]
|
885
|
+
#
|
886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobResponse AWS API Documentation
|
887
|
+
#
|
888
|
+
class StartPHIDetectionJobResponse < Struct.new(
|
889
|
+
:job_id)
|
890
|
+
include Aws::Structure
|
891
|
+
end
|
892
|
+
|
893
|
+
# @note When making an API call, you may pass StopEntitiesDetectionV2JobRequest
|
894
|
+
# data as a hash:
|
895
|
+
#
|
896
|
+
# {
|
897
|
+
# job_id: "JobId", # required
|
898
|
+
# }
|
899
|
+
#
|
900
|
+
# @!attribute [rw] job_id
|
901
|
+
# The identifier of the medical entities job to stop.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2JobRequest AWS API Documentation
|
905
|
+
#
|
906
|
+
class StopEntitiesDetectionV2JobRequest < Struct.new(
|
907
|
+
:job_id)
|
908
|
+
include Aws::Structure
|
909
|
+
end
|
910
|
+
|
911
|
+
# @!attribute [rw] job_id
|
912
|
+
# The identifier of the medical entities detection job that was
|
913
|
+
# stopped.
|
914
|
+
# @return [String]
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2JobResponse AWS API Documentation
|
917
|
+
#
|
918
|
+
class StopEntitiesDetectionV2JobResponse < Struct.new(
|
919
|
+
:job_id)
|
920
|
+
include Aws::Structure
|
921
|
+
end
|
922
|
+
|
923
|
+
# @note When making an API call, you may pass StopPHIDetectionJobRequest
|
924
|
+
# data as a hash:
|
925
|
+
#
|
926
|
+
# {
|
927
|
+
# job_id: "JobId", # required
|
928
|
+
# }
|
929
|
+
#
|
930
|
+
# @!attribute [rw] job_id
|
931
|
+
# The identifier of the PHI detection job to stop.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJobRequest AWS API Documentation
|
935
|
+
#
|
936
|
+
class StopPHIDetectionJobRequest < Struct.new(
|
937
|
+
:job_id)
|
938
|
+
include Aws::Structure
|
939
|
+
end
|
940
|
+
|
941
|
+
# @!attribute [rw] job_id
|
942
|
+
# The identifier of the PHI detection job that was stopped.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJobResponse AWS API Documentation
|
946
|
+
#
|
947
|
+
class StopPHIDetectionJobResponse < Struct.new(
|
948
|
+
:job_id)
|
949
|
+
include Aws::Structure
|
950
|
+
end
|
951
|
+
|
271
952
|
# The size of the text you submitted exceeds the size limit. Reduce the
|
272
953
|
# size of the text or use a smaller document and then retry your
|
273
954
|
# request.
|
@@ -303,8 +984,8 @@ module Aws::ComprehendMedical
|
|
303
984
|
# @return [String]
|
304
985
|
#
|
305
986
|
# @!attribute [rw] score
|
306
|
-
# The level of confidence that Comprehend Medical has in the
|
307
|
-
# of this trait.
|
987
|
+
# The level of confidence that Amazon Comprehend Medical has in the
|
988
|
+
# accuracy of this trait.
|
308
989
|
# @return [Float]
|
309
990
|
#
|
310
991
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Trait AWS API Documentation
|
@@ -322,7 +1003,7 @@ module Aws::ComprehendMedical
|
|
322
1003
|
# The type of the attribute, could be one of the following values:
|
323
1004
|
# "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY",
|
324
1005
|
# "TEST\_AND\_TREATMENT\_PROCEDURE" or
|
325
|
-
# "
|
1006
|
+
# "PROTECTED\_HEALTH\_INFORMATION".
|
326
1007
|
# @return [String]
|
327
1008
|
#
|
328
1009
|
# @!attribute [rw] attribute
|
@@ -338,5 +1019,18 @@ module Aws::ComprehendMedical
|
|
338
1019
|
include Aws::Structure
|
339
1020
|
end
|
340
1021
|
|
1022
|
+
# The filter that you specified for the operation is invalid. Check the
|
1023
|
+
# filter values that you entered and try your request again.
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] message
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ValidationException AWS API Documentation
|
1029
|
+
#
|
1030
|
+
class ValidationException < Struct.new(
|
1031
|
+
:message)
|
1032
|
+
include Aws::Structure
|
1033
|
+
end
|
1034
|
+
|
341
1035
|
end
|
342
1036
|
end
|