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.
@@ -268,7 +268,7 @@ module Aws::Comprehend
268
268
  # @!attribute [rw] text_list
269
269
  # A list containing the text of the input documents. The list can
270
270
  # contain a maximum of 25 documents. Each document must contain fewer
271
- # that 5,000 bytes of UTF-8 encoded characters.
271
+ # than 5,000 bytes of UTF-8 encoded characters.
272
272
  # @return [Array<String>]
273
273
  #
274
274
  # @!attribute [rw] language_code
@@ -626,7 +626,12 @@ module Aws::Comprehend
626
626
  # @return [String]
627
627
  #
628
628
  # @!attribute [rw] endpoint_arn
629
- # The Amazon Resource Number (ARN) of the endpoint.
629
+ # The Amazon Resource Number (ARN) of the endpoint. For information
630
+ # about endpoints, see [Managing endpoints][1].
631
+ #
632
+ #
633
+ #
634
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
630
635
  # @return [String]
631
636
  #
632
637
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentRequest AWS API Documentation
@@ -693,7 +698,8 @@ module Aws::Comprehend
693
698
  # @return [String]
694
699
  #
695
700
  # @!attribute [rw] language_code
696
- # The language of the input documents.
701
+ # The language of the input documents. Currently, English is the only
702
+ # valid language.
697
703
  # @return [String]
698
704
  #
699
705
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesRequest AWS API Documentation
@@ -1650,6 +1656,39 @@ module Aws::Comprehend
1650
1656
  include Aws::Structure
1651
1657
  end
1652
1658
 
1659
+ # @note When making an API call, you may pass DescribeTargetedSentimentDetectionJobRequest
1660
+ # data as a hash:
1661
+ #
1662
+ # {
1663
+ # job_id: "JobId", # required
1664
+ # }
1665
+ #
1666
+ # @!attribute [rw] job_id
1667
+ # The identifier that Amazon Comprehend generated for the job. The
1668
+ # operation returns this identifier in its response.
1669
+ # @return [String]
1670
+ #
1671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobRequest AWS API Documentation
1672
+ #
1673
+ class DescribeTargetedSentimentDetectionJobRequest < Struct.new(
1674
+ :job_id)
1675
+ SENSITIVE = []
1676
+ include Aws::Structure
1677
+ end
1678
+
1679
+ # @!attribute [rw] targeted_sentiment_detection_job_properties
1680
+ # An object that contains the properties associated with a targeted
1681
+ # sentiment detection job.
1682
+ # @return [Types::TargetedSentimentDetectionJobProperties]
1683
+ #
1684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobResponse AWS API Documentation
1685
+ #
1686
+ class DescribeTargetedSentimentDetectionJobResponse < Struct.new(
1687
+ :targeted_sentiment_detection_job_properties)
1688
+ SENSITIVE = []
1689
+ include Aws::Structure
1690
+ end
1691
+
1653
1692
  # @note When making an API call, you may pass DescribeTopicsDetectionJobRequest
1654
1693
  # data as a hash:
1655
1694
  #
@@ -1756,6 +1795,12 @@ module Aws::Comprehend
1756
1795
  # If you specify an endpoint, Amazon Comprehend uses the language of
1757
1796
  # your custom model, and it ignores any language code that you provide
1758
1797
  # in your request.
1798
+ #
1799
+ # For information about endpoints, see [Managing endpoints][1].
1800
+ #
1801
+ #
1802
+ #
1803
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
1759
1804
  # @return [String]
1760
1805
  #
1761
1806
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
@@ -1846,7 +1891,8 @@ module Aws::Comprehend
1846
1891
  # @return [String]
1847
1892
  #
1848
1893
  # @!attribute [rw] language_code
1849
- # The language of the input documents.
1894
+ # The language of the input documents. Currently, English is the only
1895
+ # valid language.
1850
1896
  # @return [String]
1851
1897
  #
1852
1898
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesRequest AWS API Documentation
@@ -2114,7 +2160,7 @@ module Aws::Comprehend
2114
2160
  #
2115
2161
  #
2116
2162
  #
2117
- # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
2163
+ # [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
2118
2164
  # @return [Types::VpcConfig]
2119
2165
  #
2120
2166
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation
@@ -2187,7 +2233,7 @@ module Aws::Comprehend
2187
2233
  # The input properties for training a document classifier.
2188
2234
  #
2189
2235
  # For more information on how the input file is formatted, see
2190
- # how-document-classification-training-data.
2236
+ # prep-classifier-data.
2191
2237
  #
2192
2238
  # @note When making an API call, you may pass DocumentClassifierInputDataConfig
2193
2239
  # data as a hash:
@@ -2416,7 +2462,7 @@ module Aws::Comprehend
2416
2462
  #
2417
2463
  #
2418
2464
  #
2419
- # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
2465
+ # [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
2420
2466
  # @return [Types::VpcConfig]
2421
2467
  #
2422
2468
  # @!attribute [rw] mode
@@ -2793,7 +2839,12 @@ module Aws::Comprehend
2793
2839
  include Aws::Structure
2794
2840
  end
2795
2841
 
2796
- # Specifies information about the specified endpoint.
2842
+ # Specifies information about the specified endpoint. For information
2843
+ # about endpoints, see [Managing endpoints][1].
2844
+ #
2845
+ #
2846
+ #
2847
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
2797
2848
  #
2798
2849
  # @!attribute [rw] endpoint_arn
2799
2850
  # The Amazon Resource Number (ARN) of the endpoint.
@@ -3203,8 +3254,10 @@ module Aws::Comprehend
3203
3254
  # @!attribute [rw] f1_score
3204
3255
  # A measure of how accurate the recognizer results are for the test
3205
3256
  # 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.
3257
+ # `F1Score` is the harmonic average of the two scores. For plain text
3258
+ # entity recognizer models, the range is 0 to 100, where 100 is the
3259
+ # best score. For PDF/Word entity recognizer models, the range is 0 to
3260
+ # 1, where 1 is the best score.
3208
3261
  # @return [Float]
3209
3262
  #
3210
3263
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEvaluationMetrics AWS API Documentation
@@ -4865,6 +4918,62 @@ module Aws::Comprehend
4865
4918
  include Aws::Structure
4866
4919
  end
4867
4920
 
4921
+ # @note When making an API call, you may pass ListTargetedSentimentDetectionJobsRequest
4922
+ # data as a hash:
4923
+ #
4924
+ # {
4925
+ # filter: {
4926
+ # job_name: "JobName",
4927
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4928
+ # submit_time_before: Time.now,
4929
+ # submit_time_after: Time.now,
4930
+ # },
4931
+ # next_token: "String",
4932
+ # max_results: 1,
4933
+ # }
4934
+ #
4935
+ # @!attribute [rw] filter
4936
+ # Filters the jobs that are returned. You can filter jobs on their
4937
+ # name, status, or the date and time that they were submitted. You can
4938
+ # only set one filter at a time.
4939
+ # @return [Types::TargetedSentimentDetectionJobFilter]
4940
+ #
4941
+ # @!attribute [rw] next_token
4942
+ # Identifies the next page of results to return.
4943
+ # @return [String]
4944
+ #
4945
+ # @!attribute [rw] max_results
4946
+ # The maximum number of results to return in each page. The default is
4947
+ # 100.
4948
+ # @return [Integer]
4949
+ #
4950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobsRequest AWS API Documentation
4951
+ #
4952
+ class ListTargetedSentimentDetectionJobsRequest < Struct.new(
4953
+ :filter,
4954
+ :next_token,
4955
+ :max_results)
4956
+ SENSITIVE = []
4957
+ include Aws::Structure
4958
+ end
4959
+
4960
+ # @!attribute [rw] targeted_sentiment_detection_job_properties_list
4961
+ # A list containing the properties of each job that is returned.
4962
+ # @return [Array<Types::TargetedSentimentDetectionJobProperties>]
4963
+ #
4964
+ # @!attribute [rw] next_token
4965
+ # Identifies the next page of results to return.
4966
+ # @return [String]
4967
+ #
4968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobsResponse AWS API Documentation
4969
+ #
4970
+ class ListTargetedSentimentDetectionJobsResponse < Struct.new(
4971
+ :targeted_sentiment_detection_job_properties_list,
4972
+ :next_token)
4973
+ SENSITIVE = []
4974
+ include Aws::Structure
4975
+ end
4976
+
4868
4977
  # @note When making an API call, you may pass ListTopicsDetectionJobsRequest
4869
4978
  # data as a hash:
4870
4979
  #
@@ -4921,8 +5030,7 @@ module Aws::Comprehend
4921
5030
  include Aws::Structure
4922
5031
  end
4923
5032
 
4924
- # Provides configuration parameters for the output of topic detection
4925
- # jobs.
5033
+ # Provides configuration parameters for the output of inference jobs.
4926
5034
  #
4927
5035
  # @note When making an API call, you may pass OutputDataConfig
4928
5036
  # data as a hash:
@@ -4943,6 +5051,10 @@ module Aws::Comprehend
4943
5051
  # output file in a directory specific to the job. The `S3Uri` field
4944
5052
  # contains the location of the output file, called `output.tar.gz`. It
4945
5053
  # is a compressed archive that contains the ouput of the operation.
5054
+ #
5055
+ # For a PII entity detection job, the output file is plain text, not a
5056
+ # compressed archive. The output file name is the same as the input
5057
+ # file, with `.out` appended at the end.
4946
5058
  # @return [String]
4947
5059
  #
4948
5060
  # @!attribute [rw] kms_key_id
@@ -5178,6 +5290,10 @@ module Aws::Comprehend
5178
5290
  # When you use the `PiiOutputDataConfig` object with asynchronous
5179
5291
  # operations, you specify the Amazon S3 location where you want to
5180
5292
  # write the output data.
5293
+ #
5294
+ # For a PII entity detection job, the output file is plain text, not a
5295
+ # compressed archive. The output file name is the same as the input
5296
+ # file, with `.out` appended at the end.
5181
5297
  # @return [String]
5182
5298
  #
5183
5299
  # @!attribute [rw] kms_key_id
@@ -5261,7 +5377,7 @@ module Aws::Comprehend
5261
5377
  # data as a hash:
5262
5378
  #
5263
5379
  # {
5264
- # 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
5380
+ # 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
5265
5381
  # mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
5266
5382
  # mask_character: "MaskCharacter",
5267
5383
  # }
@@ -6307,7 +6423,7 @@ module Aws::Comprehend
6307
6423
  # },
6308
6424
  # mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
6309
6425
  # redaction_config: {
6310
- # 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
6426
+ # 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
6311
6427
  # mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
6312
6428
  # mask_character: "MaskCharacter",
6313
6429
  # },
@@ -6356,7 +6472,8 @@ module Aws::Comprehend
6356
6472
  # @return [String]
6357
6473
  #
6358
6474
  # @!attribute [rw] language_code
6359
- # The language of the input documents.
6475
+ # The language of the input documents. Currently, English is the only
6476
+ # valid language.
6360
6477
  # @return [String]
6361
6478
  #
6362
6479
  # @!attribute [rw] client_request_token
@@ -6580,6 +6697,165 @@ module Aws::Comprehend
6580
6697
  include Aws::Structure
6581
6698
  end
6582
6699
 
6700
+ # @note When making an API call, you may pass StartTargetedSentimentDetectionJobRequest
6701
+ # data as a hash:
6702
+ #
6703
+ # {
6704
+ # input_data_config: { # required
6705
+ # s3_uri: "S3Uri", # required
6706
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6707
+ # document_reader_config: {
6708
+ # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6709
+ # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6710
+ # feature_types: ["TABLES"], # accepts TABLES, FORMS
6711
+ # },
6712
+ # },
6713
+ # output_data_config: { # required
6714
+ # s3_uri: "S3Uri", # required
6715
+ # kms_key_id: "KmsKeyId",
6716
+ # },
6717
+ # data_access_role_arn: "IamRoleArn", # required
6718
+ # job_name: "JobName",
6719
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6720
+ # client_request_token: "ClientRequestTokenString",
6721
+ # volume_kms_key_id: "KmsKeyId",
6722
+ # vpc_config: {
6723
+ # security_group_ids: ["SecurityGroupId"], # required
6724
+ # subnets: ["SubnetId"], # required
6725
+ # },
6726
+ # tags: [
6727
+ # {
6728
+ # key: "TagKey", # required
6729
+ # value: "TagValue",
6730
+ # },
6731
+ # ],
6732
+ # }
6733
+ #
6734
+ # @!attribute [rw] input_data_config
6735
+ # The input properties for an inference job.
6736
+ # @return [Types::InputDataConfig]
6737
+ #
6738
+ # @!attribute [rw] output_data_config
6739
+ # Specifies where to send the output files.
6740
+ # @return [Types::OutputDataConfig]
6741
+ #
6742
+ # @!attribute [rw] data_access_role_arn
6743
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
6744
+ # Management (IAM) role that grants Amazon Comprehend read access to
6745
+ # your input data. For more information, see [Role-based
6746
+ # permissions][1].
6747
+ #
6748
+ #
6749
+ #
6750
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
6751
+ # @return [String]
6752
+ #
6753
+ # @!attribute [rw] job_name
6754
+ # The identifier of the job.
6755
+ # @return [String]
6756
+ #
6757
+ # @!attribute [rw] language_code
6758
+ # The language of the input documents. Currently, English is the only
6759
+ # valid language.
6760
+ # @return [String]
6761
+ #
6762
+ # @!attribute [rw] client_request_token
6763
+ # A unique identifier for the request. If you don't set the client
6764
+ # request token, Amazon Comprehend generates one.
6765
+ #
6766
+ # **A suitable default value is auto-generated.** You should normally
6767
+ # not need to pass this option.
6768
+ # @return [String]
6769
+ #
6770
+ # @!attribute [rw] volume_kms_key_id
6771
+ # ID for the KMS key that Amazon Comprehend uses to encrypt data on
6772
+ # the storage volume attached to the ML compute instance(s) that
6773
+ # process the analysis job. The VolumeKmsKeyId can be either of the
6774
+ # following formats:
6775
+ #
6776
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6777
+ #
6778
+ # * Amazon Resource Name (ARN) of a KMS Key:
6779
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
6780
+ # @return [String]
6781
+ #
6782
+ # @!attribute [rw] vpc_config
6783
+ # Configuration parameters for an optional private Virtual Private
6784
+ # Cloud (VPC) containing the resources you are using for the job. For
6785
+ # more information, see [Amazon VPC][1].
6786
+ #
6787
+ #
6788
+ #
6789
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
6790
+ # @return [Types::VpcConfig]
6791
+ #
6792
+ # @!attribute [rw] tags
6793
+ # Tags to be associated with the targeted sentiment detection job. A
6794
+ # tag is a key-value pair that adds metadata to a resource used by
6795
+ # Amazon Comprehend. For example, a tag with "Sales" as the key
6796
+ # might be added to a resource to indicate its use by the sales
6797
+ # department.
6798
+ # @return [Array<Types::Tag>]
6799
+ #
6800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobRequest AWS API Documentation
6801
+ #
6802
+ class StartTargetedSentimentDetectionJobRequest < Struct.new(
6803
+ :input_data_config,
6804
+ :output_data_config,
6805
+ :data_access_role_arn,
6806
+ :job_name,
6807
+ :language_code,
6808
+ :client_request_token,
6809
+ :volume_kms_key_id,
6810
+ :vpc_config,
6811
+ :tags)
6812
+ SENSITIVE = []
6813
+ include Aws::Structure
6814
+ end
6815
+
6816
+ # @!attribute [rw] job_id
6817
+ # The identifier generated for the job. To get the status of a job,
6818
+ # use this identifier with the operation.
6819
+ # @return [String]
6820
+ #
6821
+ # @!attribute [rw] job_arn
6822
+ # The Amazon Resource Name (ARN) of the targeted sentiment detection
6823
+ # job. It is a unique, fully qualified identifier for the job. It
6824
+ # includes the AWS account, Region, and the job ID. The format of the
6825
+ # ARN is as follows:
6826
+ #
6827
+ # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
6828
+ #
6829
+ # The following is an example job ARN:
6830
+ #
6831
+ # `arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
6832
+ # @return [String]
6833
+ #
6834
+ # @!attribute [rw] job_status
6835
+ # The status of the job.
6836
+ #
6837
+ # * SUBMITTED - The job has been received and is queued for
6838
+ # processing.
6839
+ #
6840
+ # * IN\_PROGRESS - Amazon Comprehend is processing the job.
6841
+ #
6842
+ # * COMPLETED - The job was successfully completed and the output is
6843
+ # available.
6844
+ #
6845
+ # * FAILED - The job did not complete. To get details, use the
6846
+ # operation.
6847
+ # @return [String]
6848
+ #
6849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobResponse AWS API Documentation
6850
+ #
6851
+ class StartTargetedSentimentDetectionJobResponse < Struct.new(
6852
+ :job_id,
6853
+ :job_arn,
6854
+ :job_status)
6855
+ SENSITIVE = []
6856
+ include Aws::Structure
6857
+ end
6858
+
6583
6859
  # @note When making an API call, you may pass StartTopicsDetectionJobRequest
6584
6860
  # data as a hash:
6585
6861
  #
@@ -6964,6 +7240,44 @@ module Aws::Comprehend
6964
7240
  include Aws::Structure
6965
7241
  end
6966
7242
 
7243
+ # @note When making an API call, you may pass StopTargetedSentimentDetectionJobRequest
7244
+ # data as a hash:
7245
+ #
7246
+ # {
7247
+ # job_id: "JobId", # required
7248
+ # }
7249
+ #
7250
+ # @!attribute [rw] job_id
7251
+ # The identifier of the targeted sentiment detection job to stop.
7252
+ # @return [String]
7253
+ #
7254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJobRequest AWS API Documentation
7255
+ #
7256
+ class StopTargetedSentimentDetectionJobRequest < Struct.new(
7257
+ :job_id)
7258
+ SENSITIVE = []
7259
+ include Aws::Structure
7260
+ end
7261
+
7262
+ # @!attribute [rw] job_id
7263
+ # The identifier of the targeted sentiment detection job to stop.
7264
+ # @return [String]
7265
+ #
7266
+ # @!attribute [rw] job_status
7267
+ # Either `STOP_REQUESTED` if the job is currently running, or
7268
+ # `STOPPED` if the job was previously stopped with the
7269
+ # `StopSentimentDetectionJob` operation.
7270
+ # @return [String]
7271
+ #
7272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJobResponse AWS API Documentation
7273
+ #
7274
+ class StopTargetedSentimentDetectionJobResponse < Struct.new(
7275
+ :job_id,
7276
+ :job_status)
7277
+ SENSITIVE = []
7278
+ include Aws::Structure
7279
+ end
7280
+
6967
7281
  # @note When making an API call, you may pass StopTrainingDocumentClassifierRequest
6968
7282
  # data as a hash:
6969
7283
  #
@@ -7127,6 +7441,155 @@ module Aws::Comprehend
7127
7441
  #
7128
7442
  class TagResourceResponse < Aws::EmptyStructure; end
7129
7443
 
7444
+ # Provides information for filtering a list of dominant language
7445
+ # detection jobs. For more information, see the operation.
7446
+ #
7447
+ # @note When making an API call, you may pass TargetedSentimentDetectionJobFilter
7448
+ # data as a hash:
7449
+ #
7450
+ # {
7451
+ # job_name: "JobName",
7452
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
7453
+ # submit_time_before: Time.now,
7454
+ # submit_time_after: Time.now,
7455
+ # }
7456
+ #
7457
+ # @!attribute [rw] job_name
7458
+ # Filters on the name of the job.
7459
+ # @return [String]
7460
+ #
7461
+ # @!attribute [rw] job_status
7462
+ # Filters the list of jobs based on job status. Returns only jobs with
7463
+ # the specified status.
7464
+ # @return [String]
7465
+ #
7466
+ # @!attribute [rw] submit_time_before
7467
+ # Filters the list of jobs based on the time that the job was
7468
+ # submitted for processing. Returns only jobs submitted before the
7469
+ # specified time. Jobs are returned in ascending order, oldest to
7470
+ # newest.
7471
+ # @return [Time]
7472
+ #
7473
+ # @!attribute [rw] submit_time_after
7474
+ # Filters the list of jobs based on the time that the job was
7475
+ # submitted for processing. Returns only jobs submitted after the
7476
+ # specified time. Jobs are returned in descending order, newest to
7477
+ # oldest.
7478
+ # @return [Time]
7479
+ #
7480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentDetectionJobFilter AWS API Documentation
7481
+ #
7482
+ class TargetedSentimentDetectionJobFilter < Struct.new(
7483
+ :job_name,
7484
+ :job_status,
7485
+ :submit_time_before,
7486
+ :submit_time_after)
7487
+ SENSITIVE = []
7488
+ include Aws::Structure
7489
+ end
7490
+
7491
+ # Provides information about a targeted sentiment detection job.
7492
+ #
7493
+ # @!attribute [rw] job_id
7494
+ # The identifier assigned to the targeted sentiment detection job.
7495
+ # @return [String]
7496
+ #
7497
+ # @!attribute [rw] job_arn
7498
+ # The Amazon Resource Name (ARN) of the targeted sentiment detection
7499
+ # job. It is a unique, fully qualified identifier for the job. It
7500
+ # includes the AWS account, Region, and the job ID. The format of the
7501
+ # ARN is as follows:
7502
+ #
7503
+ # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
7504
+ #
7505
+ # The following is an example job ARN:
7506
+ #
7507
+ # `arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
7508
+ # @return [String]
7509
+ #
7510
+ # @!attribute [rw] job_name
7511
+ # The name that you assigned to the targeted sentiment detection job.
7512
+ # @return [String]
7513
+ #
7514
+ # @!attribute [rw] job_status
7515
+ # The current status of the targeted sentiment detection job. If the
7516
+ # status is `FAILED`, the `Messages` field shows the reason for the
7517
+ # failure.
7518
+ # @return [String]
7519
+ #
7520
+ # @!attribute [rw] message
7521
+ # A description of the status of a job.
7522
+ # @return [String]
7523
+ #
7524
+ # @!attribute [rw] submit_time
7525
+ # The time that the targeted sentiment detection job was submitted for
7526
+ # processing.
7527
+ # @return [Time]
7528
+ #
7529
+ # @!attribute [rw] end_time
7530
+ # The time that the targeted sentiment detection job ended.
7531
+ # @return [Time]
7532
+ #
7533
+ # @!attribute [rw] input_data_config
7534
+ # The input properties for an inference job.
7535
+ # @return [Types::InputDataConfig]
7536
+ #
7537
+ # @!attribute [rw] output_data_config
7538
+ # Provides configuration parameters for the output of inference jobs.
7539
+ # @return [Types::OutputDataConfig]
7540
+ #
7541
+ # @!attribute [rw] language_code
7542
+ # The language code of the input documents.
7543
+ # @return [String]
7544
+ #
7545
+ # @!attribute [rw] data_access_role_arn
7546
+ # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
7547
+ # access to your input data.
7548
+ # @return [String]
7549
+ #
7550
+ # @!attribute [rw] volume_kms_key_id
7551
+ # ID for the AWS Key Management Service (KMS) key that Amazon
7552
+ # Comprehend uses to encrypt data on the storage volume attached to
7553
+ # the ML compute instance(s) that process the targeted sentiment
7554
+ # detection job. The VolumeKmsKeyId can be either of the following
7555
+ # formats:
7556
+ #
7557
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7558
+ #
7559
+ # * Amazon Resource Name (ARN) of a KMS Key:
7560
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
7561
+ # @return [String]
7562
+ #
7563
+ # @!attribute [rw] vpc_config
7564
+ # Configuration parameters for an optional private Virtual Private
7565
+ # Cloud (VPC) containing the resources you are using for the job. For
7566
+ # more information, see [Amazon VPC][1].
7567
+ #
7568
+ #
7569
+ #
7570
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
7571
+ # @return [Types::VpcConfig]
7572
+ #
7573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentDetectionJobProperties AWS API Documentation
7574
+ #
7575
+ class TargetedSentimentDetectionJobProperties < Struct.new(
7576
+ :job_id,
7577
+ :job_arn,
7578
+ :job_name,
7579
+ :job_status,
7580
+ :message,
7581
+ :submit_time,
7582
+ :end_time,
7583
+ :input_data_config,
7584
+ :output_data_config,
7585
+ :language_code,
7586
+ :data_access_role_arn,
7587
+ :volume_kms_key_id,
7588
+ :vpc_config)
7589
+ SENSITIVE = []
7590
+ include Aws::Structure
7591
+ end
7592
+
7130
7593
  # The size of the input text exceeds the limit. Use a smaller document.
7131
7594
  #
7132
7595
  # @!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.58.0'
51
+ GEM_VERSION = '1.61.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.58.0
4
+ version: 1.61.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-03 00:00:00.000000000 Z
11
+ date: 2022-05-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.126.0
22
+ version: 3.127.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.126.0
32
+ version: 3.127.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement