aws-sdk-comprehend 1.44.0 → 1.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 97ad3963c70493fd091a5c3019ba24ae72eec643a44ada58faf9cd9c60639595
4
- data.tar.gz: ea890d4c8078e40db1b78fbf7cb19ebce593563925caba288424bbf9523524e1
3
+ metadata.gz: cfbda392422e7cfed95b782c72ce15b3f982b566eb5a193539875327e9adee8b
4
+ data.tar.gz: c45342a8abe385cdc7cc9b32674b981f32acf4b39fd4a29333b0890f6201dc24
5
5
  SHA512:
6
- metadata.gz: d22df7d9dd5046979fc0a7136d98810419332d927995e3697ce7a5e1b2aa99570aa57b6b48c390c3fc505c48ab4b042b273a665372449dbc576373173f752514
7
- data.tar.gz: e6e6b3dd25e4d5a6282828c4ef18c00fc84c0d370692a463213bcdfd2512f7b33893cfce61dc60bf5319d9296c4aecb65f644c3b7b3b938ff7a3823e6bba06a8
6
+ metadata.gz: f48a8cd17bbc874d4fb039294a48208f34b5d995d739c2fda21fc6e4797baa69766df506b2d401c2e1fb58b8e0b916d470edd90f26caa3584e6c012c0e8c2c8c
7
+ data.tar.gz: b8dfc5a55b13921f2b2bef2b58fcde1702e6e98b9c7b7246e627823b0f637284acbb8b7cde152a017be134aefa3c6814a712f24f7b03286c1c3ed8ad7646a4d0
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.48.0 (2021-07-30)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.47.0 (2021-07-28)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.46.0 (2021-03-31)
15
+ ------------------
16
+
17
+ * Feature - Support for customer managed KMS encryption of Comprehend custom models
18
+
19
+ 1.45.0 (2021-03-11)
20
+ ------------------
21
+
22
+ * Feature - ContainsPiiEntities API analyzes the input text for the presence of personally identifiable information(PII) and returns the labels of identified PII entity types such as name, address etc.
23
+
4
24
  1.44.0 (2021-03-10)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.44.0
1
+ 1.48.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-comprehend/customizations'
48
48
  # @!group service
49
49
  module Aws::Comprehend
50
50
 
51
- GEM_VERSION = '1.44.0'
51
+ GEM_VERSION = '1.48.0'
52
52
 
53
53
  end
@@ -621,6 +621,44 @@ module Aws::Comprehend
621
621
  req.send_request(options)
622
622
  end
623
623
 
624
+ # Analyzes input text for the presence of personally identifiable
625
+ # information (PII) and returns the labels of identified PII entity
626
+ # types such as name, address, bank account number, or phone number.
627
+ #
628
+ # @option params [required, String] :text
629
+ # Creates a new document classification request to analyze a single
630
+ # document in real-time, returning personally identifiable information
631
+ # (PII) entity labels.
632
+ #
633
+ # @option params [required, String] :language_code
634
+ # The language of the input documents.
635
+ #
636
+ # @return [Types::ContainsPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
637
+ #
638
+ # * {Types::ContainsPiiEntitiesResponse#labels #labels} => Array<Types::EntityLabel>
639
+ #
640
+ # @example Request syntax with placeholder values
641
+ #
642
+ # resp = client.contains_pii_entities({
643
+ # text: "String", # required
644
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
645
+ # })
646
+ #
647
+ # @example Response structure
648
+ #
649
+ # resp.labels #=> Array
650
+ # resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
651
+ # resp.labels[0].score #=> Float
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities AWS API Documentation
654
+ #
655
+ # @overload contains_pii_entities(params = {})
656
+ # @param [Hash] params ({})
657
+ def contains_pii_entities(params = {}, options = {})
658
+ req = build_request(:contains_pii_entities, params)
659
+ req.send_request(options)
660
+ end
661
+
624
662
  # Creates a new document classifier that you can use to categorize
625
663
  # documents. To create a classifier, you provide a set of training
626
664
  # documents that labeled with the categories that you want to use. After
@@ -690,6 +728,16 @@ module Aws::Comprehend
690
728
  # multiple labels for an individual document are separated by a
691
729
  # delimiter. The default delimiter between labels is a pipe (\|).
692
730
  #
731
+ # @option params [String] :model_kms_key_id
732
+ # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
733
+ # uses to encrypt trained custom models. The ModelKmsKeyId can be either
734
+ # of the following formats:
735
+ #
736
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
737
+ #
738
+ # * Amazon Resource Name (ARN) of a KMS Key:
739
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
740
+ #
693
741
  # @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
694
742
  #
695
743
  # * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
@@ -728,6 +776,7 @@ module Aws::Comprehend
728
776
  # subnets: ["SubnetId"], # required
729
777
  # },
730
778
  # mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
779
+ # model_kms_key_id: "KmsKeyId",
731
780
  # })
732
781
  #
733
782
  # @example Response structure
@@ -773,6 +822,12 @@ module Aws::Comprehend
773
822
  # "Sales" as the key might be added to an endpoint to indicate its use
774
823
  # by the sales department.
775
824
  #
825
+ # @option params [String] :data_access_role_arn
826
+ # The Amazon Resource Name (ARN) of the AWS identity and Access
827
+ # Management (IAM) role that grants Amazon Comprehend read access to
828
+ # trained custom models encrypted with a customer managed key
829
+ # (ModelKmsKeyId).
830
+ #
776
831
  # @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
777
832
  #
778
833
  # * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
@@ -790,6 +845,7 @@ module Aws::Comprehend
790
845
  # value: "TagValue",
791
846
  # },
792
847
  # ],
848
+ # data_access_role_arn: "IamRoleArn",
793
849
  # })
794
850
  #
795
851
  # @example Response structure
@@ -864,6 +920,16 @@ module Aws::Comprehend
864
920
  #
865
921
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
866
922
  #
923
+ # @option params [String] :model_kms_key_id
924
+ # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
925
+ # uses to encrypt trained custom models. The ModelKmsKeyId can be either
926
+ # of the following formats
927
+ #
928
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
929
+ #
930
+ # * Amazon Resource Name (ARN) of a KMS Key:
931
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
932
+ #
867
933
  # @return [Types::CreateEntityRecognizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
868
934
  #
869
935
  # * {Types::CreateEntityRecognizerResponse#entity_recognizer_arn #entity_recognizer_arn} => String
@@ -909,6 +975,7 @@ module Aws::Comprehend
909
975
  # security_group_ids: ["SecurityGroupId"], # required
910
976
  # subnets: ["SubnetId"], # required
911
977
  # },
978
+ # model_kms_key_id: "KmsKeyId",
912
979
  # })
913
980
  #
914
981
  # @example Response structure
@@ -1110,6 +1177,7 @@ module Aws::Comprehend
1110
1177
  # resp.document_classifier_properties.vpc_config.subnets #=> Array
1111
1178
  # resp.document_classifier_properties.vpc_config.subnets[0] #=> String
1112
1179
  # resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
1180
+ # resp.document_classifier_properties.model_kms_key_id #=> String
1113
1181
  #
1114
1182
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
1115
1183
  #
@@ -1191,6 +1259,7 @@ module Aws::Comprehend
1191
1259
  # resp.endpoint_properties.current_inference_units #=> Integer
1192
1260
  # resp.endpoint_properties.creation_time #=> Time
1193
1261
  # resp.endpoint_properties.last_modified_time #=> Time
1262
+ # resp.endpoint_properties.data_access_role_arn #=> String
1194
1263
  #
1195
1264
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
1196
1265
  #
@@ -1302,6 +1371,7 @@ module Aws::Comprehend
1302
1371
  # resp.entity_recognizer_properties.vpc_config.security_group_ids[0] #=> String
1303
1372
  # resp.entity_recognizer_properties.vpc_config.subnets #=> Array
1304
1373
  # resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
1374
+ # resp.entity_recognizer_properties.model_kms_key_id #=> String
1305
1375
  #
1306
1376
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
1307
1377
  #
@@ -1927,6 +1997,7 @@ module Aws::Comprehend
1927
1997
  # resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
1928
1998
  # resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
1929
1999
  # resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
2000
+ # resp.document_classifier_properties_list[0].model_kms_key_id #=> String
1930
2001
  # resp.next_token #=> String
1931
2002
  #
1932
2003
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
@@ -2046,6 +2117,7 @@ module Aws::Comprehend
2046
2117
  # resp.endpoint_properties_list[0].current_inference_units #=> Integer
2047
2118
  # resp.endpoint_properties_list[0].creation_time #=> Time
2048
2119
  # resp.endpoint_properties_list[0].last_modified_time #=> Time
2120
+ # resp.endpoint_properties_list[0].data_access_role_arn #=> String
2049
2121
  # resp.next_token #=> String
2050
2122
  #
2051
2123
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
@@ -2201,6 +2273,7 @@ module Aws::Comprehend
2201
2273
  # resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids[0] #=> String
2202
2274
  # resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
2203
2275
  # resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
2276
+ # resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
2204
2277
  # resp.next_token #=> String
2205
2278
  #
2206
2279
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
@@ -3680,7 +3753,7 @@ module Aws::Comprehend
3680
3753
  params: params,
3681
3754
  config: config)
3682
3755
  context[:gem_name] = 'aws-sdk-comprehend'
3683
- context[:gem_version] = '1.44.0'
3756
+ context[:gem_version] = '1.48.0'
3684
3757
  Seahorse::Client::Request.new(handlers, context)
3685
3758
  end
3686
3759
 
@@ -46,6 +46,8 @@ module Aws::Comprehend
46
46
  ComprehendEndpointName = Shapes::StringShape.new(name: 'ComprehendEndpointName')
47
47
  ComprehendModelArn = Shapes::StringShape.new(name: 'ComprehendModelArn')
48
48
  ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException')
49
+ ContainsPiiEntitiesRequest = Shapes::StructureShape.new(name: 'ContainsPiiEntitiesRequest')
50
+ ContainsPiiEntitiesResponse = Shapes::StructureShape.new(name: 'ContainsPiiEntitiesResponse')
49
51
  CreateDocumentClassifierRequest = Shapes::StructureShape.new(name: 'CreateDocumentClassifierRequest')
50
52
  CreateDocumentClassifierResponse = Shapes::StructureShape.new(name: 'CreateDocumentClassifierResponse')
51
53
  CreateEndpointRequest = Shapes::StructureShape.new(name: 'CreateEndpointRequest')
@@ -122,6 +124,7 @@ module Aws::Comprehend
122
124
  EntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'EntitiesDetectionJobProperties')
123
125
  EntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EntitiesDetectionJobPropertiesList')
124
126
  Entity = Shapes::StructureShape.new(name: 'Entity')
127
+ EntityLabel = Shapes::StructureShape.new(name: 'EntityLabel')
125
128
  EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
126
129
  EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
127
130
  EntityRecognizerAugmentedManifestsList = Shapes::ListShape.new(name: 'EntityRecognizerAugmentedManifestsList')
@@ -191,6 +194,7 @@ module Aws::Comprehend
191
194
  ListOfDetectSyntaxResult = Shapes::ListShape.new(name: 'ListOfDetectSyntaxResult')
192
195
  ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
193
196
  ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
197
+ ListOfEntityLabels = Shapes::ListShape.new(name: 'ListOfEntityLabels')
194
198
  ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
195
199
  ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
196
200
  ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
@@ -395,6 +399,13 @@ module Aws::Comprehend
395
399
  ConcurrentModificationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
396
400
  ConcurrentModificationException.struct_class = Types::ConcurrentModificationException
397
401
 
402
+ ContainsPiiEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
403
+ ContainsPiiEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
404
+ ContainsPiiEntitiesRequest.struct_class = Types::ContainsPiiEntitiesRequest
405
+
406
+ ContainsPiiEntitiesResponse.add_member(:labels, Shapes::ShapeRef.new(shape: ListOfEntityLabels, location_name: "Labels"))
407
+ ContainsPiiEntitiesResponse.struct_class = Types::ContainsPiiEntitiesResponse
408
+
398
409
  CreateDocumentClassifierRequest.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "DocumentClassifierName"))
399
410
  CreateDocumentClassifierRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
400
411
  CreateDocumentClassifierRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
@@ -405,6 +416,7 @@ module Aws::Comprehend
405
416
  CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
406
417
  CreateDocumentClassifierRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
407
418
  CreateDocumentClassifierRequest.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
419
+ CreateDocumentClassifierRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
408
420
  CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
409
421
 
410
422
  CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
@@ -415,6 +427,7 @@ module Aws::Comprehend
415
427
  CreateEndpointRequest.add_member(:desired_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, required: true, location_name: "DesiredInferenceUnits"))
416
428
  CreateEndpointRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
417
429
  CreateEndpointRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
430
+ CreateEndpointRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
418
431
  CreateEndpointRequest.struct_class = Types::CreateEndpointRequest
419
432
 
420
433
  CreateEndpointResponse.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: ComprehendEndpointArn, location_name: "EndpointArn"))
@@ -428,6 +441,7 @@ module Aws::Comprehend
428
441
  CreateEntityRecognizerRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
429
442
  CreateEntityRecognizerRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
430
443
  CreateEntityRecognizerRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
444
+ CreateEntityRecognizerRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
431
445
  CreateEntityRecognizerRequest.struct_class = Types::CreateEntityRecognizerRequest
432
446
 
433
447
  CreateEntityRecognizerResponse.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
@@ -617,6 +631,7 @@ module Aws::Comprehend
617
631
  DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
618
632
  DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
619
633
  DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
634
+ DocumentClassifierProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
620
635
  DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
621
636
 
622
637
  DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
@@ -664,6 +679,7 @@ module Aws::Comprehend
664
679
  EndpointProperties.add_member(:current_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "CurrentInferenceUnits"))
665
680
  EndpointProperties.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
666
681
  EndpointProperties.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
682
+ EndpointProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
667
683
  EndpointProperties.struct_class = Types::EndpointProperties
668
684
 
669
685
  EndpointPropertiesList.member = Shapes::ShapeRef.new(shape: EndpointProperties)
@@ -698,6 +714,10 @@ module Aws::Comprehend
698
714
  Entity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
699
715
  Entity.struct_class = Types::Entity
700
716
 
717
+ EntityLabel.add_member(:name, Shapes::ShapeRef.new(shape: PiiEntityType, location_name: "Name"))
718
+ EntityLabel.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
719
+ EntityLabel.struct_class = Types::EntityLabel
720
+
701
721
  EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
702
722
  EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
703
723
 
@@ -753,6 +773,7 @@ module Aws::Comprehend
753
773
  EntityRecognizerProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
754
774
  EntityRecognizerProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
755
775
  EntityRecognizerProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
776
+ EntityRecognizerProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
756
777
  EntityRecognizerProperties.struct_class = Types::EntityRecognizerProperties
757
778
 
758
779
  EntityRecognizerPropertiesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerProperties)
@@ -923,6 +944,8 @@ module Aws::Comprehend
923
944
 
924
945
  ListOfEntities.member = Shapes::ShapeRef.new(shape: Entity)
925
946
 
947
+ ListOfEntityLabels.member = Shapes::ShapeRef.new(shape: EntityLabel)
948
+
926
949
  ListOfKeyPhrases.member = Shapes::ShapeRef.new(shape: KeyPhrase)
927
950
 
928
951
  ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
@@ -1390,6 +1413,18 @@ module Aws::Comprehend
1390
1413
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1391
1414
  end)
1392
1415
 
1416
+ api.add_operation(:contains_pii_entities, Seahorse::Model::Operation.new.tap do |o|
1417
+ o.name = "ContainsPiiEntities"
1418
+ o.http_method = "POST"
1419
+ o.http_request_uri = "/"
1420
+ o.input = Shapes::ShapeRef.new(shape: ContainsPiiEntitiesRequest)
1421
+ o.output = Shapes::ShapeRef.new(shape: ContainsPiiEntitiesResponse)
1422
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1423
+ o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
1424
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
1425
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1426
+ end)
1427
+
1393
1428
  api.add_operation(:create_document_classifier, Seahorse::Model::Operation.new.tap do |o|
1394
1429
  o.name = "CreateDocumentClassifier"
1395
1430
  o.http_method = "POST"
@@ -632,6 +632,46 @@ module Aws::Comprehend
632
632
  include Aws::Structure
633
633
  end
634
634
 
635
+ # @note When making an API call, you may pass ContainsPiiEntitiesRequest
636
+ # data as a hash:
637
+ #
638
+ # {
639
+ # text: "String", # required
640
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
641
+ # }
642
+ #
643
+ # @!attribute [rw] text
644
+ # Creates a new document classification request to analyze a single
645
+ # document in real-time, returning personally identifiable information
646
+ # (PII) entity labels.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] language_code
650
+ # The language of the input documents.
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesRequest AWS API Documentation
654
+ #
655
+ class ContainsPiiEntitiesRequest < Struct.new(
656
+ :text,
657
+ :language_code)
658
+ SENSITIVE = []
659
+ include Aws::Structure
660
+ end
661
+
662
+ # @!attribute [rw] labels
663
+ # The labels used in the document being analyzed. Individual labels
664
+ # represent personally identifiable information (PII) entity types.
665
+ # @return [Array<Types::EntityLabel>]
666
+ #
667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesResponse AWS API Documentation
668
+ #
669
+ class ContainsPiiEntitiesResponse < Struct.new(
670
+ :labels)
671
+ SENSITIVE = []
672
+ include Aws::Structure
673
+ end
674
+
635
675
  # @note When making an API call, you may pass CreateDocumentClassifierRequest
636
676
  # data as a hash:
637
677
  #
@@ -667,6 +707,7 @@ module Aws::Comprehend
667
707
  # subnets: ["SubnetId"], # required
668
708
  # },
669
709
  # mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
710
+ # model_kms_key_id: "KmsKeyId",
670
711
  # }
671
712
  #
672
713
  # @!attribute [rw] document_classifier_name
@@ -743,6 +784,17 @@ module Aws::Comprehend
743
784
  # delimiter. The default delimiter between labels is a pipe (\|).
744
785
  # @return [String]
745
786
  #
787
+ # @!attribute [rw] model_kms_key_id
788
+ # ID for the AWS Key Management Service (KMS) key that Amazon
789
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
790
+ # can be either of the following formats:
791
+ #
792
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
793
+ #
794
+ # * Amazon Resource Name (ARN) of a KMS Key:
795
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
796
+ # @return [String]
797
+ #
746
798
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
747
799
  #
748
800
  class CreateDocumentClassifierRequest < Struct.new(
@@ -755,7 +807,8 @@ module Aws::Comprehend
755
807
  :language_code,
756
808
  :volume_kms_key_id,
757
809
  :vpc_config,
758
- :mode)
810
+ :mode,
811
+ :model_kms_key_id)
759
812
  SENSITIVE = []
760
813
  include Aws::Structure
761
814
  end
@@ -787,6 +840,7 @@ module Aws::Comprehend
787
840
  # value: "TagValue",
788
841
  # },
789
842
  # ],
843
+ # data_access_role_arn: "IamRoleArn",
790
844
  # }
791
845
  #
792
846
  # @!attribute [rw] endpoint_name
@@ -821,6 +875,13 @@ module Aws::Comprehend
821
875
  # indicate its use by the sales department.
822
876
  # @return [Array<Types::Tag>]
823
877
  #
878
+ # @!attribute [rw] data_access_role_arn
879
+ # The Amazon Resource Name (ARN) of the AWS identity and Access
880
+ # Management (IAM) role that grants Amazon Comprehend read access to
881
+ # trained custom models encrypted with a customer managed key
882
+ # (ModelKmsKeyId).
883
+ # @return [String]
884
+ #
824
885
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
825
886
  #
826
887
  class CreateEndpointRequest < Struct.new(
@@ -828,7 +889,8 @@ module Aws::Comprehend
828
889
  :model_arn,
829
890
  :desired_inference_units,
830
891
  :client_request_token,
831
- :tags)
892
+ :tags,
893
+ :data_access_role_arn)
832
894
  SENSITIVE = []
833
895
  include Aws::Structure
834
896
  end
@@ -887,6 +949,7 @@ module Aws::Comprehend
887
949
  # security_group_ids: ["SecurityGroupId"], # required
888
950
  # subnets: ["SubnetId"], # required
889
951
  # },
952
+ # model_kms_key_id: "KmsKeyId",
890
953
  # }
891
954
  #
892
955
  # @!attribute [rw] recognizer_name
@@ -953,6 +1016,17 @@ module Aws::Comprehend
953
1016
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
954
1017
  # @return [Types::VpcConfig]
955
1018
  #
1019
+ # @!attribute [rw] model_kms_key_id
1020
+ # ID for the AWS Key Management Service (KMS) key that Amazon
1021
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1022
+ # can be either of the following formats
1023
+ #
1024
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1025
+ #
1026
+ # * Amazon Resource Name (ARN) of a KMS Key:
1027
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
1028
+ # @return [String]
1029
+ #
956
1030
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerRequest AWS API Documentation
957
1031
  #
958
1032
  class CreateEntityRecognizerRequest < Struct.new(
@@ -963,7 +1037,8 @@ module Aws::Comprehend
963
1037
  :client_request_token,
964
1038
  :language_code,
965
1039
  :volume_kms_key_id,
966
- :vpc_config)
1040
+ :vpc_config,
1041
+ :model_kms_key_id)
967
1042
  SENSITIVE = []
968
1043
  include Aws::Structure
969
1044
  end
@@ -2120,6 +2195,17 @@ module Aws::Comprehend
2120
2195
  # mode and this cannot be changed once the classifier is trained.
2121
2196
  # @return [String]
2122
2197
  #
2198
+ # @!attribute [rw] model_kms_key_id
2199
+ # ID for the AWS Key Management Service (KMS) key that Amazon
2200
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
2201
+ # can be either of the following formats:
2202
+ #
2203
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2204
+ #
2205
+ # * Amazon Resource Name (ARN) of a KMS Key:
2206
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
2207
+ # @return [String]
2208
+ #
2123
2209
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
2124
2210
  #
2125
2211
  class DocumentClassifierProperties < Struct.new(
@@ -2137,7 +2223,8 @@ module Aws::Comprehend
2137
2223
  :data_access_role_arn,
2138
2224
  :volume_kms_key_id,
2139
2225
  :vpc_config,
2140
- :mode)
2226
+ :mode,
2227
+ :model_kms_key_id)
2141
2228
  SENSITIVE = [:classifier_metadata]
2142
2229
  include Aws::Structure
2143
2230
  end
@@ -2407,6 +2494,13 @@ module Aws::Comprehend
2407
2494
  # The date and time that the endpoint was last modified.
2408
2495
  # @return [Time]
2409
2496
  #
2497
+ # @!attribute [rw] data_access_role_arn
2498
+ # The Amazon Resource Name (ARN) of the AWS identity and Access
2499
+ # Management (IAM) role that grants Amazon Comprehend read access to
2500
+ # trained custom models encrypted with a customer managed key
2501
+ # (ModelKmsKeyId).
2502
+ # @return [String]
2503
+ #
2410
2504
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
2411
2505
  #
2412
2506
  class EndpointProperties < Struct.new(
@@ -2417,7 +2511,8 @@ module Aws::Comprehend
2417
2511
  :desired_inference_units,
2418
2512
  :current_inference_units,
2419
2513
  :creation_time,
2420
- :last_modified_time)
2514
+ :last_modified_time,
2515
+ :data_access_role_arn)
2421
2516
  SENSITIVE = []
2422
2517
  include Aws::Structure
2423
2518
  end
@@ -2607,6 +2702,27 @@ module Aws::Comprehend
2607
2702
  include Aws::Structure
2608
2703
  end
2609
2704
 
2705
+ # Specifies one of the label or labels that categorize the personally
2706
+ # identifiable information (PII) entity being analyzed.
2707
+ #
2708
+ # @!attribute [rw] name
2709
+ # The name of the label.
2710
+ # @return [String]
2711
+ #
2712
+ # @!attribute [rw] score
2713
+ # The level of confidence that Amazon Comprehend has in the accuracy
2714
+ # of the detection.
2715
+ # @return [Float]
2716
+ #
2717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityLabel AWS API Documentation
2718
+ #
2719
+ class EntityLabel < Struct.new(
2720
+ :name,
2721
+ :score)
2722
+ SENSITIVE = []
2723
+ include Aws::Structure
2724
+ end
2725
+
2610
2726
  # Describes the annotations associated with a entity recognizer.
2611
2727
  #
2612
2728
  # @note When making an API call, you may pass EntityRecognizerAnnotations
@@ -2989,6 +3105,17 @@ module Aws::Comprehend
2989
3105
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
2990
3106
  # @return [Types::VpcConfig]
2991
3107
  #
3108
+ # @!attribute [rw] model_kms_key_id
3109
+ # ID for the AWS Key Management Service (KMS) key that Amazon
3110
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
3111
+ # can be either of the following formats:
3112
+ #
3113
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3114
+ #
3115
+ # * Amazon Resource Name (ARN) of a KMS Key:
3116
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
3117
+ # @return [String]
3118
+ #
2992
3119
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
2993
3120
  #
2994
3121
  class EntityRecognizerProperties < Struct.new(
@@ -3004,7 +3131,8 @@ module Aws::Comprehend
3004
3131
  :recognizer_metadata,
3005
3132
  :data_access_role_arn,
3006
3133
  :volume_kms_key_id,
3007
- :vpc_config)
3134
+ :vpc_config,
3135
+ :model_kms_key_id)
3008
3136
  SENSITIVE = [:recognizer_metadata]
3009
3137
  include Aws::Structure
3010
3138
  end
@@ -6167,11 +6295,9 @@ module Aws::Comprehend
6167
6295
  end
6168
6296
 
6169
6297
  # Amazon Comprehend can't process the language of the input text. For
6170
- # all custom entity recognition APIs (such as `CreateEntityRecognizer`),
6171
- # only English, Spanish, French, Italian, German, or Portuguese are
6172
- # accepted. For most other APIs, such as those for Custom
6173
- # Classification, Amazon Comprehend accepts text in all supported
6174
- # languages. For a list of supported languages, see supported-languages.
6298
+ # custom entity recognition APIs, only English, Spanish, French,
6299
+ # Italian, German, or Portuguese are accepted. For a list of supported
6300
+ # languages, see supported-languages.
6175
6301
  #
6176
6302
  # @!attribute [rw] message
6177
6303
  # @return [String]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-comprehend
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.44.0
4
+ version: 1.48.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-10 00:00:00.000000000 Z
11
+ date: 2021-07-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.112.0
22
+ version: 3.119.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.112.0
32
+ version: 3.119.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
66
66
  licenses:
67
67
  - Apache-2.0
68
68
  metadata:
69
- source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-comprehend
70
- changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-comprehend/CHANGELOG.md
69
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-comprehend
70
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-comprehend/CHANGELOG.md
71
71
  post_install_message:
72
72
  rdoc_options: []
73
73
  require_paths:
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
83
83
  - !ruby/object:Gem::Version
84
84
  version: '0'
85
85
  requirements: []
86
- rubyforge_project:
87
- rubygems_version: 2.7.6.2
86
+ rubygems_version: 3.1.6
88
87
  signing_key:
89
88
  specification_version: 4
90
89
  summary: AWS SDK for Ruby - Amazon Comprehend