aws-sdk-comprehend 1.17.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +26 -15
- data/lib/aws-sdk-comprehend/client_api.rb +7 -0
- data/lib/aws-sdk-comprehend/types.rb +79 -12
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4c2a113acf1524fdf822c877dd60f13de2f157f5
|
4
|
+
data.tar.gz: 014354d5c2eb746a70dac19c9c25a4015a56fc87
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b846b985a32d22347ba1ab9fc0970e8b540360e37b67718668e8accc22c0c7e4f1bb3fcbb835b20fd705841c940259da7f23285be526a88b78d611b7547e7eb2
|
7
|
+
data.tar.gz: 0003e1523bde687b8f9564dbd89036acf70d71e4bf0d48d07636684a0d97c5a5bb2c41b18068012c86079b41670faa8fc4ad94c14770ca17515da114b785cc1b
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -515,13 +515,16 @@ module Aws::Comprehend
|
|
515
515
|
# @option params [Array<Types::Tag>] :tags
|
516
516
|
# Tags to be associated with the document classifier being created. A
|
517
517
|
# tag is a key-value pair that adds as a metadata to a resource used by
|
518
|
-
# Amazon Comprehend. For example, a tag with the key
|
519
|
-
#
|
520
|
-
# by a particular department.
|
518
|
+
# Amazon Comprehend. For example, a tag with "Sales" as the key might
|
519
|
+
# be added to a resource to indicate its use by the sales department.
|
521
520
|
#
|
522
521
|
# @option params [required, Types::DocumentClassifierInputDataConfig] :input_data_config
|
523
522
|
# Specifies the format and location of the input data for the job.
|
524
523
|
#
|
524
|
+
# @option params [Types::DocumentClassifierOutputDataConfig] :output_data_config
|
525
|
+
# Enables the addition of output results configuration parameters for
|
526
|
+
# custom classifier jobs.
|
527
|
+
#
|
525
528
|
# @option params [String] :client_request_token
|
526
529
|
# A unique identifier for the request. If you don't set the client
|
527
530
|
# request token, Amazon Comprehend generates one.
|
@@ -562,6 +565,10 @@ module Aws::Comprehend
|
|
562
565
|
# input_data_config: { # required
|
563
566
|
# s3_uri: "S3Uri", # required
|
564
567
|
# },
|
568
|
+
# output_data_config: {
|
569
|
+
# s3_uri: "S3Uri",
|
570
|
+
# kms_key_id: "KmsKeyId",
|
571
|
+
# },
|
565
572
|
# client_request_token: "ClientRequestTokenString",
|
566
573
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
567
574
|
# volume_kms_key_id: "KmsKeyId",
|
@@ -598,9 +605,8 @@ module Aws::Comprehend
|
|
598
605
|
# @option params [Array<Types::Tag>] :tags
|
599
606
|
# Tags to be associated with the entity recognizer being created. A tag
|
600
607
|
# is a key-value pair that adds as a metadata to a resource used by
|
601
|
-
# Amazon Comprehend. For example, a tag with the key
|
602
|
-
#
|
603
|
-
# by a particular department.
|
608
|
+
# Amazon Comprehend. For example, a tag with "Sales" as the key might
|
609
|
+
# be added to a resource to indicate its use by the sales department.
|
604
610
|
#
|
605
611
|
# @option params [required, Types::EntityRecognizerInputDataConfig] :input_data_config
|
606
612
|
# Specifies the format and location of the input data. The S3 bucket
|
@@ -810,6 +816,8 @@ module Aws::Comprehend
|
|
810
816
|
# resp.document_classifier_properties.training_start_time #=> Time
|
811
817
|
# resp.document_classifier_properties.training_end_time #=> Time
|
812
818
|
# resp.document_classifier_properties.input_data_config.s3_uri #=> String
|
819
|
+
# resp.document_classifier_properties.output_data_config.s3_uri #=> String
|
820
|
+
# resp.document_classifier_properties.output_data_config.kms_key_id #=> String
|
813
821
|
# resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
|
814
822
|
# resp.document_classifier_properties.classifier_metadata.number_of_trained_documents #=> Integer
|
815
823
|
# resp.document_classifier_properties.classifier_metadata.number_of_test_documents #=> Integer
|
@@ -1388,6 +1396,8 @@ module Aws::Comprehend
|
|
1388
1396
|
# resp.document_classifier_properties_list[0].training_start_time #=> Time
|
1389
1397
|
# resp.document_classifier_properties_list[0].training_end_time #=> Time
|
1390
1398
|
# resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
|
1399
|
+
# resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
|
1400
|
+
# resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
|
1391
1401
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
|
1392
1402
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_trained_documents #=> Integer
|
1393
1403
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_test_documents #=> Integer
|
@@ -1719,8 +1729,7 @@ module Aws::Comprehend
|
|
1719
1729
|
req.send_request(options)
|
1720
1730
|
end
|
1721
1731
|
|
1722
|
-
# Lists all tags associated with a given Amazon Comprehend resource.
|
1723
|
-
# to the maximum number of tags allowed per resource will be displayed.
|
1732
|
+
# Lists all tags associated with a given Amazon Comprehend resource.
|
1724
1733
|
#
|
1725
1734
|
# @option params [required, String] :resource_arn
|
1726
1735
|
# The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
|
@@ -2536,9 +2545,8 @@ module Aws::Comprehend
|
|
2536
2545
|
|
2537
2546
|
# Associates a specific tag with an Amazon Comprehend resource. A tag is
|
2538
2547
|
# a key-value pair that adds as a metadata to a resource used by Amazon
|
2539
|
-
# Comprehend. For example, a tag with the key
|
2540
|
-
#
|
2541
|
-
# by a particular department.
|
2548
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
2549
|
+
# added to a resource to indicate its use by the sales department.
|
2542
2550
|
#
|
2543
2551
|
# @option params [required, String] :resource_arn
|
2544
2552
|
# The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
|
@@ -2546,6 +2554,8 @@ module Aws::Comprehend
|
|
2546
2554
|
#
|
2547
2555
|
# @option params [required, Array<Types::Tag>] :tags
|
2548
2556
|
# Tags being associated with a specific Amazon Comprehend resource.
|
2557
|
+
# There can be a maximum of 50 tags (both existing and pending)
|
2558
|
+
# associated with a specific resource.
|
2549
2559
|
#
|
2550
2560
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2551
2561
|
#
|
@@ -2578,9 +2588,10 @@ module Aws::Comprehend
|
|
2578
2588
|
#
|
2579
2589
|
# @option params [required, Array<String>] :tag_keys
|
2580
2590
|
# The initial part of a key-value pair that forms a tag being removed
|
2581
|
-
# from a given resource. For
|
2582
|
-
#
|
2583
|
-
#
|
2591
|
+
# from a given resource. For example, a tag with "Sales" as the key
|
2592
|
+
# might be added to a resource to indicate its use by the sales
|
2593
|
+
# department. Keys must be unique and cannot be duplicated for a
|
2594
|
+
# particular resource.
|
2584
2595
|
#
|
2585
2596
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2586
2597
|
#
|
@@ -2613,7 +2624,7 @@ module Aws::Comprehend
|
|
2613
2624
|
params: params,
|
2614
2625
|
config: config)
|
2615
2626
|
context[:gem_name] = 'aws-sdk-comprehend'
|
2616
|
-
context[:gem_version] = '1.
|
2627
|
+
context[:gem_version] = '1.18.0'
|
2617
2628
|
Seahorse::Client::Request.new(handlers, context)
|
2618
2629
|
end
|
2619
2630
|
|
@@ -76,6 +76,7 @@ module Aws::Comprehend
|
|
76
76
|
DocumentClassifierArn = Shapes::StringShape.new(name: 'DocumentClassifierArn')
|
77
77
|
DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
|
78
78
|
DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
|
79
|
+
DocumentClassifierOutputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierOutputDataConfig')
|
79
80
|
DocumentClassifierProperties = Shapes::StructureShape.new(name: 'DocumentClassifierProperties')
|
80
81
|
DocumentClassifierPropertiesList = Shapes::ListShape.new(name: 'DocumentClassifierPropertiesList')
|
81
82
|
DominantLanguage = Shapes::StructureShape.new(name: 'DominantLanguage')
|
@@ -295,6 +296,7 @@ module Aws::Comprehend
|
|
295
296
|
CreateDocumentClassifierRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
296
297
|
CreateDocumentClassifierRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
297
298
|
CreateDocumentClassifierRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, required: true, location_name: "InputDataConfig"))
|
299
|
+
CreateDocumentClassifierRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierOutputDataConfig, location_name: "OutputDataConfig"))
|
298
300
|
CreateDocumentClassifierRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
299
301
|
CreateDocumentClassifierRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
300
302
|
CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
@@ -437,6 +439,10 @@ module Aws::Comprehend
|
|
437
439
|
DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
438
440
|
DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
|
439
441
|
|
442
|
+
DocumentClassifierOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
|
443
|
+
DocumentClassifierOutputDataConfig.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
|
444
|
+
DocumentClassifierOutputDataConfig.struct_class = Types::DocumentClassifierOutputDataConfig
|
445
|
+
|
440
446
|
DocumentClassifierProperties.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
441
447
|
DocumentClassifierProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
442
448
|
DocumentClassifierProperties.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
@@ -446,6 +452,7 @@ module Aws::Comprehend
|
|
446
452
|
DocumentClassifierProperties.add_member(:training_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingStartTime"))
|
447
453
|
DocumentClassifierProperties.add_member(:training_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingEndTime"))
|
448
454
|
DocumentClassifierProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, location_name: "InputDataConfig"))
|
455
|
+
DocumentClassifierProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierOutputDataConfig, location_name: "OutputDataConfig"))
|
449
456
|
DocumentClassifierProperties.add_member(:classifier_metadata, Shapes::ShapeRef.new(shape: ClassifierMetadata, location_name: "ClassifierMetadata"))
|
450
457
|
DocumentClassifierProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
451
458
|
DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
@@ -468,6 +468,10 @@ module Aws::Comprehend
|
|
468
468
|
# input_data_config: { # required
|
469
469
|
# s3_uri: "S3Uri", # required
|
470
470
|
# },
|
471
|
+
# output_data_config: {
|
472
|
+
# s3_uri: "S3Uri",
|
473
|
+
# kms_key_id: "KmsKeyId",
|
474
|
+
# },
|
471
475
|
# client_request_token: "ClientRequestTokenString",
|
472
476
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
473
477
|
# volume_kms_key_id: "KmsKeyId",
|
@@ -486,15 +490,20 @@ module Aws::Comprehend
|
|
486
490
|
# @!attribute [rw] tags
|
487
491
|
# Tags to be associated with the document classifier being created. A
|
488
492
|
# tag is a key-value pair that adds as a metadata to a resource used
|
489
|
-
# by Amazon Comprehend. For example, a tag with the key
|
490
|
-
#
|
491
|
-
#
|
493
|
+
# by Amazon Comprehend. For example, a tag with "Sales" as the key
|
494
|
+
# might be added to a resource to indicate its use by the sales
|
495
|
+
# department.
|
492
496
|
# @return [Array<Types::Tag>]
|
493
497
|
#
|
494
498
|
# @!attribute [rw] input_data_config
|
495
499
|
# Specifies the format and location of the input data for the job.
|
496
500
|
# @return [Types::DocumentClassifierInputDataConfig]
|
497
501
|
#
|
502
|
+
# @!attribute [rw] output_data_config
|
503
|
+
# Enables the addition of output results configuration parameters for
|
504
|
+
# custom classifier jobs.
|
505
|
+
# @return [Types::DocumentClassifierOutputDataConfig]
|
506
|
+
#
|
498
507
|
# @!attribute [rw] client_request_token
|
499
508
|
# A unique identifier for the request. If you don't set the client
|
500
509
|
# request token, Amazon Comprehend generates one.
|
@@ -528,6 +537,7 @@ module Aws::Comprehend
|
|
528
537
|
:data_access_role_arn,
|
529
538
|
:tags,
|
530
539
|
:input_data_config,
|
540
|
+
:output_data_config,
|
531
541
|
:client_request_token,
|
532
542
|
:language_code,
|
533
543
|
:volume_kms_key_id)
|
@@ -595,9 +605,9 @@ module Aws::Comprehend
|
|
595
605
|
# @!attribute [rw] tags
|
596
606
|
# Tags to be associated with the entity recognizer being created. A
|
597
607
|
# tag is a key-value pair that adds as a metadata to a resource used
|
598
|
-
# by Amazon Comprehend. For example, a tag with the key
|
599
|
-
#
|
600
|
-
#
|
608
|
+
# by Amazon Comprehend. For example, a tag with "Sales" as the key
|
609
|
+
# might be added to a resource to indicate its use by the sales
|
610
|
+
# department.
|
601
611
|
# @return [Array<Types::Tag>]
|
602
612
|
#
|
603
613
|
# @!attribute [rw] input_data_config
|
@@ -1352,6 +1362,54 @@ module Aws::Comprehend
|
|
1352
1362
|
include Aws::Structure
|
1353
1363
|
end
|
1354
1364
|
|
1365
|
+
# Provides output results configuration parameters for custom classifier
|
1366
|
+
# jobs.
|
1367
|
+
#
|
1368
|
+
# @note When making an API call, you may pass DocumentClassifierOutputDataConfig
|
1369
|
+
# data as a hash:
|
1370
|
+
#
|
1371
|
+
# {
|
1372
|
+
# s3_uri: "S3Uri",
|
1373
|
+
# kms_key_id: "KmsKeyId",
|
1374
|
+
# }
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] s3_uri
|
1377
|
+
# When you use the `OutputDataConfig` object while creating a custom
|
1378
|
+
# classifier, you specify the Amazon S3 location where you want to
|
1379
|
+
# write the confusion matrix. The URI must be in the same region as
|
1380
|
+
# the API endpoint that you are calling. The location is used as the
|
1381
|
+
# prefix for the actual location of this output file.
|
1382
|
+
#
|
1383
|
+
# When the custom classifier job is finished, the service creates the
|
1384
|
+
# output file in a directory specific to the job. The `S3Uri` field
|
1385
|
+
# contains the location of the output file, called `output.tar.gz`. It
|
1386
|
+
# is a compressed archive that contains the confusion matrix.
|
1387
|
+
# @return [String]
|
1388
|
+
#
|
1389
|
+
# @!attribute [rw] kms_key_id
|
1390
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
1391
|
+
# Comprehend uses to encrypt the output results from an analysis job.
|
1392
|
+
# The KmsKeyId can be one of the following formats:
|
1393
|
+
#
|
1394
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1395
|
+
#
|
1396
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
1397
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1398
|
+
#
|
1399
|
+
# * KMS Key Alias: `"alias/ExampleAlias"`
|
1400
|
+
#
|
1401
|
+
# * ARN of a KMS Key Alias:
|
1402
|
+
# `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"`
|
1403
|
+
# @return [String]
|
1404
|
+
#
|
1405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierOutputDataConfig AWS API Documentation
|
1406
|
+
#
|
1407
|
+
class DocumentClassifierOutputDataConfig < Struct.new(
|
1408
|
+
:s3_uri,
|
1409
|
+
:kms_key_id)
|
1410
|
+
include Aws::Structure
|
1411
|
+
end
|
1412
|
+
|
1355
1413
|
# Provides information about a document classifier.
|
1356
1414
|
#
|
1357
1415
|
# @!attribute [rw] document_classifier_arn
|
@@ -1401,6 +1459,11 @@ module Aws::Comprehend
|
|
1401
1459
|
# document classifier for training.
|
1402
1460
|
# @return [Types::DocumentClassifierInputDataConfig]
|
1403
1461
|
#
|
1462
|
+
# @!attribute [rw] output_data_config
|
1463
|
+
# Provides output results configuration parameters for custom
|
1464
|
+
# classifier jobs.
|
1465
|
+
# @return [Types::DocumentClassifierOutputDataConfig]
|
1466
|
+
#
|
1404
1467
|
# @!attribute [rw] classifier_metadata
|
1405
1468
|
# Information about the document classifier, including the number of
|
1406
1469
|
# documents used for training the classifier, the number of documents
|
@@ -1437,6 +1500,7 @@ module Aws::Comprehend
|
|
1437
1500
|
:training_start_time,
|
1438
1501
|
:training_end_time,
|
1439
1502
|
:input_data_config,
|
1503
|
+
:output_data_config,
|
1440
1504
|
:classifier_metadata,
|
1441
1505
|
:data_access_role_arn,
|
1442
1506
|
:volume_kms_key_id)
|
@@ -2695,9 +2759,9 @@ module Aws::Comprehend
|
|
2695
2759
|
# @!attribute [rw] tags
|
2696
2760
|
# Tags associated with the Amazon Comprehend resource being queried. A
|
2697
2761
|
# tag is a key-value pair that adds as a metadata to a resource used
|
2698
|
-
# by Amazon Comprehend. For example, a tag with the key
|
2699
|
-
#
|
2700
|
-
#
|
2762
|
+
# by Amazon Comprehend. For example, a tag with "Sales" as the key
|
2763
|
+
# might be added to a resource to indicate its use by the sales
|
2764
|
+
# department.
|
2701
2765
|
# @return [Array<Types::Tag>]
|
2702
2766
|
#
|
2703
2767
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResourceResponse AWS API Documentation
|
@@ -3933,6 +3997,8 @@ module Aws::Comprehend
|
|
3933
3997
|
#
|
3934
3998
|
# @!attribute [rw] tags
|
3935
3999
|
# Tags being associated with a specific Amazon Comprehend resource.
|
4000
|
+
# There can be a maximum of 50 tags (both existing and pending)
|
4001
|
+
# associated with a specific resource.
|
3936
4002
|
# @return [Array<Types::Tag>]
|
3937
4003
|
#
|
3938
4004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResourceRequest AWS API Documentation
|
@@ -4085,9 +4151,10 @@ module Aws::Comprehend
|
|
4085
4151
|
#
|
4086
4152
|
# @!attribute [rw] tag_keys
|
4087
4153
|
# The initial part of a key-value pair that forms a tag being removed
|
4088
|
-
# from a given resource. For
|
4089
|
-
#
|
4090
|
-
#
|
4154
|
+
# from a given resource. For example, a tag with "Sales" as the key
|
4155
|
+
# might be added to a resource to indicate its use by the sales
|
4156
|
+
# department. Keys must be unique and cannot be duplicated for a
|
4157
|
+
# particular resource.
|
4091
4158
|
# @return [Array<String>]
|
4092
4159
|
#
|
4093
4160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResourceRequest AWS API Documentation
|
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.
|
4
|
+
version: 1.18.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: 2019-04-
|
11
|
+
date: 2019-04-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|