aws-sdk-comprehend 1.58.0 → 1.61.0

data/lib/aws-sdk-comprehend/types.rb

@@ -268,7 +268,7 @@ module Aws::Comprehend
     # @!attribute [rw] text_list
     #   A list containing the text of the input documents. The list can
     #   contain a maximum of 25 documents. Each document must contain fewer
-    #   that 5,000 bytes of UTF-8 encoded characters.
+    #   than 5,000 bytes of UTF-8 encoded characters.
     #   @return [Array<String>]
     #
     # @!attribute [rw] language_code
@@ -626,7 +626,12 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] endpoint_arn
-    #   The Amazon Resource Number (ARN) of the endpoint.
+    #   The Amazon Resource Number (ARN) of the endpoint. For information
+    #   about endpoints, see [Managing endpoints][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentRequest AWS API Documentation
@@ -693,7 +698,8 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] language_code
-    #   The language of the input documents.
+    #   The language of the input documents. Currently, English is the only
+    #   valid language.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesRequest AWS API Documentation
@@ -1650,6 +1656,39 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeTargetedSentimentDetectionJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The identifier that Amazon Comprehend generated for the job. The
+    #   operation returns this identifier in its response.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobRequest AWS API Documentation
+    #
+    class DescribeTargetedSentimentDetectionJobRequest < Struct.new(
+      :job_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] targeted_sentiment_detection_job_properties
+    #   An object that contains the properties associated with a targeted
+    #   sentiment detection job.
+    #   @return [Types::TargetedSentimentDetectionJobProperties]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobResponse AWS API Documentation
+    #
+    class DescribeTargetedSentimentDetectionJobResponse < Struct.new(
+      :targeted_sentiment_detection_job_properties)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeTopicsDetectionJobRequest
     #   data as a hash:
     #
@@ -1756,6 +1795,12 @@ module Aws::Comprehend
     #   If you specify an endpoint, Amazon Comprehend uses the language of
     #   your custom model, and it ignores any language code that you provide
     #   in your request.
+    #
+    #   For information about endpoints, see [Managing endpoints][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
@@ -1846,7 +1891,8 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] language_code
-    #   The language of the input documents.
+    #   The language of the input documents. Currently, English is the only
+    #   valid language.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesRequest AWS API Documentation
@@ -2114,7 +2160,7 @@ module Aws::Comprehend
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
+    #   [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation
@@ -2187,7 +2233,7 @@ module Aws::Comprehend
     # The input properties for training a document classifier.
     #
     # For more information on how the input file is formatted, see
-    # how-document-classification-training-data.
+    # prep-classifier-data.
     #
     # @note When making an API call, you may pass DocumentClassifierInputDataConfig
     #   data as a hash:
@@ -2416,7 +2462,7 @@ module Aws::Comprehend
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
+    #   [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
     # @!attribute [rw] mode
@@ -2793,7 +2839,12 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
-    # Specifies information about the specified endpoint.
+    # Specifies information about the specified endpoint. For information
+    # about endpoints, see [Managing endpoints][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
     #
     # @!attribute [rw] endpoint_arn
     #   The Amazon Resource Number (ARN) of the endpoint.
@@ -3203,8 +3254,10 @@ module Aws::Comprehend
     # @!attribute [rw] f1_score
     #   A measure of how accurate the recognizer results are for the test
     #   data. It is derived from the `Precision` and `Recall` values. The
-    #   `F1Score` is the harmonic average of the two scores. The highest
-    #   score is 1, and the worst score is 0.
+    #   `F1Score` is the harmonic average of the two scores. For plain text
+    #   entity recognizer models, the range is 0 to 100, where 100 is the
+    #   best score. For PDF/Word entity recognizer models, the range is 0 to
+    #   1, where 1 is the best score.
     #   @return [Float]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEvaluationMetrics AWS API Documentation
@@ -4865,6 +4918,62 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListTargetedSentimentDetectionJobsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         filter: {
+    #           job_name: "JobName",
+    #           job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
+    #           submit_time_before: Time.now,
+    #           submit_time_after: Time.now,
+    #         },
+    #         next_token: "String",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] filter
+    #   Filters the jobs that are returned. You can filter jobs on their
+    #   name, status, or the date and time that they were submitted. You can
+    #   only set one filter at a time.
+    #   @return [Types::TargetedSentimentDetectionJobFilter]
+    #
+    # @!attribute [rw] next_token
+    #   Identifies the next page of results to return.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in each page. The default is
+    #   100.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobsRequest AWS API Documentation
+    #
+    class ListTargetedSentimentDetectionJobsRequest < Struct.new(
+      :filter,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] targeted_sentiment_detection_job_properties_list
+    #   A list containing the properties of each job that is returned.
+    #   @return [Array<Types::TargetedSentimentDetectionJobProperties>]
+    #
+    # @!attribute [rw] next_token
+    #   Identifies the next page of results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobsResponse AWS API Documentation
+    #
+    class ListTargetedSentimentDetectionJobsResponse < Struct.new(
+      :targeted_sentiment_detection_job_properties_list,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListTopicsDetectionJobsRequest
     #   data as a hash:
     #
@@ -4921,8 +5030,7 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
-    # Provides configuration parameters for the output of topic detection
-    # jobs.
+    # Provides configuration parameters for the output of inference jobs.
     #
     # @note When making an API call, you may pass OutputDataConfig
     #   data as a hash:
@@ -4943,6 +5051,10 @@ module Aws::Comprehend
     #   output file in a directory specific to the job. The `S3Uri` field
     #   contains the location of the output file, called `output.tar.gz`. It
     #   is a compressed archive that contains the ouput of the operation.
+    #
+    #   For a PII entity detection job, the output file is plain text, not a
+    #   compressed archive. The output file name is the same as the input
+    #   file, with `.out` appended at the end.
     #   @return [String]
     #
     # @!attribute [rw] kms_key_id
@@ -5178,6 +5290,10 @@ module Aws::Comprehend
     #   When you use the `PiiOutputDataConfig` object with asynchronous
     #   operations, you specify the Amazon S3 location where you want to
     #   write the output data.
+    #
+    #   For a PII entity detection job, the output file is plain text, not a
+    #   compressed archive. The output file name is the same as the input
+    #   file, with `.out` appended at the end.
     #   @return [String]
     #
     # @!attribute [rw] kms_key_id
@@ -5261,7 +5377,7 @@ module Aws::Comprehend
     #   data as a hash:
     #
     #       {
-    #         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
+    #         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
     #         mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
     #         mask_character: "MaskCharacter",
     #       }
@@ -6307,7 +6423,7 @@ module Aws::Comprehend
     #         },
     #         mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
     #         redaction_config: {
-    #           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
+    #           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
     #           mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
     #           mask_character: "MaskCharacter",
     #         },
@@ -6356,7 +6472,8 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] language_code
-    #   The language of the input documents.
+    #   The language of the input documents. Currently, English is the only
+    #   valid language.
     #   @return [String]
     #
     # @!attribute [rw] client_request_token
@@ -6580,6 +6697,165 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StartTargetedSentimentDetectionJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         input_data_config: { # required
+    #           s3_uri: "S3Uri", # required
+    #           input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
+    #           document_reader_config: {
+    #             document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
+    #             document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
+    #             feature_types: ["TABLES"], # accepts TABLES, FORMS
+    #           },
+    #         },
+    #         output_data_config: { # required
+    #           s3_uri: "S3Uri", # required
+    #           kms_key_id: "KmsKeyId",
+    #         },
+    #         data_access_role_arn: "IamRoleArn", # required
+    #         job_name: "JobName",
+    #         language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
+    #         client_request_token: "ClientRequestTokenString",
+    #         volume_kms_key_id: "KmsKeyId",
+    #         vpc_config: {
+    #           security_group_ids: ["SecurityGroupId"], # required
+    #           subnets: ["SubnetId"], # required
+    #         },
+    #         tags: [
+    #           {
+    #             key: "TagKey", # required
+    #             value: "TagValue",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] input_data_config
+    #   The input properties for an inference job.
+    #   @return [Types::InputDataConfig]
+    #
+    # @!attribute [rw] output_data_config
+    #   Specifies where to send the output files.
+    #   @return [Types::OutputDataConfig]
+    #
+    # @!attribute [rw] data_access_role_arn
+    #   The Amazon Resource Name (ARN) of the AWS Identity and Access
+    #   Management (IAM) role that grants Amazon Comprehend read access to
+    #   your input data. For more information, see [Role-based
+    #   permissions][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The identifier of the job.
+    #   @return [String]
+    #
+    # @!attribute [rw] language_code
+    #   The language of the input documents. Currently, English is the only
+    #   valid language.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_request_token
+    #   A unique identifier for the request. If you don't set the client
+    #   request token, Amazon Comprehend generates one.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @!attribute [rw] volume_kms_key_id
+    #   ID for the KMS key that Amazon Comprehend uses to encrypt data on
+    #   the storage volume attached to the ML compute instance(s) that
+    #   process the analysis job. The VolumeKmsKeyId can be either of the
+    #   following formats:
+    #
+    #   * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
+    #
+    #   * Amazon Resource Name (ARN) of a KMS Key:
+    #     `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
+    #   @return [String]
+    #
+    # @!attribute [rw] vpc_config
+    #   Configuration parameters for an optional private Virtual Private
+    #   Cloud (VPC) containing the resources you are using for the job. For
+    #   more information, see [Amazon VPC][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
+    #   @return [Types::VpcConfig]
+    #
+    # @!attribute [rw] tags
+    #   Tags to be associated with the targeted sentiment detection job. A
+    #   tag is a key-value pair that adds metadata to a resource used by
+    #   Amazon Comprehend. For example, a tag with "Sales" as the key
+    #   might be added to a resource to indicate its use by the sales
+    #   department.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobRequest AWS API Documentation
+    #
+    class StartTargetedSentimentDetectionJobRequest < Struct.new(
+      :input_data_config,
+      :output_data_config,
+      :data_access_role_arn,
+      :job_name,
+      :language_code,
+      :client_request_token,
+      :volume_kms_key_id,
+      :vpc_config,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_id
+    #   The identifier generated for the job. To get the status of a job,
+    #   use this identifier with the operation.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_arn
+    #   The Amazon Resource Name (ARN) of the targeted sentiment detection
+    #   job. It is a unique, fully qualified identifier for the job. It
+    #   includes the AWS account, Region, and the job ID. The format of the
+    #   ARN is as follows:
+    #
+    #   `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
+    #
+    #   The following is an example job ARN:
+    #
+    #   `arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   The status of the job.
+    #
+    #   * SUBMITTED - The job has been received and is queued for
+    #     processing.
+    #
+    #   * IN\_PROGRESS - Amazon Comprehend is processing the job.
+    #
+    #   * COMPLETED - The job was successfully completed and the output is
+    #     available.
+    #
+    #   * FAILED - The job did not complete. To get details, use the
+    #     operation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobResponse AWS API Documentation
+    #
+    class StartTargetedSentimentDetectionJobResponse < Struct.new(
+      :job_id,
+      :job_arn,
+      :job_status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StartTopicsDetectionJobRequest
     #   data as a hash:
     #
@@ -6964,6 +7240,44 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StopTargetedSentimentDetectionJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The identifier of the targeted sentiment detection job to stop.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJobRequest AWS API Documentation
+    #
+    class StopTargetedSentimentDetectionJobRequest < Struct.new(
+      :job_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_id
+    #   The identifier of the targeted sentiment detection job to stop.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   Either `STOP_REQUESTED` if the job is currently running, or
+    #   `STOPPED` if the job was previously stopped with the
+    #   `StopSentimentDetectionJob` operation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJobResponse AWS API Documentation
+    #
+    class StopTargetedSentimentDetectionJobResponse < Struct.new(
+      :job_id,
+      :job_status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StopTrainingDocumentClassifierRequest
     #   data as a hash:
     #
@@ -7127,6 +7441,155 @@ module Aws::Comprehend
     #
     class TagResourceResponse < Aws::EmptyStructure; end
 
+    # Provides information for filtering a list of dominant language
+    # detection jobs. For more information, see the operation.
+    #
+    # @note When making an API call, you may pass TargetedSentimentDetectionJobFilter
+    #   data as a hash:
+    #
+    #       {
+    #         job_name: "JobName",
+    #         job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
+    #         submit_time_before: Time.now,
+    #         submit_time_after: Time.now,
+    #       }
+    #
+    # @!attribute [rw] job_name
+    #   Filters on the name of the job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   Filters the list of jobs based on job status. Returns only jobs with
+    #   the specified status.
+    #   @return [String]
+    #
+    # @!attribute [rw] submit_time_before
+    #   Filters the list of jobs based on the time that the job was
+    #   submitted for processing. Returns only jobs submitted before the
+    #   specified time. Jobs are returned in ascending order, oldest to
+    #   newest.
+    #   @return [Time]
+    #
+    # @!attribute [rw] submit_time_after
+    #   Filters the list of jobs based on the time that the job was
+    #   submitted for processing. Returns only jobs submitted after the
+    #   specified time. Jobs are returned in descending order, newest to
+    #   oldest.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentDetectionJobFilter AWS API Documentation
+    #
+    class TargetedSentimentDetectionJobFilter < Struct.new(
+      :job_name,
+      :job_status,
+      :submit_time_before,
+      :submit_time_after)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides information about a targeted sentiment detection job.
+    #
+    # @!attribute [rw] job_id
+    #   The identifier assigned to the targeted sentiment detection job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_arn
+    #   The Amazon Resource Name (ARN) of the targeted sentiment detection
+    #   job. It is a unique, fully qualified identifier for the job. It
+    #   includes the AWS account, Region, and the job ID. The format of the
+    #   ARN is as follows:
+    #
+    #   `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
+    #
+    #   The following is an example job ARN:
+    #
+    #   `arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The name that you assigned to the targeted sentiment detection job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   The current status of the targeted sentiment detection job. If the
+    #   status is `FAILED`, the `Messages` field shows the reason for the
+    #   failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   A description of the status of a job.
+    #   @return [String]
+    #
+    # @!attribute [rw] submit_time
+    #   The time that the targeted sentiment detection job was submitted for
+    #   processing.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_time
+    #   The time that the targeted sentiment detection job ended.
+    #   @return [Time]
+    #
+    # @!attribute [rw] input_data_config
+    #   The input properties for an inference job.
+    #   @return [Types::InputDataConfig]
+    #
+    # @!attribute [rw] output_data_config
+    #   Provides configuration parameters for the output of inference jobs.
+    #   @return [Types::OutputDataConfig]
+    #
+    # @!attribute [rw] language_code
+    #   The language code of the input documents.
+    #   @return [String]
+    #
+    # @!attribute [rw] data_access_role_arn
+    #   The Amazon Resource Name (ARN) that gives Amazon Comprehend read
+    #   access to your input data.
+    #   @return [String]
+    #
+    # @!attribute [rw] volume_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon
+    #   Comprehend uses to encrypt data on the storage volume attached to
+    #   the ML compute instance(s) that process the targeted sentiment
+    #   detection job. The VolumeKmsKeyId can be either of the following
+    #   formats:
+    #
+    #   * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
+    #
+    #   * Amazon Resource Name (ARN) of a KMS Key:
+    #     `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
+    #   @return [String]
+    #
+    # @!attribute [rw] vpc_config
+    #   Configuration parameters for an optional private Virtual Private
+    #   Cloud (VPC) containing the resources you are using for the job. For
+    #   more information, see [Amazon VPC][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
+    #   @return [Types::VpcConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentDetectionJobProperties AWS API Documentation
+    #
+    class TargetedSentimentDetectionJobProperties < Struct.new(
+      :job_id,
+      :job_arn,
+      :job_name,
+      :job_status,
+      :message,
+      :submit_time,
+      :end_time,
+      :input_data_config,
+      :output_data_config,
+      :language_code,
+      :data_access_role_arn,
+      :volume_kms_key_id,
+      :vpc_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The size of the input text exceeds the limit. Use a smaller document.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-comprehend.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-comprehend/customizations'
 # @!group service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.58.0'
+  GEM_VERSION = '1.61.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.58.0
+  version: 1.61.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.126.0
+        version: 3.127.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.126.0
+        version: 3.127.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement