aws-sdk-comprehend 1.59.0 → 1.60.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7fc64211fc4dba52d0c1fb3c38ba71c7906731263a6bc1678dcd78f1d687fa40
4
- data.tar.gz: bf5b64f24fbf4a3f460147a1aca794b500bf0178462d6790e7c19c5f7cf873e1
3
+ metadata.gz: a75cc38649333387d5418a7c80d9113999b17f57661027b78e042e55f92fecdd
4
+ data.tar.gz: 9a65e161a5123e8aace032e4e26a3521e8ff56b7edd20acd3b1a6e590c6f4624
5
5
  SHA512:
6
- metadata.gz: 992c0546d6ea4fb8b156a9b050a2f97821fd3ef84106c9da68ae1216950a61e8cde9eed80fbf8b612452f52d523e4638535d4130ebc79280d8b6207dee296396
7
- data.tar.gz: 754c3e0933a04f786dd5225daab40b6b59558264773d6344bc9167d5873472c3ee48af62016c2d170f6139ab7e8c4ec144caf8185527ea9a9c16baa3a7652d6c
6
+ metadata.gz: bb3cae0fcd400466508d2508812b3e0105a358f4ace7a580bf96e5aaf88160a561e236534e3a4f9233c11348292826c09b73e41f525c46561db5801e6b2a5fa0
7
+ data.tar.gz: 066a5b860baa16c7d901cc0a680c40e502db95d339322db37d25083a8205aa319af384e39ea4db69d68a52014d2ae917a5536efa1bce8048b06be3ddc32d103b
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.60.0 (2022-03-09)
5
+ ------------------
6
+
7
+ * Feature - Amazon Comprehend now supports extracting the sentiment associated with entities such as brands, products and services from text documents.
8
+
4
9
  1.59.0 (2022-02-24)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.59.0
1
+ 1.60.0
@@ -1766,6 +1766,57 @@ module Aws::Comprehend
1766
1766
  req.send_request(options)
1767
1767
  end
1768
1768
 
1769
+ # Gets the properties associated with a targeted sentiment detection
1770
+ # job. Use this operation to get the status of the job.
1771
+ #
1772
+ # @option params [required, String] :job_id
1773
+ # The identifier that Amazon Comprehend generated for the job. The
1774
+ # operation returns this identifier in its response.
1775
+ #
1776
+ # @return [Types::DescribeTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1777
+ #
1778
+ # * {Types::DescribeTargetedSentimentDetectionJobResponse#targeted_sentiment_detection_job_properties #targeted_sentiment_detection_job_properties} => Types::TargetedSentimentDetectionJobProperties
1779
+ #
1780
+ # @example Request syntax with placeholder values
1781
+ #
1782
+ # resp = client.describe_targeted_sentiment_detection_job({
1783
+ # job_id: "JobId", # required
1784
+ # })
1785
+ #
1786
+ # @example Response structure
1787
+ #
1788
+ # resp.targeted_sentiment_detection_job_properties.job_id #=> String
1789
+ # resp.targeted_sentiment_detection_job_properties.job_arn #=> String
1790
+ # resp.targeted_sentiment_detection_job_properties.job_name #=> String
1791
+ # resp.targeted_sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1792
+ # resp.targeted_sentiment_detection_job_properties.message #=> String
1793
+ # resp.targeted_sentiment_detection_job_properties.submit_time #=> Time
1794
+ # resp.targeted_sentiment_detection_job_properties.end_time #=> Time
1795
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.s3_uri #=> String
1796
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
1797
+ # 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"
1798
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
1799
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
1800
+ # resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
1801
+ # resp.targeted_sentiment_detection_job_properties.output_data_config.s3_uri #=> String
1802
+ # resp.targeted_sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
1803
+ # resp.targeted_sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
1804
+ # resp.targeted_sentiment_detection_job_properties.data_access_role_arn #=> String
1805
+ # resp.targeted_sentiment_detection_job_properties.volume_kms_key_id #=> String
1806
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids #=> Array
1807
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids[0] #=> String
1808
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.subnets #=> Array
1809
+ # resp.targeted_sentiment_detection_job_properties.vpc_config.subnets[0] #=> String
1810
+ #
1811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob AWS API Documentation
1812
+ #
1813
+ # @overload describe_targeted_sentiment_detection_job(params = {})
1814
+ # @param [Hash] params ({})
1815
+ def describe_targeted_sentiment_detection_job(params = {}, options = {})
1816
+ req = build_request(:describe_targeted_sentiment_detection_job, params)
1817
+ req.send_request(options)
1818
+ end
1819
+
1769
1820
  # Gets the properties associated with a topic detection job. Use this
1770
1821
  # operation to get the status of a detection job.
1771
1822
  #
@@ -3002,6 +3053,77 @@ module Aws::Comprehend
3002
3053
  req.send_request(options)
3003
3054
  end
3004
3055
 
3056
+ # Gets a list of targeted sentiment detection jobs that you have
3057
+ # submitted.
3058
+ #
3059
+ # @option params [Types::TargetedSentimentDetectionJobFilter] :filter
3060
+ # Filters the jobs that are returned. You can filter jobs on their name,
3061
+ # status, or the date and time that they were submitted. You can only
3062
+ # set one filter at a time.
3063
+ #
3064
+ # @option params [String] :next_token
3065
+ # Identifies the next page of results to return.
3066
+ #
3067
+ # @option params [Integer] :max_results
3068
+ # The maximum number of results to return in each page. The default is
3069
+ # 100.
3070
+ #
3071
+ # @return [Types::ListTargetedSentimentDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3072
+ #
3073
+ # * {Types::ListTargetedSentimentDetectionJobsResponse#targeted_sentiment_detection_job_properties_list #targeted_sentiment_detection_job_properties_list} => Array<Types::TargetedSentimentDetectionJobProperties>
3074
+ # * {Types::ListTargetedSentimentDetectionJobsResponse#next_token #next_token} => String
3075
+ #
3076
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3077
+ #
3078
+ # @example Request syntax with placeholder values
3079
+ #
3080
+ # resp = client.list_targeted_sentiment_detection_jobs({
3081
+ # filter: {
3082
+ # job_name: "JobName",
3083
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
3084
+ # submit_time_before: Time.now,
3085
+ # submit_time_after: Time.now,
3086
+ # },
3087
+ # next_token: "String",
3088
+ # max_results: 1,
3089
+ # })
3090
+ #
3091
+ # @example Response structure
3092
+ #
3093
+ # resp.targeted_sentiment_detection_job_properties_list #=> Array
3094
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_id #=> String
3095
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_arn #=> String
3096
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_name #=> String
3097
+ # resp.targeted_sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
3098
+ # resp.targeted_sentiment_detection_job_properties_list[0].message #=> String
3099
+ # resp.targeted_sentiment_detection_job_properties_list[0].submit_time #=> Time
3100
+ # resp.targeted_sentiment_detection_job_properties_list[0].end_time #=> Time
3101
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
3102
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
3103
+ # 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"
3104
+ # 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"
3105
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
3106
+ # resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
3107
+ # resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
3108
+ # resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
3109
+ # 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"
3110
+ # resp.targeted_sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
3111
+ # resp.targeted_sentiment_detection_job_properties_list[0].volume_kms_key_id #=> String
3112
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
3113
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
3114
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets #=> Array
3115
+ # resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
3116
+ # resp.next_token #=> String
3117
+ #
3118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs AWS API Documentation
3119
+ #
3120
+ # @overload list_targeted_sentiment_detection_jobs(params = {})
3121
+ # @param [Hash] params ({})
3122
+ def list_targeted_sentiment_detection_jobs(params = {}, options = {})
3123
+ req = build_request(:list_targeted_sentiment_detection_jobs, params)
3124
+ req.send_request(options)
3125
+ end
3126
+
3005
3127
  # Gets a list of the topic detection jobs that you have submitted.
3006
3128
  #
3007
3129
  # @option params [Types::TopicsDetectionJobFilter] :filter
@@ -3770,7 +3892,7 @@ module Aws::Comprehend
3770
3892
  end
3771
3893
 
3772
3894
  # Starts an asynchronous sentiment detection job for a collection of
3773
- # documents. use the operation to track the status of a job.
3895
+ # documents. Use the operation to track the status of a job.
3774
3896
  #
3775
3897
  # @option params [required, Types::InputDataConfig] :input_data_config
3776
3898
  # Specifies the format and location of the input data for the job.
@@ -3883,6 +4005,121 @@ module Aws::Comprehend
3883
4005
  req.send_request(options)
3884
4006
  end
3885
4007
 
4008
+ # Starts an asynchronous targeted sentiment detection job for a
4009
+ # collection of documents. Use the operation to track the status of a
4010
+ # job.
4011
+ #
4012
+ # @option params [required, Types::InputDataConfig] :input_data_config
4013
+ # The input properties for an inference job.
4014
+ #
4015
+ # @option params [required, Types::OutputDataConfig] :output_data_config
4016
+ # Specifies where to send the output files.
4017
+ #
4018
+ # @option params [required, String] :data_access_role_arn
4019
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
4020
+ # Management (IAM) role that grants Amazon Comprehend read access to
4021
+ # your input data. For more information, see [Role-based
4022
+ # permissions][1].
4023
+ #
4024
+ #
4025
+ #
4026
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
4027
+ #
4028
+ # @option params [String] :job_name
4029
+ # The identifier of the job.
4030
+ #
4031
+ # @option params [required, String] :language_code
4032
+ # The language of the input documents. You can specify any of the
4033
+ # primary languages supported by Amazon Comprehend. All documents must
4034
+ # be in the same language.
4035
+ #
4036
+ # @option params [String] :client_request_token
4037
+ # A unique identifier for the request. If you don't set the client
4038
+ # request token, Amazon Comprehend generates one.
4039
+ #
4040
+ # **A suitable default value is auto-generated.** You should normally
4041
+ # not need to pass this option.**
4042
+ #
4043
+ # @option params [String] :volume_kms_key_id
4044
+ # ID for the KMS key that Amazon Comprehend uses to encrypt data on the
4045
+ # storage volume attached to the ML compute instance(s) that process the
4046
+ # analysis job. The VolumeKmsKeyId can be either of the following
4047
+ # formats:
4048
+ #
4049
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4050
+ #
4051
+ # * Amazon Resource Name (ARN) of a KMS Key:
4052
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
4053
+ #
4054
+ # @option params [Types::VpcConfig] :vpc_config
4055
+ # Configuration parameters for an optional private Virtual Private Cloud
4056
+ # (VPC) containing the resources you are using for the job. For more
4057
+ # information, see [Amazon VPC][1].
4058
+ #
4059
+ #
4060
+ #
4061
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
4062
+ #
4063
+ # @option params [Array<Types::Tag>] :tags
4064
+ # Tags to be associated with the targeted sentiment detection job. A tag
4065
+ # is a key-value pair that adds metadata to a resource used by Amazon
4066
+ # Comprehend. For example, a tag with "Sales" as the key might be
4067
+ # added to a resource to indicate its use by the sales department.
4068
+ #
4069
+ # @return [Types::StartTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4070
+ #
4071
+ # * {Types::StartTargetedSentimentDetectionJobResponse#job_id #job_id} => String
4072
+ # * {Types::StartTargetedSentimentDetectionJobResponse#job_arn #job_arn} => String
4073
+ # * {Types::StartTargetedSentimentDetectionJobResponse#job_status #job_status} => String
4074
+ #
4075
+ # @example Request syntax with placeholder values
4076
+ #
4077
+ # resp = client.start_targeted_sentiment_detection_job({
4078
+ # input_data_config: { # required
4079
+ # s3_uri: "S3Uri", # required
4080
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
4081
+ # document_reader_config: {
4082
+ # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
4083
+ # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
4084
+ # feature_types: ["TABLES"], # accepts TABLES, FORMS
4085
+ # },
4086
+ # },
4087
+ # output_data_config: { # required
4088
+ # s3_uri: "S3Uri", # required
4089
+ # kms_key_id: "KmsKeyId",
4090
+ # },
4091
+ # data_access_role_arn: "IamRoleArn", # required
4092
+ # job_name: "JobName",
4093
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
4094
+ # client_request_token: "ClientRequestTokenString",
4095
+ # volume_kms_key_id: "KmsKeyId",
4096
+ # vpc_config: {
4097
+ # security_group_ids: ["SecurityGroupId"], # required
4098
+ # subnets: ["SubnetId"], # required
4099
+ # },
4100
+ # tags: [
4101
+ # {
4102
+ # key: "TagKey", # required
4103
+ # value: "TagValue",
4104
+ # },
4105
+ # ],
4106
+ # })
4107
+ #
4108
+ # @example Response structure
4109
+ #
4110
+ # resp.job_id #=> String
4111
+ # resp.job_arn #=> String
4112
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
4113
+ #
4114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob AWS API Documentation
4115
+ #
4116
+ # @overload start_targeted_sentiment_detection_job(params = {})
4117
+ # @param [Hash] params ({})
4118
+ def start_targeted_sentiment_detection_job(params = {}, options = {})
4119
+ req = build_request(:start_targeted_sentiment_detection_job, params)
4120
+ req.send_request(options)
4121
+ end
4122
+
3886
4123
  # Starts an asynchronous topic detection job. Use the
3887
4124
  # `DescribeTopicDetectionJob` operation to track the status of a job.
3888
4125
  #
@@ -4226,6 +4463,48 @@ module Aws::Comprehend
4226
4463
  req.send_request(options)
4227
4464
  end
4228
4465
 
4466
+ # Stops a targeted sentiment detection job in progress.
4467
+ #
4468
+ # If the job state is `IN_PROGRESS` the job is marked for termination
4469
+ # and put into the `STOP_REQUESTED` state. If the job completes before
4470
+ # it can be stopped, it is put into the `COMPLETED` state; otherwise the
4471
+ # job is be stopped and put into the `STOPPED` state.
4472
+ #
4473
+ # If the job is in the `COMPLETED` or `FAILED` state when you call the
4474
+ # `StopDominantLanguageDetectionJob` operation, the operation returns a
4475
+ # 400 Internal Request Exception.
4476
+ #
4477
+ # When a job is stopped, any documents already processed are written to
4478
+ # the output location.
4479
+ #
4480
+ # @option params [required, String] :job_id
4481
+ # The identifier of the targeted sentiment detection job to stop.
4482
+ #
4483
+ # @return [Types::StopTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4484
+ #
4485
+ # * {Types::StopTargetedSentimentDetectionJobResponse#job_id #job_id} => String
4486
+ # * {Types::StopTargetedSentimentDetectionJobResponse#job_status #job_status} => String
4487
+ #
4488
+ # @example Request syntax with placeholder values
4489
+ #
4490
+ # resp = client.stop_targeted_sentiment_detection_job({
4491
+ # job_id: "JobId", # required
4492
+ # })
4493
+ #
4494
+ # @example Response structure
4495
+ #
4496
+ # resp.job_id #=> String
4497
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
4498
+ #
4499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob AWS API Documentation
4500
+ #
4501
+ # @overload stop_targeted_sentiment_detection_job(params = {})
4502
+ # @param [Hash] params ({})
4503
+ def stop_targeted_sentiment_detection_job(params = {}, options = {})
4504
+ req = build_request(:stop_targeted_sentiment_detection_job, params)
4505
+ req.send_request(options)
4506
+ end
4507
+
4229
4508
  # Stops a document classifier training job while in progress.
4230
4509
  #
4231
4510
  # If the training job state is `TRAINING`, the job is marked for
@@ -4404,7 +4683,7 @@ module Aws::Comprehend
4404
4683
  params: params,
4405
4684
  config: config)
4406
4685
  context[:gem_name] = 'aws-sdk-comprehend'
4407
- context[:gem_version] = '1.59.0'
4686
+ context[:gem_version] = '1.60.0'
4408
4687
  Seahorse::Client::Request.new(handlers, context)
4409
4688
  end
4410
4689
 
@@ -87,6 +87,8 @@ module Aws::Comprehend
87
87
  DescribeResourcePolicyResponse = Shapes::StructureShape.new(name: 'DescribeResourcePolicyResponse')
88
88
  DescribeSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobRequest')
89
89
  DescribeSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobResponse')
90
+ DescribeTargetedSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeTargetedSentimentDetectionJobRequest')
91
+ DescribeTargetedSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeTargetedSentimentDetectionJobResponse')
90
92
  DescribeTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeTopicsDetectionJobRequest')
91
93
  DescribeTopicsDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeTopicsDetectionJobResponse')
92
94
  DetectDominantLanguageRequest = Shapes::StructureShape.new(name: 'DetectDominantLanguageRequest')
@@ -226,6 +228,8 @@ module Aws::Comprehend
226
228
  ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
227
229
  ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
228
230
  ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
231
+ ListTargetedSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTargetedSentimentDetectionJobsRequest')
232
+ ListTargetedSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTargetedSentimentDetectionJobsResponse')
229
233
  ListTopicsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsRequest')
230
234
  ListTopicsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsResponse')
231
235
  MaskCharacter = Shapes::StringShape.new(name: 'MaskCharacter')
@@ -275,6 +279,8 @@ module Aws::Comprehend
275
279
  StartPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobResponse')
276
280
  StartSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobRequest')
277
281
  StartSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobResponse')
282
+ StartTargetedSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StartTargetedSentimentDetectionJobRequest')
283
+ StartTargetedSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StartTargetedSentimentDetectionJobResponse')
278
284
  StartTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'StartTopicsDetectionJobRequest')
279
285
  StartTopicsDetectionJobResponse = Shapes::StructureShape.new(name: 'StartTopicsDetectionJobResponse')
280
286
  StopDominantLanguageDetectionJobRequest = Shapes::StructureShape.new(name: 'StopDominantLanguageDetectionJobRequest')
@@ -289,6 +295,8 @@ module Aws::Comprehend
289
295
  StopPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobResponse')
290
296
  StopSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobRequest')
291
297
  StopSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobResponse')
298
+ StopTargetedSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StopTargetedSentimentDetectionJobRequest')
299
+ StopTargetedSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopTargetedSentimentDetectionJobResponse')
292
300
  StopTrainingDocumentClassifierRequest = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierRequest')
293
301
  StopTrainingDocumentClassifierResponse = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierResponse')
294
302
  StopTrainingEntityRecognizerRequest = Shapes::StructureShape.new(name: 'StopTrainingEntityRecognizerRequest')
@@ -306,6 +314,9 @@ module Aws::Comprehend
306
314
  TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
307
315
  TagValue = Shapes::StringShape.new(name: 'TagValue')
308
316
  TargetEventTypes = Shapes::ListShape.new(name: 'TargetEventTypes')
317
+ TargetedSentimentDetectionJobFilter = Shapes::StructureShape.new(name: 'TargetedSentimentDetectionJobFilter')
318
+ TargetedSentimentDetectionJobProperties = Shapes::StructureShape.new(name: 'TargetedSentimentDetectionJobProperties')
319
+ TargetedSentimentDetectionJobPropertiesList = Shapes::ListShape.new(name: 'TargetedSentimentDetectionJobPropertiesList')
309
320
  TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
310
321
  Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
311
322
  TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
@@ -573,6 +584,12 @@ module Aws::Comprehend
573
584
  DescribeSentimentDetectionJobResponse.add_member(:sentiment_detection_job_properties, Shapes::ShapeRef.new(shape: SentimentDetectionJobProperties, location_name: "SentimentDetectionJobProperties"))
574
585
  DescribeSentimentDetectionJobResponse.struct_class = Types::DescribeSentimentDetectionJobResponse
575
586
 
587
+ DescribeTargetedSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
588
+ DescribeTargetedSentimentDetectionJobRequest.struct_class = Types::DescribeTargetedSentimentDetectionJobRequest
589
+
590
+ DescribeTargetedSentimentDetectionJobResponse.add_member(:targeted_sentiment_detection_job_properties, Shapes::ShapeRef.new(shape: TargetedSentimentDetectionJobProperties, location_name: "TargetedSentimentDetectionJobProperties"))
591
+ DescribeTargetedSentimentDetectionJobResponse.struct_class = Types::DescribeTargetedSentimentDetectionJobResponse
592
+
576
593
  DescribeTopicsDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
577
594
  DescribeTopicsDetectionJobRequest.struct_class = Types::DescribeTopicsDetectionJobRequest
578
595
 
@@ -1100,6 +1117,15 @@ module Aws::Comprehend
1100
1117
  ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
1101
1118
  ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
1102
1119
 
1120
+ ListTargetedSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: TargetedSentimentDetectionJobFilter, location_name: "Filter"))
1121
+ ListTargetedSentimentDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1122
+ ListTargetedSentimentDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
1123
+ ListTargetedSentimentDetectionJobsRequest.struct_class = Types::ListTargetedSentimentDetectionJobsRequest
1124
+
1125
+ ListTargetedSentimentDetectionJobsResponse.add_member(:targeted_sentiment_detection_job_properties_list, Shapes::ShapeRef.new(shape: TargetedSentimentDetectionJobPropertiesList, location_name: "TargetedSentimentDetectionJobPropertiesList"))
1126
+ ListTargetedSentimentDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1127
+ ListTargetedSentimentDetectionJobsResponse.struct_class = Types::ListTargetedSentimentDetectionJobsResponse
1128
+
1103
1129
  ListTopicsDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: TopicsDetectionJobFilter, location_name: "Filter"))
1104
1130
  ListTopicsDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1105
1131
  ListTopicsDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
@@ -1317,6 +1343,22 @@ module Aws::Comprehend
1317
1343
  StartSentimentDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
1318
1344
  StartSentimentDetectionJobResponse.struct_class = Types::StartSentimentDetectionJobResponse
1319
1345
 
1346
+ StartTargetedSentimentDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
1347
+ StartTargetedSentimentDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
1348
+ StartTargetedSentimentDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
1349
+ StartTargetedSentimentDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
1350
+ StartTargetedSentimentDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
1351
+ StartTargetedSentimentDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
1352
+ StartTargetedSentimentDetectionJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
1353
+ StartTargetedSentimentDetectionJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
1354
+ StartTargetedSentimentDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
1355
+ StartTargetedSentimentDetectionJobRequest.struct_class = Types::StartTargetedSentimentDetectionJobRequest
1356
+
1357
+ StartTargetedSentimentDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
1358
+ StartTargetedSentimentDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
1359
+ StartTargetedSentimentDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
1360
+ StartTargetedSentimentDetectionJobResponse.struct_class = Types::StartTargetedSentimentDetectionJobResponse
1361
+
1320
1362
  StartTopicsDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
1321
1363
  StartTopicsDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
1322
1364
  StartTopicsDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
@@ -1375,6 +1417,13 @@ module Aws::Comprehend
1375
1417
  StopSentimentDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
1376
1418
  StopSentimentDetectionJobResponse.struct_class = Types::StopSentimentDetectionJobResponse
1377
1419
 
1420
+ StopTargetedSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
1421
+ StopTargetedSentimentDetectionJobRequest.struct_class = Types::StopTargetedSentimentDetectionJobRequest
1422
+
1423
+ StopTargetedSentimentDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
1424
+ StopTargetedSentimentDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
1425
+ StopTargetedSentimentDetectionJobResponse.struct_class = Types::StopTargetedSentimentDetectionJobResponse
1426
+
1378
1427
  StopTrainingDocumentClassifierRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
1379
1428
  StopTrainingDocumentClassifierRequest.struct_class = Types::StopTrainingDocumentClassifierRequest
1380
1429
 
@@ -1410,6 +1459,29 @@ module Aws::Comprehend
1410
1459
 
1411
1460
  TargetEventTypes.member = Shapes::ShapeRef.new(shape: EventTypeString)
1412
1461
 
1462
+ TargetedSentimentDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
1463
+ TargetedSentimentDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
1464
+ TargetedSentimentDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
1465
+ TargetedSentimentDetectionJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
1466
+ TargetedSentimentDetectionJobFilter.struct_class = Types::TargetedSentimentDetectionJobFilter
1467
+
1468
+ TargetedSentimentDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
1469
+ TargetedSentimentDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
1470
+ TargetedSentimentDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
1471
+ TargetedSentimentDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
1472
+ TargetedSentimentDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
1473
+ TargetedSentimentDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
1474
+ TargetedSentimentDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
1475
+ TargetedSentimentDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
1476
+ TargetedSentimentDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
1477
+ TargetedSentimentDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
1478
+ TargetedSentimentDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
1479
+ TargetedSentimentDetectionJobProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
1480
+ TargetedSentimentDetectionJobProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
1481
+ TargetedSentimentDetectionJobProperties.struct_class = Types::TargetedSentimentDetectionJobProperties
1482
+
1483
+ TargetedSentimentDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: TargetedSentimentDetectionJobProperties)
1484
+
1413
1485
  TextSizeLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
1414
1486
  TextSizeLimitExceededException.struct_class = Types::TextSizeLimitExceededException
1415
1487
 
@@ -1804,6 +1876,18 @@ module Aws::Comprehend
1804
1876
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1805
1877
  end)
1806
1878
 
1879
+ api.add_operation(:describe_targeted_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
1880
+ o.name = "DescribeTargetedSentimentDetectionJob"
1881
+ o.http_method = "POST"
1882
+ o.http_request_uri = "/"
1883
+ o.input = Shapes::ShapeRef.new(shape: DescribeTargetedSentimentDetectionJobRequest)
1884
+ o.output = Shapes::ShapeRef.new(shape: DescribeTargetedSentimentDetectionJobResponse)
1885
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1886
+ o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
1887
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
1888
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1889
+ end)
1890
+
1807
1891
  api.add_operation(:describe_topics_detection_job, Seahorse::Model::Operation.new.tap do |o|
1808
1892
  o.name = "DescribeTopicsDetectionJob"
1809
1893
  o.http_method = "POST"
@@ -2117,6 +2201,24 @@ module Aws::Comprehend
2117
2201
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2118
2202
  end)
2119
2203
 
2204
+ api.add_operation(:list_targeted_sentiment_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
2205
+ o.name = "ListTargetedSentimentDetectionJobs"
2206
+ o.http_method = "POST"
2207
+ o.http_request_uri = "/"
2208
+ o.input = Shapes::ShapeRef.new(shape: ListTargetedSentimentDetectionJobsRequest)
2209
+ o.output = Shapes::ShapeRef.new(shape: ListTargetedSentimentDetectionJobsResponse)
2210
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
2211
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
2212
+ o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
2213
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2214
+ o[:pager] = Aws::Pager.new(
2215
+ limit_key: "max_results",
2216
+ tokens: {
2217
+ "next_token" => "next_token"
2218
+ }
2219
+ )
2220
+ end)
2221
+
2120
2222
  api.add_operation(:list_topics_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
2121
2223
  o.name = "ListTopicsDetectionJobs"
2122
2224
  o.http_method = "POST"
@@ -2241,6 +2343,19 @@ module Aws::Comprehend
2241
2343
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2242
2344
  end)
2243
2345
 
2346
+ api.add_operation(:start_targeted_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
2347
+ o.name = "StartTargetedSentimentDetectionJob"
2348
+ o.http_method = "POST"
2349
+ o.http_request_uri = "/"
2350
+ o.input = Shapes::ShapeRef.new(shape: StartTargetedSentimentDetectionJobRequest)
2351
+ o.output = Shapes::ShapeRef.new(shape: StartTargetedSentimentDetectionJobResponse)
2352
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
2353
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
2354
+ o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
2355
+ o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
2356
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2357
+ end)
2358
+
2244
2359
  api.add_operation(:start_topics_detection_job, Seahorse::Model::Operation.new.tap do |o|
2245
2360
  o.name = "StartTopicsDetectionJob"
2246
2361
  o.http_method = "POST"
@@ -2320,6 +2435,17 @@ module Aws::Comprehend
2320
2435
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2321
2436
  end)
2322
2437
 
2438
+ api.add_operation(:stop_targeted_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
2439
+ o.name = "StopTargetedSentimentDetectionJob"
2440
+ o.http_method = "POST"
2441
+ o.http_request_uri = "/"
2442
+ o.input = Shapes::ShapeRef.new(shape: StopTargetedSentimentDetectionJobRequest)
2443
+ o.output = Shapes::ShapeRef.new(shape: StopTargetedSentimentDetectionJobResponse)
2444
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
2445
+ o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
2446
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2447
+ end)
2448
+
2323
2449
  api.add_operation(:stop_training_document_classifier, Seahorse::Model::Operation.new.tap do |o|
2324
2450
  o.name = "StopTrainingDocumentClassifier"
2325
2451
  o.http_method = "POST"
@@ -1650,6 +1650,39 @@ module Aws::Comprehend
1650
1650
  include Aws::Structure
1651
1651
  end
1652
1652
 
1653
+ # @note When making an API call, you may pass DescribeTargetedSentimentDetectionJobRequest
1654
+ # data as a hash:
1655
+ #
1656
+ # {
1657
+ # job_id: "JobId", # required
1658
+ # }
1659
+ #
1660
+ # @!attribute [rw] job_id
1661
+ # The identifier that Amazon Comprehend generated for the job. The
1662
+ # operation returns this identifier in its response.
1663
+ # @return [String]
1664
+ #
1665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobRequest AWS API Documentation
1666
+ #
1667
+ class DescribeTargetedSentimentDetectionJobRequest < Struct.new(
1668
+ :job_id)
1669
+ SENSITIVE = []
1670
+ include Aws::Structure
1671
+ end
1672
+
1673
+ # @!attribute [rw] targeted_sentiment_detection_job_properties
1674
+ # An object that contains the properties associated with a targeted
1675
+ # sentiment detection job.
1676
+ # @return [Types::TargetedSentimentDetectionJobProperties]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobResponse AWS API Documentation
1679
+ #
1680
+ class DescribeTargetedSentimentDetectionJobResponse < Struct.new(
1681
+ :targeted_sentiment_detection_job_properties)
1682
+ SENSITIVE = []
1683
+ include Aws::Structure
1684
+ end
1685
+
1653
1686
  # @note When making an API call, you may pass DescribeTopicsDetectionJobRequest
1654
1687
  # data as a hash:
1655
1688
  #
@@ -3203,8 +3236,10 @@ module Aws::Comprehend
3203
3236
  # @!attribute [rw] f1_score
3204
3237
  # A measure of how accurate the recognizer results are for the test
3205
3238
  # data. It is derived from the `Precision` and `Recall` values. The
3206
- # `F1Score` is the harmonic average of the two scores. The highest
3207
- # score is 1, and the worst score is 0.
3239
+ # `F1Score` is the harmonic average of the two scores. For plain text
3240
+ # entity recognizer models, the range is 0 to 100, where 100 is the
3241
+ # best score. For PDF/Word entity recognizer models, the range is 0 to
3242
+ # 1, where 1 is the best score.
3208
3243
  # @return [Float]
3209
3244
  #
3210
3245
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEvaluationMetrics AWS API Documentation
@@ -4865,6 +4900,62 @@ module Aws::Comprehend
4865
4900
  include Aws::Structure
4866
4901
  end
4867
4902
 
4903
+ # @note When making an API call, you may pass ListTargetedSentimentDetectionJobsRequest
4904
+ # data as a hash:
4905
+ #
4906
+ # {
4907
+ # filter: {
4908
+ # job_name: "JobName",
4909
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4910
+ # submit_time_before: Time.now,
4911
+ # submit_time_after: Time.now,
4912
+ # },
4913
+ # next_token: "String",
4914
+ # max_results: 1,
4915
+ # }
4916
+ #
4917
+ # @!attribute [rw] filter
4918
+ # Filters the jobs that are returned. You can filter jobs on their
4919
+ # name, status, or the date and time that they were submitted. You can
4920
+ # only set one filter at a time.
4921
+ # @return [Types::TargetedSentimentDetectionJobFilter]
4922
+ #
4923
+ # @!attribute [rw] next_token
4924
+ # Identifies the next page of results to return.
4925
+ # @return [String]
4926
+ #
4927
+ # @!attribute [rw] max_results
4928
+ # The maximum number of results to return in each page. The default is
4929
+ # 100.
4930
+ # @return [Integer]
4931
+ #
4932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobsRequest AWS API Documentation
4933
+ #
4934
+ class ListTargetedSentimentDetectionJobsRequest < Struct.new(
4935
+ :filter,
4936
+ :next_token,
4937
+ :max_results)
4938
+ SENSITIVE = []
4939
+ include Aws::Structure
4940
+ end
4941
+
4942
+ # @!attribute [rw] targeted_sentiment_detection_job_properties_list
4943
+ # A list containing the properties of each job that is returned.
4944
+ # @return [Array<Types::TargetedSentimentDetectionJobProperties>]
4945
+ #
4946
+ # @!attribute [rw] next_token
4947
+ # Identifies the next page of results to return.
4948
+ # @return [String]
4949
+ #
4950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobsResponse AWS API Documentation
4951
+ #
4952
+ class ListTargetedSentimentDetectionJobsResponse < Struct.new(
4953
+ :targeted_sentiment_detection_job_properties_list,
4954
+ :next_token)
4955
+ SENSITIVE = []
4956
+ include Aws::Structure
4957
+ end
4958
+
4868
4959
  # @note When making an API call, you may pass ListTopicsDetectionJobsRequest
4869
4960
  # data as a hash:
4870
4961
  #
@@ -4921,8 +5012,7 @@ module Aws::Comprehend
4921
5012
  include Aws::Structure
4922
5013
  end
4923
5014
 
4924
- # Provides configuration parameters for the output of topic detection
4925
- # jobs.
5015
+ # Provides configuration parameters for the output of inference jobs.
4926
5016
  #
4927
5017
  # @note When making an API call, you may pass OutputDataConfig
4928
5018
  # data as a hash:
@@ -4943,6 +5033,10 @@ module Aws::Comprehend
4943
5033
  # output file in a directory specific to the job. The `S3Uri` field
4944
5034
  # contains the location of the output file, called `output.tar.gz`. It
4945
5035
  # is a compressed archive that contains the ouput of the operation.
5036
+ #
5037
+ # For a PII entity detection job, the output file is plain text, not a
5038
+ # compressed archive. The output file name is the same as the input
5039
+ # file, with `.out` appended at the end.
4946
5040
  # @return [String]
4947
5041
  #
4948
5042
  # @!attribute [rw] kms_key_id
@@ -5178,6 +5272,10 @@ module Aws::Comprehend
5178
5272
  # When you use the `PiiOutputDataConfig` object with asynchronous
5179
5273
  # operations, you specify the Amazon S3 location where you want to
5180
5274
  # write the output data.
5275
+ #
5276
+ # For a PII entity detection job, the output file is plain text, not a
5277
+ # compressed archive. The output file name is the same as the input
5278
+ # file, with `.out` appended at the end.
5181
5279
  # @return [String]
5182
5280
  #
5183
5281
  # @!attribute [rw] kms_key_id
@@ -6580,6 +6678,166 @@ module Aws::Comprehend
6580
6678
  include Aws::Structure
6581
6679
  end
6582
6680
 
6681
+ # @note When making an API call, you may pass StartTargetedSentimentDetectionJobRequest
6682
+ # data as a hash:
6683
+ #
6684
+ # {
6685
+ # input_data_config: { # required
6686
+ # s3_uri: "S3Uri", # required
6687
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6688
+ # document_reader_config: {
6689
+ # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6690
+ # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6691
+ # feature_types: ["TABLES"], # accepts TABLES, FORMS
6692
+ # },
6693
+ # },
6694
+ # output_data_config: { # required
6695
+ # s3_uri: "S3Uri", # required
6696
+ # kms_key_id: "KmsKeyId",
6697
+ # },
6698
+ # data_access_role_arn: "IamRoleArn", # required
6699
+ # job_name: "JobName",
6700
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6701
+ # client_request_token: "ClientRequestTokenString",
6702
+ # volume_kms_key_id: "KmsKeyId",
6703
+ # vpc_config: {
6704
+ # security_group_ids: ["SecurityGroupId"], # required
6705
+ # subnets: ["SubnetId"], # required
6706
+ # },
6707
+ # tags: [
6708
+ # {
6709
+ # key: "TagKey", # required
6710
+ # value: "TagValue",
6711
+ # },
6712
+ # ],
6713
+ # }
6714
+ #
6715
+ # @!attribute [rw] input_data_config
6716
+ # The input properties for an inference job.
6717
+ # @return [Types::InputDataConfig]
6718
+ #
6719
+ # @!attribute [rw] output_data_config
6720
+ # Specifies where to send the output files.
6721
+ # @return [Types::OutputDataConfig]
6722
+ #
6723
+ # @!attribute [rw] data_access_role_arn
6724
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
6725
+ # Management (IAM) role that grants Amazon Comprehend read access to
6726
+ # your input data. For more information, see [Role-based
6727
+ # permissions][1].
6728
+ #
6729
+ #
6730
+ #
6731
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
6732
+ # @return [String]
6733
+ #
6734
+ # @!attribute [rw] job_name
6735
+ # The identifier of the job.
6736
+ # @return [String]
6737
+ #
6738
+ # @!attribute [rw] language_code
6739
+ # The language of the input documents. You can specify any of the
6740
+ # primary languages supported by Amazon Comprehend. All documents must
6741
+ # be in the same language.
6742
+ # @return [String]
6743
+ #
6744
+ # @!attribute [rw] client_request_token
6745
+ # A unique identifier for the request. If you don't set the client
6746
+ # request token, Amazon Comprehend generates one.
6747
+ #
6748
+ # **A suitable default value is auto-generated.** You should normally
6749
+ # not need to pass this option.
6750
+ # @return [String]
6751
+ #
6752
+ # @!attribute [rw] volume_kms_key_id
6753
+ # ID for the KMS key that Amazon Comprehend uses to encrypt data on
6754
+ # the storage volume attached to the ML compute instance(s) that
6755
+ # process the analysis job. The VolumeKmsKeyId can be either of the
6756
+ # following formats:
6757
+ #
6758
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6759
+ #
6760
+ # * Amazon Resource Name (ARN) of a KMS Key:
6761
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
6762
+ # @return [String]
6763
+ #
6764
+ # @!attribute [rw] vpc_config
6765
+ # Configuration parameters for an optional private Virtual Private
6766
+ # Cloud (VPC) containing the resources you are using for the job. For
6767
+ # more information, see [Amazon VPC][1].
6768
+ #
6769
+ #
6770
+ #
6771
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
6772
+ # @return [Types::VpcConfig]
6773
+ #
6774
+ # @!attribute [rw] tags
6775
+ # Tags to be associated with the targeted sentiment detection job. A
6776
+ # tag is a key-value pair that adds metadata to a resource used by
6777
+ # Amazon Comprehend. For example, a tag with "Sales" as the key
6778
+ # might be added to a resource to indicate its use by the sales
6779
+ # department.
6780
+ # @return [Array<Types::Tag>]
6781
+ #
6782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobRequest AWS API Documentation
6783
+ #
6784
+ class StartTargetedSentimentDetectionJobRequest < Struct.new(
6785
+ :input_data_config,
6786
+ :output_data_config,
6787
+ :data_access_role_arn,
6788
+ :job_name,
6789
+ :language_code,
6790
+ :client_request_token,
6791
+ :volume_kms_key_id,
6792
+ :vpc_config,
6793
+ :tags)
6794
+ SENSITIVE = []
6795
+ include Aws::Structure
6796
+ end
6797
+
6798
+ # @!attribute [rw] job_id
6799
+ # The identifier generated for the job. To get the status of a job,
6800
+ # use this identifier with the operation.
6801
+ # @return [String]
6802
+ #
6803
+ # @!attribute [rw] job_arn
6804
+ # The Amazon Resource Name (ARN) of the targeted sentiment detection
6805
+ # job. It is a unique, fully qualified identifier for the job. It
6806
+ # includes the AWS account, Region, and the job ID. The format of the
6807
+ # ARN is as follows:
6808
+ #
6809
+ # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
6810
+ #
6811
+ # The following is an example job ARN:
6812
+ #
6813
+ # `arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
6814
+ # @return [String]
6815
+ #
6816
+ # @!attribute [rw] job_status
6817
+ # The status of the job.
6818
+ #
6819
+ # * SUBMITTED - The job has been received and is queued for
6820
+ # processing.
6821
+ #
6822
+ # * IN\_PROGRESS - Amazon Comprehend is processing the job.
6823
+ #
6824
+ # * COMPLETED - The job was successfully completed and the output is
6825
+ # available.
6826
+ #
6827
+ # * FAILED - The job did not complete. To get details, use the
6828
+ # operation.
6829
+ # @return [String]
6830
+ #
6831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobResponse AWS API Documentation
6832
+ #
6833
+ class StartTargetedSentimentDetectionJobResponse < Struct.new(
6834
+ :job_id,
6835
+ :job_arn,
6836
+ :job_status)
6837
+ SENSITIVE = []
6838
+ include Aws::Structure
6839
+ end
6840
+
6583
6841
  # @note When making an API call, you may pass StartTopicsDetectionJobRequest
6584
6842
  # data as a hash:
6585
6843
  #
@@ -6964,6 +7222,44 @@ module Aws::Comprehend
6964
7222
  include Aws::Structure
6965
7223
  end
6966
7224
 
7225
+ # @note When making an API call, you may pass StopTargetedSentimentDetectionJobRequest
7226
+ # data as a hash:
7227
+ #
7228
+ # {
7229
+ # job_id: "JobId", # required
7230
+ # }
7231
+ #
7232
+ # @!attribute [rw] job_id
7233
+ # The identifier of the targeted sentiment detection job to stop.
7234
+ # @return [String]
7235
+ #
7236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJobRequest AWS API Documentation
7237
+ #
7238
+ class StopTargetedSentimentDetectionJobRequest < Struct.new(
7239
+ :job_id)
7240
+ SENSITIVE = []
7241
+ include Aws::Structure
7242
+ end
7243
+
7244
+ # @!attribute [rw] job_id
7245
+ # The identifier of the targeted sentiment detection job to stop.
7246
+ # @return [String]
7247
+ #
7248
+ # @!attribute [rw] job_status
7249
+ # Either `STOP_REQUESTED` if the job is currently running, or
7250
+ # `STOPPED` if the job was previously stopped with the
7251
+ # `StopSentimentDetectionJob` operation.
7252
+ # @return [String]
7253
+ #
7254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJobResponse AWS API Documentation
7255
+ #
7256
+ class StopTargetedSentimentDetectionJobResponse < Struct.new(
7257
+ :job_id,
7258
+ :job_status)
7259
+ SENSITIVE = []
7260
+ include Aws::Structure
7261
+ end
7262
+
6967
7263
  # @note When making an API call, you may pass StopTrainingDocumentClassifierRequest
6968
7264
  # data as a hash:
6969
7265
  #
@@ -7127,6 +7423,155 @@ module Aws::Comprehend
7127
7423
  #
7128
7424
  class TagResourceResponse < Aws::EmptyStructure; end
7129
7425
 
7426
+ # Provides information for filtering a list of dominant language
7427
+ # detection jobs. For more information, see the operation.
7428
+ #
7429
+ # @note When making an API call, you may pass TargetedSentimentDetectionJobFilter
7430
+ # data as a hash:
7431
+ #
7432
+ # {
7433
+ # job_name: "JobName",
7434
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
7435
+ # submit_time_before: Time.now,
7436
+ # submit_time_after: Time.now,
7437
+ # }
7438
+ #
7439
+ # @!attribute [rw] job_name
7440
+ # Filters on the name of the job.
7441
+ # @return [String]
7442
+ #
7443
+ # @!attribute [rw] job_status
7444
+ # Filters the list of jobs based on job status. Returns only jobs with
7445
+ # the specified status.
7446
+ # @return [String]
7447
+ #
7448
+ # @!attribute [rw] submit_time_before
7449
+ # Filters the list of jobs based on the time that the job was
7450
+ # submitted for processing. Returns only jobs submitted before the
7451
+ # specified time. Jobs are returned in ascending order, oldest to
7452
+ # newest.
7453
+ # @return [Time]
7454
+ #
7455
+ # @!attribute [rw] submit_time_after
7456
+ # Filters the list of jobs based on the time that the job was
7457
+ # submitted for processing. Returns only jobs submitted after the
7458
+ # specified time. Jobs are returned in descending order, newest to
7459
+ # oldest.
7460
+ # @return [Time]
7461
+ #
7462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentDetectionJobFilter AWS API Documentation
7463
+ #
7464
+ class TargetedSentimentDetectionJobFilter < Struct.new(
7465
+ :job_name,
7466
+ :job_status,
7467
+ :submit_time_before,
7468
+ :submit_time_after)
7469
+ SENSITIVE = []
7470
+ include Aws::Structure
7471
+ end
7472
+
7473
+ # Provides information about a targeted sentiment detection job.
7474
+ #
7475
+ # @!attribute [rw] job_id
7476
+ # The identifier assigned to the targeted sentiment detection job.
7477
+ # @return [String]
7478
+ #
7479
+ # @!attribute [rw] job_arn
7480
+ # The Amazon Resource Name (ARN) of the targeted sentiment detection
7481
+ # job. It is a unique, fully qualified identifier for the job. It
7482
+ # includes the AWS account, Region, and the job ID. The format of the
7483
+ # ARN is as follows:
7484
+ #
7485
+ # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
7486
+ #
7487
+ # The following is an example job ARN:
7488
+ #
7489
+ # `arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
7490
+ # @return [String]
7491
+ #
7492
+ # @!attribute [rw] job_name
7493
+ # The name that you assigned to the targeted sentiment detection job.
7494
+ # @return [String]
7495
+ #
7496
+ # @!attribute [rw] job_status
7497
+ # The current status of the targeted sentiment detection job. If the
7498
+ # status is `FAILED`, the `Messages` field shows the reason for the
7499
+ # failure.
7500
+ # @return [String]
7501
+ #
7502
+ # @!attribute [rw] message
7503
+ # A description of the status of a job.
7504
+ # @return [String]
7505
+ #
7506
+ # @!attribute [rw] submit_time
7507
+ # The time that the targeted sentiment detection job was submitted for
7508
+ # processing.
7509
+ # @return [Time]
7510
+ #
7511
+ # @!attribute [rw] end_time
7512
+ # The time that the targeted sentiment detection job ended.
7513
+ # @return [Time]
7514
+ #
7515
+ # @!attribute [rw] input_data_config
7516
+ # The input properties for an inference job.
7517
+ # @return [Types::InputDataConfig]
7518
+ #
7519
+ # @!attribute [rw] output_data_config
7520
+ # Provides configuration parameters for the output of inference jobs.
7521
+ # @return [Types::OutputDataConfig]
7522
+ #
7523
+ # @!attribute [rw] language_code
7524
+ # The language code of the input documents.
7525
+ # @return [String]
7526
+ #
7527
+ # @!attribute [rw] data_access_role_arn
7528
+ # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
7529
+ # access to your input data.
7530
+ # @return [String]
7531
+ #
7532
+ # @!attribute [rw] volume_kms_key_id
7533
+ # ID for the AWS Key Management Service (KMS) key that Amazon
7534
+ # Comprehend uses to encrypt data on the storage volume attached to
7535
+ # the ML compute instance(s) that process the targeted sentiment
7536
+ # detection job. The VolumeKmsKeyId can be either of the following
7537
+ # formats:
7538
+ #
7539
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7540
+ #
7541
+ # * Amazon Resource Name (ARN) of a KMS Key:
7542
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
7543
+ # @return [String]
7544
+ #
7545
+ # @!attribute [rw] vpc_config
7546
+ # Configuration parameters for an optional private Virtual Private
7547
+ # Cloud (VPC) containing the resources you are using for the job. For
7548
+ # more information, see [Amazon VPC][1].
7549
+ #
7550
+ #
7551
+ #
7552
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
7553
+ # @return [Types::VpcConfig]
7554
+ #
7555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentDetectionJobProperties AWS API Documentation
7556
+ #
7557
+ class TargetedSentimentDetectionJobProperties < Struct.new(
7558
+ :job_id,
7559
+ :job_arn,
7560
+ :job_name,
7561
+ :job_status,
7562
+ :message,
7563
+ :submit_time,
7564
+ :end_time,
7565
+ :input_data_config,
7566
+ :output_data_config,
7567
+ :language_code,
7568
+ :data_access_role_arn,
7569
+ :volume_kms_key_id,
7570
+ :vpc_config)
7571
+ SENSITIVE = []
7572
+ include Aws::Structure
7573
+ end
7574
+
7130
7575
  # The size of the input text exceeds the limit. Use a smaller document.
7131
7576
  #
7132
7577
  # @!attribute [rw] message
@@ -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.59.0'
51
+ GEM_VERSION = '1.60.0'
52
52
 
53
53
  end
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.59.0
4
+ version: 1.60.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: 2022-02-24 00:00:00.000000000 Z
11
+ date: 2022-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core