aws-sdk-comprehend 1.58.0 → 1.61.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: 2ec5735718fc3eaf23440ab18f4ade3d29391eaf7fde2972ef70ec75a1049e27
4
- data.tar.gz: b7ac60515580b749a00794be7fb5826c147f96f49cdd6a7812cf5d32fab3b7ec
3
+ metadata.gz: e9506b07c0fd74a91d95eb651618788bde3605dbe23762423c4e241644bcc3c8
4
+ data.tar.gz: '0094e85d2ff29db0389c55662ac90e94ccdd3b08076b56d09a7e94ee8a2efdba'
5
5
  SHA512:
6
- metadata.gz: 9125de7a4c2674e9d2aa9ff34b4852b87d11ad1cade537946c86e68391af0a3cbf41571b6311fcded62165ed749c54273813deeac31e62ce04ac30a73fd5bb23
7
- data.tar.gz: 189807a266da35c12358f209cc8732bbf2a6ba37de73fa01c1e0fdb2bcd6959797e1eef1a8aa7997fb1be17467cf63265122e6aafa74a4692656727ac4d949fa
6
+ metadata.gz: 61ed9fc9bbe5d1c330e70d64564ba6beb6eccbd6a8e25cd8be9e1e896536a44d930138c626a2054f90302d33fb2894115a777abd6e1ad12cb0bcbe787f980efe
7
+ data.tar.gz: faa8ad043980f18673d0f31f286713e60dba7b5af54e6a69befac5fd9894be4f1cd73c45b3507772c88a04189b5764523ce964938db5976f4aef0300aaae5738
data/CHANGELOG.md CHANGED
@@ -1,6 +1,21 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.61.0 (2022-05-20)
5
+ ------------------
6
+
7
+ * Feature - Comprehend releases 14 new entity types for DetectPiiEntities and ContainsPiiEntities APIs.
8
+
9
+ 1.60.0 (2022-03-09)
10
+ ------------------
11
+
12
+ * Feature - Amazon Comprehend now supports extracting the sentiment associated with entities such as brands, products and services from text documents.
13
+
14
+ 1.59.0 (2022-02-24)
15
+ ------------------
16
+
17
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
18
+
4
19
  1.58.0 (2022-02-03)
5
20
  ------------------
6
21
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.58.0
1
+ 1.61.0
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
30
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
31
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
32
33
  require 'aws-sdk-core/plugins/signature_v4.rb'
@@ -75,6 +76,7 @@ module Aws::Comprehend
75
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
76
77
  add_plugin(Aws::Plugins::TransferEncoding)
77
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
78
80
  add_plugin(Aws::Plugins::DefaultsMode)
79
81
  add_plugin(Aws::Plugins::RecursionDetection)
80
82
  add_plugin(Aws::Plugins::SignatureV4)
@@ -460,7 +462,7 @@ module Aws::Comprehend
460
462
  # @option params [required, Array<String>] :text_list
461
463
  # A list containing the text of the input documents. The list can
462
464
  # contain a maximum of 25 documents. Each document must contain fewer
463
- # that 5,000 bytes of UTF-8 encoded characters.
465
+ # than 5,000 bytes of UTF-8 encoded characters.
464
466
  #
465
467
  # @option params [required, String] :language_code
466
468
  # The language of the input documents. You can specify any of the
@@ -611,7 +613,12 @@ module Aws::Comprehend
611
613
  # The document text to be analyzed.
612
614
  #
613
615
  # @option params [required, String] :endpoint_arn
614
- # The Amazon Resource Number (ARN) of the endpoint.
616
+ # The Amazon Resource Number (ARN) of the endpoint. For information
617
+ # about endpoints, see [Managing endpoints][1].
618
+ #
619
+ #
620
+ #
621
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
615
622
  #
616
623
  # @return [Types::ClassifyDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
617
624
  #
@@ -653,7 +660,8 @@ module Aws::Comprehend
653
660
  # (PII) entity labels.
654
661
  #
655
662
  # @option params [required, String] :language_code
656
- # The language of the input documents.
663
+ # The language of the input documents. Currently, English is the only
664
+ # valid language.
657
665
  #
658
666
  # @return [Types::ContainsPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
659
667
  #
@@ -669,7 +677,7 @@ module Aws::Comprehend
669
677
  # @example Response structure
670
678
  #
671
679
  # resp.labels #=> Array
672
- # 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"
680
+ # 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", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
673
681
  # resp.labels[0].score #=> Float
674
682
  #
675
683
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities AWS API Documentation
@@ -847,7 +855,12 @@ module Aws::Comprehend
847
855
  end
848
856
 
849
857
  # Creates a model-specific endpoint for synchronous inference for a
850
- # previously trained custom model
858
+ # previously trained custom model For information about endpoints, see
859
+ # [Managing endpoints][1].
860
+ #
861
+ #
862
+ #
863
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
851
864
  #
852
865
  # @option params [required, String] :endpoint_name
853
866
  # This is the descriptive suffix that becomes part of the `EndpointArn`
@@ -1113,7 +1126,11 @@ module Aws::Comprehend
1113
1126
 
1114
1127
  # Deletes a model-specific endpoint for a previously-trained custom
1115
1128
  # model. All endpoints must be deleted in order for the model to be
1116
- # deleted.
1129
+ # deleted. For information about endpoints, see [Managing endpoints][1].
1130
+ #
1131
+ #
1132
+ #
1133
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
1117
1134
  #
1118
1135
  # @option params [required, String] :endpoint_arn
1119
1136
  # The Amazon Resource Number (ARN) of the endpoint being deleted.
@@ -1366,7 +1383,12 @@ module Aws::Comprehend
1366
1383
  end
1367
1384
 
1368
1385
  # Gets the properties associated with a specific endpoint. Use this
1369
- # operation to get the status of an endpoint.
1386
+ # operation to get the status of an endpoint. For information about
1387
+ # endpoints, see [Managing endpoints][1].
1388
+ #
1389
+ #
1390
+ #
1391
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
1370
1392
  #
1371
1393
  # @option params [required, String] :endpoint_arn
1372
1394
  # The Amazon Resource Number (ARN) of the endpoint being described.
@@ -1662,7 +1684,7 @@ module Aws::Comprehend
1662
1684
  # resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
1663
1685
  # resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
1664
1686
  # resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
1665
- # resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> 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"
1687
+ # resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> 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", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
1666
1688
  # resp.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
1667
1689
  # resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
1668
1690
  # resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
@@ -1764,6 +1786,57 @@ module Aws::Comprehend
1764
1786
  req.send_request(options)
1765
1787
  end
1766
1788
 
1789
+ # Gets the properties associated with a targeted sentiment detection
1790
+ # job. Use this operation to get the status of the job.
1791
+ #
1792
+ # @option params [required, String] :job_id
1793
+ # The identifier that Amazon Comprehend generated for the job. The
1794
+ # operation returns this identifier in its response.
1795
+ #
1796
+ # @return [Types::DescribeTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1797
+ #
1798
+ # * {Types::DescribeTargetedSentimentDetectionJobResponse#targeted_sentiment_detection_job_properties #targeted_sentiment_detection_job_properties} => Types::TargetedSentimentDetectionJobProperties
1799
+ #
1800
+ # @example Request syntax with placeholder values
1801
+ #
1802
+ # resp = client.describe_targeted_sentiment_detection_job({
1803
+ # job_id: "JobId", # required
1804
+ # })
1805
+ #
1806
+ # @example Response structure
1807
+ #
1808
+ # resp.targeted_sentiment_detection_job_properties.job_id #=> String
1809
+ # resp.targeted_sentiment_detection_job_properties.job_arn #=> String
1810
+ # resp.targeted_sentiment_detection_job_properties.job_name #=> String
1811
+ # resp.targeted_sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1812
+ # resp.targeted_sentiment_detection_job_properties.message #=> String
1813
+ # resp.targeted_sentiment_detection_job_properties.submit_time #=> Time
1814
+ # resp.targeted_sentiment_detection_job_properties.end_time #=> Time
1815
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.s3_uri #=> String
1816
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
1817
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
1818
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
1819
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
1820
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
1821
+ # resp.targeted_sentiment_detection_job_properties.output_data_config.s3_uri #=> String
1822
+ # resp.targeted_sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
1823
+ # resp.targeted_sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
1824
+ # resp.targeted_sentiment_detection_job_properties.data_access_role_arn #=> String
1825
+ # resp.targeted_sentiment_detection_job_properties.volume_kms_key_id #=> String
1826
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids #=> Array
1827
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids[0] #=> String
1828
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.subnets #=> Array
1829
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.subnets[0] #=> String
1830
+ #
1831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob AWS API Documentation
1832
+ #
1833
+ # @overload describe_targeted_sentiment_detection_job(params = {})
1834
+ # @param [Hash] params ({})
1835
+ def describe_targeted_sentiment_detection_job(params = {}, options = {})
1836
+ req = build_request(:describe_targeted_sentiment_detection_job, params)
1837
+ req.send_request(options)
1838
+ end
1839
+
1767
1840
  # Gets the properties associated with a topic detection job. Use this
1768
1841
  # operation to get the status of a detection job.
1769
1842
  #
@@ -1877,6 +1950,12 @@ module Aws::Comprehend
1877
1950
  # your custom model, and it ignores any language code that you provide
1878
1951
  # in your request.
1879
1952
  #
1953
+ # For information about endpoints, see [Managing endpoints][1].
1954
+ #
1955
+ #
1956
+ #
1957
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
1958
+ #
1880
1959
  # @return [Types::DetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1881
1960
  #
1882
1961
  # * {Types::DetectEntitiesResponse#entities #entities} => Array&lt;Types::Entity&gt;
@@ -1954,7 +2033,8 @@ module Aws::Comprehend
1954
2033
  # of UTF-8 encoded characters.
1955
2034
  #
1956
2035
  # @option params [required, String] :language_code
1957
- # The language of the input documents.
2036
+ # The language of the input documents. Currently, English is the only
2037
+ # valid language.
1958
2038
  #
1959
2039
  # @return [Types::DetectPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1960
2040
  #
@@ -1971,7 +2051,7 @@ module Aws::Comprehend
1971
2051
  #
1972
2052
  # resp.entities #=> Array
1973
2053
  # resp.entities[0].score #=> Float
1974
- # resp.entities[0].type #=> 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"
2054
+ # resp.entities[0].type #=> 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", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
1975
2055
  # resp.entities[0].begin_offset #=> Integer
1976
2056
  # resp.entities[0].end_offset #=> Integer
1977
2057
  #
@@ -2423,7 +2503,12 @@ module Aws::Comprehend
2423
2503
  req.send_request(options)
2424
2504
  end
2425
2505
 
2426
- # Gets a list of all existing endpoints that you've created.
2506
+ # Gets a list of all existing endpoints that you've created. For
2507
+ # information about endpoints, see [Managing endpoints][1].
2508
+ #
2509
+ #
2510
+ #
2511
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
2427
2512
  #
2428
2513
  # @option params [Types::EndpointFilter] :filter
2429
2514
  # Filters the endpoints that are returned. You can filter endpoints on
@@ -2880,7 +2965,7 @@ module Aws::Comprehend
2880
2965
  # resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
2881
2966
  # resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
2882
2967
  # resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
2883
- # resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> 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"
2968
+ # resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> 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", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
2884
2969
  # resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
2885
2970
  # resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
2886
2971
  # resp.pii_entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
@@ -3000,6 +3085,77 @@ module Aws::Comprehend
3000
3085
  req.send_request(options)
3001
3086
  end
3002
3087
 
3088
+ # Gets a list of targeted sentiment detection jobs that you have
3089
+ # submitted.
3090
+ #
3091
+ # @option params [Types::TargetedSentimentDetectionJobFilter] :filter
3092
+ # Filters the jobs that are returned. You can filter jobs on their name,
3093
+ # status, or the date and time that they were submitted. You can only
3094
+ # set one filter at a time.
3095
+ #
3096
+ # @option params [String] :next_token
3097
+ # Identifies the next page of results to return.
3098
+ #
3099
+ # @option params [Integer] :max_results
3100
+ # The maximum number of results to return in each page. The default is
3101
+ # 100.
3102
+ #
3103
+ # @return [Types::ListTargetedSentimentDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3104
+ #
3105
+ # * {Types::ListTargetedSentimentDetectionJobsResponse#targeted_sentiment_detection_job_properties_list #targeted_sentiment_detection_job_properties_list} => Array&lt;Types::TargetedSentimentDetectionJobProperties&gt;
3106
+ # * {Types::ListTargetedSentimentDetectionJobsResponse#next_token #next_token} => String
3107
+ #
3108
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3109
+ #
3110
+ # @example Request syntax with placeholder values
3111
+ #
3112
+ # resp = client.list_targeted_sentiment_detection_jobs({
3113
+ # filter: {
3114
+ # job_name: "JobName",
3115
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
3116
+ # submit_time_before: Time.now,
3117
+ # submit_time_after: Time.now,
3118
+ # },
3119
+ # next_token: "String",
3120
+ # max_results: 1,
3121
+ # })
3122
+ #
3123
+ # @example Response structure
3124
+ #
3125
+ # resp.targeted_sentiment_detection_job_properties_list #=> Array
3126
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_id #=> String
3127
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_arn #=> String
3128
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_name #=> String
3129
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
3130
+ # resp.targeted_sentiment_detection_job_properties_list[0].message #=> String
3131
+ # resp.targeted_sentiment_detection_job_properties_list[0].submit_time #=> Time
3132
+ # resp.targeted_sentiment_detection_job_properties_list[0].end_time #=> Time
3133
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
3134
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
3135
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
3136
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
3137
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
3138
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
3139
+ # resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
3140
+ # resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
3141
+ # resp.targeted_sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
3142
+ # resp.targeted_sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
3143
+ # resp.targeted_sentiment_detection_job_properties_list[0].volume_kms_key_id #=> String
3144
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
3145
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
3146
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets #=> Array
3147
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
3148
+ # resp.next_token #=> String
3149
+ #
3150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs AWS API Documentation
3151
+ #
3152
+ # @overload list_targeted_sentiment_detection_jobs(params = {})
3153
+ # @param [Hash] params ({})
3154
+ def list_targeted_sentiment_detection_jobs(params = {}, options = {})
3155
+ req = build_request(:list_targeted_sentiment_detection_jobs, params)
3156
+ req.send_request(options)
3157
+ end
3158
+
3003
3159
  # Gets a list of the topic detection jobs that you have submitted.
3004
3160
  #
3005
3161
  # @option params [Types::TopicsDetectionJobFilter] :filter
@@ -3697,7 +3853,8 @@ module Aws::Comprehend
3697
3853
  # The identifier of the job.
3698
3854
  #
3699
3855
  # @option params [required, String] :language_code
3700
- # The language of the input documents.
3856
+ # The language of the input documents. Currently, English is the only
3857
+ # valid language.
3701
3858
  #
3702
3859
  # @option params [String] :client_request_token
3703
3860
  # A unique identifier for the request. If you don't set the client
@@ -3736,7 +3893,7 @@ module Aws::Comprehend
3736
3893
  # },
3737
3894
  # mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
3738
3895
  # redaction_config: {
3739
- # pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts 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
3896
+ # pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts 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, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER
3740
3897
  # mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
3741
3898
  # mask_character: "MaskCharacter",
3742
3899
  # },
@@ -3768,7 +3925,7 @@ module Aws::Comprehend
3768
3925
  end
3769
3926
 
3770
3927
  # Starts an asynchronous sentiment detection job for a collection of
3771
- # documents. use the operation to track the status of a job.
3928
+ # documents. Use the operation to track the status of a job.
3772
3929
  #
3773
3930
  # @option params [required, Types::InputDataConfig] :input_data_config
3774
3931
  # Specifies the format and location of the input data for the job.
@@ -3881,6 +4038,120 @@ module Aws::Comprehend
3881
4038
  req.send_request(options)
3882
4039
  end
3883
4040
 
4041
+ # Starts an asynchronous targeted sentiment detection job for a
4042
+ # collection of documents. Use the operation to track the status of a
4043
+ # job.
4044
+ #
4045
+ # @option params [required, Types::InputDataConfig] :input_data_config
4046
+ # The input properties for an inference job.
4047
+ #
4048
+ # @option params [required, Types::OutputDataConfig] :output_data_config
4049
+ # Specifies where to send the output files.
4050
+ #
4051
+ # @option params [required, String] :data_access_role_arn
4052
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
4053
+ # Management (IAM) role that grants Amazon Comprehend read access to
4054
+ # your input data. For more information, see [Role-based
4055
+ # permissions][1].
4056
+ #
4057
+ #
4058
+ #
4059
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
4060
+ #
4061
+ # @option params [String] :job_name
4062
+ # The identifier of the job.
4063
+ #
4064
+ # @option params [required, String] :language_code
4065
+ # The language of the input documents. Currently, English is the only
4066
+ # valid language.
4067
+ #
4068
+ # @option params [String] :client_request_token
4069
+ # A unique identifier for the request. If you don't set the client
4070
+ # request token, Amazon Comprehend generates one.
4071
+ #
4072
+ # **A suitable default value is auto-generated.** You should normally
4073
+ # not need to pass this option.**
4074
+ #
4075
+ # @option params [String] :volume_kms_key_id
4076
+ # ID for the KMS key that Amazon Comprehend uses to encrypt data on the
4077
+ # storage volume attached to the ML compute instance(s) that process the
4078
+ # analysis job. The VolumeKmsKeyId can be either of the following
4079
+ # formats:
4080
+ #
4081
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4082
+ #
4083
+ # * Amazon Resource Name (ARN) of a KMS Key:
4084
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
4085
+ #
4086
+ # @option params [Types::VpcConfig] :vpc_config
4087
+ # Configuration parameters for an optional private Virtual Private Cloud
4088
+ # (VPC) containing the resources you are using for the job. For more
4089
+ # information, see [Amazon VPC][1].
4090
+ #
4091
+ #
4092
+ #
4093
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
4094
+ #
4095
+ # @option params [Array<Types::Tag>] :tags
4096
+ # Tags to be associated with the targeted sentiment detection job. A tag
4097
+ # is a key-value pair that adds metadata to a resource used by Amazon
4098
+ # Comprehend. For example, a tag with "Sales" as the key might be
4099
+ # added to a resource to indicate its use by the sales department.
4100
+ #
4101
+ # @return [Types::StartTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4102
+ #
4103
+ # * {Types::StartTargetedSentimentDetectionJobResponse#job_id #job_id} => String
4104
+ # * {Types::StartTargetedSentimentDetectionJobResponse#job_arn #job_arn} => String
4105
+ # * {Types::StartTargetedSentimentDetectionJobResponse#job_status #job_status} => String
4106
+ #
4107
+ # @example Request syntax with placeholder values
4108
+ #
4109
+ # resp = client.start_targeted_sentiment_detection_job({
4110
+ # input_data_config: { # required
4111
+ # s3_uri: "S3Uri", # required
4112
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
4113
+ # document_reader_config: {
4114
+ # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
4115
+ # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
4116
+ # feature_types: ["TABLES"], # accepts TABLES, FORMS
4117
+ # },
4118
+ # },
4119
+ # output_data_config: { # required
4120
+ # s3_uri: "S3Uri", # required
4121
+ # kms_key_id: "KmsKeyId",
4122
+ # },
4123
+ # data_access_role_arn: "IamRoleArn", # required
4124
+ # job_name: "JobName",
4125
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
4126
+ # client_request_token: "ClientRequestTokenString",
4127
+ # volume_kms_key_id: "KmsKeyId",
4128
+ # vpc_config: {
4129
+ # security_group_ids: ["SecurityGroupId"], # required
4130
+ # subnets: ["SubnetId"], # required
4131
+ # },
4132
+ # tags: [
4133
+ # {
4134
+ # key: "TagKey", # required
4135
+ # value: "TagValue",
4136
+ # },
4137
+ # ],
4138
+ # })
4139
+ #
4140
+ # @example Response structure
4141
+ #
4142
+ # resp.job_id #=> String
4143
+ # resp.job_arn #=> String
4144
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
4145
+ #
4146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob AWS API Documentation
4147
+ #
4148
+ # @overload start_targeted_sentiment_detection_job(params = {})
4149
+ # @param [Hash] params ({})
4150
+ def start_targeted_sentiment_detection_job(params = {}, options = {})
4151
+ req = build_request(:start_targeted_sentiment_detection_job, params)
4152
+ req.send_request(options)
4153
+ end
4154
+
3884
4155
  # Starts an asynchronous topic detection job. Use the
3885
4156
  # `DescribeTopicDetectionJob` operation to track the status of a job.
3886
4157
  #
@@ -4184,7 +4455,7 @@ module Aws::Comprehend
4184
4455
 
4185
4456
  # Stops a sentiment detection job in progress.
4186
4457
  #
4187
- # If the job state is `IN_PROGRESS` the job is marked for termination
4458
+ # If the job state is `IN_PROGRESS`, the job is marked for termination
4188
4459
  # and put into the `STOP_REQUESTED` state. If the job completes before
4189
4460
  # it can be stopped, it is put into the `COMPLETED` state; otherwise the
4190
4461
  # job is be stopped and put into the `STOPPED` state.
@@ -4224,6 +4495,48 @@ module Aws::Comprehend
4224
4495
  req.send_request(options)
4225
4496
  end
4226
4497
 
4498
+ # Stops a targeted sentiment detection job in progress.
4499
+ #
4500
+ # If the job state is `IN_PROGRESS`, the job is marked for termination
4501
+ # and put into the `STOP_REQUESTED` state. If the job completes before
4502
+ # it can be stopped, it is put into the `COMPLETED` state; otherwise the
4503
+ # job is be stopped and put into the `STOPPED` state.
4504
+ #
4505
+ # If the job is in the `COMPLETED` or `FAILED` state when you call the
4506
+ # `StopDominantLanguageDetectionJob` operation, the operation returns a
4507
+ # 400 Internal Request Exception.
4508
+ #
4509
+ # When a job is stopped, any documents already processed are written to
4510
+ # the output location.
4511
+ #
4512
+ # @option params [required, String] :job_id
4513
+ # The identifier of the targeted sentiment detection job to stop.
4514
+ #
4515
+ # @return [Types::StopTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4516
+ #
4517
+ # * {Types::StopTargetedSentimentDetectionJobResponse#job_id #job_id} => String
4518
+ # * {Types::StopTargetedSentimentDetectionJobResponse#job_status #job_status} => String
4519
+ #
4520
+ # @example Request syntax with placeholder values
4521
+ #
4522
+ # resp = client.stop_targeted_sentiment_detection_job({
4523
+ # job_id: "JobId", # required
4524
+ # })
4525
+ #
4526
+ # @example Response structure
4527
+ #
4528
+ # resp.job_id #=> String
4529
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
4530
+ #
4531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob AWS API Documentation
4532
+ #
4533
+ # @overload stop_targeted_sentiment_detection_job(params = {})
4534
+ # @param [Hash] params ({})
4535
+ def stop_targeted_sentiment_detection_job(params = {}, options = {})
4536
+ req = build_request(:stop_targeted_sentiment_detection_job, params)
4537
+ req.send_request(options)
4538
+ end
4539
+
4227
4540
  # Stops a document classifier training job while in progress.
4228
4541
  #
4229
4542
  # If the training job state is `TRAINING`, the job is marked for
@@ -4352,7 +4665,12 @@ module Aws::Comprehend
4352
4665
  req.send_request(options)
4353
4666
  end
4354
4667
 
4355
- # Updates information about the specified endpoint.
4668
+ # Updates information about the specified endpoint. For information
4669
+ # about endpoints, see [Managing endpoints][1].
4670
+ #
4671
+ #
4672
+ #
4673
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
4356
4674
  #
4357
4675
  # @option params [required, String] :endpoint_arn
4358
4676
  # The Amazon Resource Number (ARN) of the endpoint being updated.
@@ -4402,7 +4720,7 @@ module Aws::Comprehend
4402
4720
  params: params,
4403
4721
  config: config)
4404
4722
  context[:gem_name] = 'aws-sdk-comprehend'
4405
- context[:gem_version] = '1.58.0'
4723
+ context[:gem_version] = '1.61.0'
4406
4724
  Seahorse::Client::Request.new(handlers, context)
4407
4725
  end
4408
4726