Class: Aws::Comprehend::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb

Overview

An API client for Comprehend. To construct a client, you need to configure a :region and :credentials.

client = Aws::Comprehend::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



358
359
360
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 358

def initialize(*args)
  super
end

Instance Method Details

#batch_detect_dominant_language(params = {}) ⇒ Types::BatchDetectDominantLanguageResponse

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_dominant_language({
  text_list: ["CustomerInputString"], # required
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].languages #=> Array
resp.result_list[0].languages[0].language_code #=> String
resp.result_list[0].languages[0].score #=> Float
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.

Returns:

See Also:



405
406
407
408
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 405

def batch_detect_dominant_language(params = {}, options = {})
  req = build_request(:batch_detect_dominant_language, params)
  req.send_request(options)
end

#batch_detect_entities(params = {}) ⇒ Types::BatchDetectEntitiesResponse

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_entities({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].entities #=> Array
resp.result_list[0].entities[0].score #=> Float
resp.result_list[0].entities[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "COMMERCIAL_ITEM", "EVENT", "DATE", "QUANTITY", "TITLE", "OTHER"
resp.result_list[0].entities[0].text #=> String
resp.result_list[0].entities[0].begin_offset #=> Integer
resp.result_list[0].entities[0].end_offset #=> Integer
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

See Also:



459
460
461
462
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 459

def batch_detect_entities(params = {}, options = {})
  req = build_request(:batch_detect_entities, params)
  req.send_request(options)
end

#batch_detect_key_phrases(params = {}) ⇒ Types::BatchDetectKeyPhrasesResponse

Detects the key noun phrases found in a batch of documents.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_key_phrases({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].key_phrases #=> Array
resp.result_list[0].key_phrases[0].score #=> Float
resp.result_list[0].key_phrases[0].text #=> String
resp.result_list[0].key_phrases[0].begin_offset #=> Integer
resp.result_list[0].key_phrases[0].end_offset #=> Integer
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

See Also:



506
507
508
509
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 506

def batch_detect_key_phrases(params = {}, options = {})
  req = build_request(:batch_detect_key_phrases, params)
  req.send_request(options)
end

#batch_detect_sentiment(params = {}) ⇒ Types::BatchDetectSentimentResponse

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_sentiment({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.result_list[0].sentiment_score.positive #=> Float
resp.result_list[0].sentiment_score.negative #=> Float
resp.result_list[0].sentiment_score.neutral #=> Float
resp.result_list[0].sentiment_score.mixed #=> Float
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

See Also:



561
562
563
564
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 561

def batch_detect_sentiment(params = {}, options = {})
  req = build_request(:batch_detect_sentiment, params)
  req.send_request(options)
end

#batch_detect_syntax(params = {}) ⇒ Types::BatchDetectSyntaxResponse

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_syntax({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].syntax_tokens #=> Array
resp.result_list[0].syntax_tokens[0].token_id #=> Integer
resp.result_list[0].syntax_tokens[0].text #=> String
resp.result_list[0].syntax_tokens[0].begin_offset #=> Integer
resp.result_list[0].syntax_tokens[0].end_offset #=> Integer
resp.result_list[0].syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "CCONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
resp.result_list[0].syntax_tokens[0].part_of_speech.score #=> Float
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Returns:

See Also:



618
619
620
621
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 618

def batch_detect_syntax(params = {}, options = {})
  req = build_request(:batch_detect_syntax, params)
  req.send_request(options)
end

#batch_detect_targeted_sentiment(params = {}) ⇒ Types::BatchDetectTargetedSentimentResponse

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

For more information about targeted sentiment, see Targeted sentiment.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_targeted_sentiment({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].entities #=> Array
resp.result_list[0].entities[0].descriptive_mention_index #=> Array
resp.result_list[0].entities[0].descriptive_mention_index[0] #=> Integer
resp.result_list[0].entities[0].mentions #=> Array
resp.result_list[0].entities[0].mentions[0].score #=> Float
resp.result_list[0].entities[0].mentions[0].group_score #=> Float
resp.result_list[0].entities[0].mentions[0].text #=> String
resp.result_list[0].entities[0].mentions[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "FACILITY", "BRAND", "COMMERCIAL_ITEM", "MOVIE", "MUSIC", "BOOK", "SOFTWARE", "GAME", "PERSONAL_TITLE", "EVENT", "DATE", "QUANTITY", "ATTRIBUTE", "OTHER"
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.positive #=> Float
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.negative #=> Float
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.neutral #=> Float
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.mixed #=> Float
resp.result_list[0].entities[0].mentions[0].begin_offset #=> Integer
resp.result_list[0].entities[0].mentions[0].end_offset #=> Integer
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

  • :language_code (required, String)

    The language of the input documents. Currently, English is the only supported language.

Returns:

See Also:



682
683
684
685
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 682

def batch_detect_targeted_sentiment(params = {}, options = {})
  req = build_request(:batch_detect_targeted_sentiment, params)
  req.send_request(options)
end

#classify_document(params = {}) ⇒ Types::ClassifyDocumentResponse

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

Examples:

Request syntax with placeholder values


resp = client.classify_document({
  text: "CustomerInputString", # required
  endpoint_arn: "DocumentClassifierEndpointArn", # required
})

Response structure


resp.classes #=> Array
resp.classes[0].name #=> String
resp.classes[0].score #=> Float
resp.labels #=> Array
resp.labels[0].name #=> String
resp.labels[0].score #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    The document text to be analyzed.

  • :endpoint_arn (required, String)

    The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.

Returns:

See Also:



727
728
729
730
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 727

def classify_document(params = {}, options = {})
  req = build_request(:classify_document, params)
  req.send_request(options)
end

#contains_pii_entities(params = {}) ⇒ Types::ContainsPiiEntitiesResponse

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

Examples:

Request syntax with placeholder values


resp = client.contains_pii_entities({
  text: "String", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.labels #=> Array
resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.labels[0].score #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The maximum string size is 100 KB.

  • :language_code (required, String)

    The language of the input documents. Currently, English is the only valid language.

Returns:

See Also:



764
765
766
767
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 764

def contains_pii_entities(params = {}, options = {})
  req = build_request(:contains_pii_entities, params)
  req.send_request(options)
end

#create_document_classifier(params = {}) ⇒ Types::CreateDocumentClassifierResponse

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_document_classifier({
  document_classifier_name: "ComprehendArnName", # required
  version_name: "VersionName",
  data_access_role_arn: "IamRoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  input_data_config: { # required
    data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
    s3_uri: "S3Uri",
    test_s3_uri: "S3Uri",
    label_delimiter: "LabelDelimiter",
    augmented_manifests: [
      {
        s3_uri: "S3Uri", # required
        split: "TRAIN", # accepts TRAIN, TEST
        attribute_names: ["AttributeNamesListItem"], # required
        annotation_data_s3_uri: "S3Uri",
        source_documents_s3_uri: "S3Uri",
        document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
      },
    ],
  },
  output_data_config: {
    s3_uri: "S3Uri",
    kms_key_id: "KmsKeyId",
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
  model_kms_key_id: "KmsKeyId",
  model_policy: "Policy",
})

Response structure


resp.document_classifier_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_name (required, String)

    The name of the document classifier.

  • :version_name (String)

    The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a 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.

  • :input_data_config (required, Types::DocumentClassifierInputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (Types::DocumentClassifierOutputDataConfig)

    Enables the addition of output results configuration parameters for custom classifier jobs.

  • :client_request_token (String)

    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.**

  • :language_code (required, String)

    The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

  • :mode (String)

    Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

  • :model_kms_key_id (String)

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

  • :model_policy (String)

    The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

    Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

    "\{"attribute": "value", "attribute": ["value"]\}"

    To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

    '\{"attribute": "value", "attribute": ["value"]\}'

Returns:

See Also:



933
934
935
936
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 933

def create_document_classifier(params = {}, options = {})
  req = build_request(:create_document_classifier, params)
  req.send_request(options)
end

#create_endpoint(params = {}) ⇒ Types::CreateEndpointResponse

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

Examples:

Request syntax with placeholder values


resp = client.create_endpoint({
  endpoint_name: "ComprehendEndpointName", # required
  model_arn: "ComprehendModelArn", # required
  desired_inference_units: 1, # required
  client_request_token: "ClientRequestTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  data_access_role_arn: "IamRoleArn",
})

Response structure


resp.endpoint_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_name (required, String)

    This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

  • :model_arn (required, String)

    The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.

  • :desired_inference_units (required, Integer)

    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

  • :client_request_token (String)

    An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>)

    Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

  • :data_access_role_arn (String)

    The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

Returns:

See Also:



1007
1008
1009
1010
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1007

def create_endpoint(params = {}, options = {})
  req = build_request(:create_endpoint, params)
  req.send_request(options)
end

#create_entity_recognizer(params = {}) ⇒ Types::CreateEntityRecognizerResponse

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

Examples:

Request syntax with placeholder values


resp = client.create_entity_recognizer({
  recognizer_name: "ComprehendArnName", # required
  version_name: "VersionName",
  data_access_role_arn: "IamRoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  input_data_config: { # required
    data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
    entity_types: [ # required
      {
        type: "EntityTypeName", # required
      },
    ],
    documents: {
      s3_uri: "S3Uri", # required
      test_s3_uri: "S3Uri",
      input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    },
    annotations: {
      s3_uri: "S3Uri", # required
      test_s3_uri: "S3Uri",
    },
    entity_list: {
      s3_uri: "S3Uri", # required
    },
    augmented_manifests: [
      {
        s3_uri: "S3Uri", # required
        split: "TRAIN", # accepts TRAIN, TEST
        attribute_names: ["AttributeNamesListItem"], # required
        annotation_data_s3_uri: "S3Uri",
        source_documents_s3_uri: "S3Uri",
        document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
      },
    ],
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  model_kms_key_id: "KmsKeyId",
  model_policy: "Policy",
})

Response structure


resp.entity_recognizer_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recognizer_name (required, String)

    The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

  • :version_name (String)

    The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a 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.

  • :input_data_config (required, Types::EntityRecognizerInputDataConfig)

    Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

  • :client_request_token (String)

    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.**

  • :language_code (required, String)

    You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

  • :model_kms_key_id (String)

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

  • :model_policy (String)

    The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model.

    Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

    "\{"attribute": "value", "attribute": ["value"]\}"

    To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

    '\{"attribute": "value", "attribute": ["value"]\}'

Returns:

See Also:



1171
1172
1173
1174
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1171

def create_entity_recognizer(params = {}, options = {})
  req = build_request(:create_entity_recognizer, params)
  req.send_request(options)
end

#delete_document_classifier(params = {}) ⇒ Struct

Deletes a previously created document classifier

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.

Examples:

Request syntax with placeholder values


resp = client.delete_document_classifier({
  document_classifier_arn: "DocumentClassifierArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_arn (required, String)

    The Amazon Resource Name (ARN) that identifies the document classifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1203
1204
1205
1206
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1203

def delete_document_classifier(params = {}, options = {})
  req = build_request(:delete_document_classifier, params)
  req.send_request(options)
end

#delete_endpoint(params = {}) ⇒ Struct

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint({
  endpoint_arn: "ComprehendEndpointArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_arn (required, String)

    The Amazon Resource Number (ARN) of the endpoint being deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1231
1232
1233
1234
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1231

def delete_endpoint(params = {}, options = {})
  req = build_request(:delete_endpoint, params)
  req.send_request(options)
end

#delete_entity_recognizer(params = {}) ⇒ Struct

Deletes an entity recognizer.

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

Examples:

Request syntax with placeholder values


resp = client.delete_entity_recognizer({
  entity_recognizer_arn: "EntityRecognizerArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entity_recognizer_arn (required, String)

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1262
1263
1264
1265
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1262

def delete_entity_recognizer(params = {}, options = {})
  req = build_request(:delete_entity_recognizer, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource-based policy that is attached to a custom model.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ComprehendModelArn", # required
  policy_revision_id: "PolicyRevisionId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.

  • :policy_revision_id (String)

    The revision ID of the policy to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1289
1290
1291
1292
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1289

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#describe_document_classification_job(params = {}) ⇒ Types::DescribeDocumentClassificationJobResponse

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

Examples:

Request syntax with placeholder values


resp = client.describe_document_classification_job({
  job_id: "JobId", # required
})

Response structure


resp.document_classification_job_properties.job_id #=> String
resp.document_classification_job_properties.job_arn #=> String
resp.document_classification_job_properties.job_name #=> String
resp.document_classification_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.document_classification_job_properties.message #=> String
resp.document_classification_job_properties.submit_time #=> Time
resp.document_classification_job_properties.end_time #=> Time
resp.document_classification_job_properties.document_classifier_arn #=> String
resp.document_classification_job_properties.input_data_config.s3_uri #=> String
resp.document_classification_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.document_classification_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.document_classification_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.document_classification_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.document_classification_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.document_classification_job_properties.output_data_config.s3_uri #=> String
resp.document_classification_job_properties.output_data_config.kms_key_id #=> String
resp.document_classification_job_properties.data_access_role_arn #=> String
resp.document_classification_job_properties.volume_kms_key_id #=> String
resp.document_classification_job_properties.vpc_config.security_group_ids #=> Array
resp.document_classification_job_properties.vpc_config.security_group_ids[0] #=> String
resp.document_classification_job_properties.vpc_config.subnets #=> Array
resp.document_classification_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1340
1341
1342
1343
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1340

def describe_document_classification_job(params = {}, options = {})
  req = build_request(:describe_document_classification_job, params)
  req.send_request(options)
end

#describe_document_classifier(params = {}) ⇒ Types::DescribeDocumentClassifierResponse

Gets the properties associated with a document classifier.

Examples:

Request syntax with placeholder values


resp = client.describe_document_classifier({
  document_classifier_arn: "DocumentClassifierArn", # required
})

Response structure


resp.document_classifier_properties.document_classifier_arn #=> String
resp.document_classifier_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
resp.document_classifier_properties.message #=> String
resp.document_classifier_properties.submit_time #=> Time
resp.document_classifier_properties.end_time #=> Time
resp.document_classifier_properties.training_start_time #=> Time
resp.document_classifier_properties.training_end_time #=> Time
resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.document_classifier_properties.input_data_config.s3_uri #=> String
resp.document_classifier_properties.input_data_config.test_s3_uri #=> String
resp.document_classifier_properties.input_data_config.label_delimiter #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.document_classifier_properties.output_data_config.s3_uri #=> String
resp.document_classifier_properties.output_data_config.kms_key_id #=> String
resp.document_classifier_properties..number_of_labels #=> Integer
resp.document_classifier_properties..number_of_trained_documents #=> Integer
resp.document_classifier_properties..number_of_test_documents #=> Integer
resp.document_classifier_properties..evaluation_metrics.accuracy #=> Float
resp.document_classifier_properties..evaluation_metrics.precision #=> Float
resp.document_classifier_properties..evaluation_metrics.recall #=> Float
resp.document_classifier_properties..evaluation_metrics.f1_score #=> Float
resp.document_classifier_properties..evaluation_metrics.micro_precision #=> Float
resp.document_classifier_properties..evaluation_metrics.micro_recall #=> Float
resp.document_classifier_properties..evaluation_metrics.micro_f1_score #=> Float
resp.document_classifier_properties..evaluation_metrics.hamming_loss #=> Float
resp.document_classifier_properties.data_access_role_arn #=> String
resp.document_classifier_properties.volume_kms_key_id #=> String
resp.document_classifier_properties.vpc_config.security_group_ids #=> Array
resp.document_classifier_properties.vpc_config.security_group_ids[0] #=> String
resp.document_classifier_properties.vpc_config.subnets #=> Array
resp.document_classifier_properties.vpc_config.subnets[0] #=> String
resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
resp.document_classifier_properties.model_kms_key_id #=> String
resp.document_classifier_properties.version_name #=> String
resp.document_classifier_properties.source_model_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_arn (required, String)

    The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.

Returns:

See Also:



1411
1412
1413
1414
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1411

def describe_document_classifier(params = {}, options = {})
  req = build_request(:describe_document_classifier, params)
  req.send_request(options)
end

#describe_dominant_language_detection_job(params = {}) ⇒ Types::DescribeDominantLanguageDetectionJobResponse

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_dominant_language_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.dominant_language_detection_job_properties.job_id #=> String
resp.dominant_language_detection_job_properties.job_arn #=> String
resp.dominant_language_detection_job_properties.job_name #=> String
resp.dominant_language_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.dominant_language_detection_job_properties.message #=> String
resp.dominant_language_detection_job_properties.submit_time #=> Time
resp.dominant_language_detection_job_properties.end_time #=> Time
resp.dominant_language_detection_job_properties.input_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.dominant_language_detection_job_properties.output_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties.output_data_config.kms_key_id #=> String
resp.dominant_language_detection_job_properties.data_access_role_arn #=> String
resp.dominant_language_detection_job_properties.volume_kms_key_id #=> String
resp.dominant_language_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.dominant_language_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.dominant_language_detection_job_properties.vpc_config.subnets #=> Array
resp.dominant_language_detection_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1461
1462
1463
1464
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1461

def describe_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:describe_dominant_language_detection_job, params)
  req.send_request(options)
end

#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint({
  endpoint_arn: "ComprehendEndpointArn", # required
})

Response structure


resp.endpoint_properties.endpoint_arn #=> String
resp.endpoint_properties.status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
resp.endpoint_properties.message #=> String
resp.endpoint_properties.model_arn #=> String
resp.endpoint_properties.desired_model_arn #=> String
resp.endpoint_properties.desired_inference_units #=> Integer
resp.endpoint_properties.current_inference_units #=> Integer
resp.endpoint_properties.creation_time #=> Time
resp.endpoint_properties.last_modified_time #=> Time
resp.endpoint_properties.data_access_role_arn #=> String
resp.endpoint_properties.desired_data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_arn (required, String)

    The Amazon Resource Number (ARN) of the endpoint being described.

Returns:

See Also:



1505
1506
1507
1508
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1505

def describe_endpoint(params = {}, options = {})
  req = build_request(:describe_endpoint, params)
  req.send_request(options)
end

#describe_entities_detection_job(params = {}) ⇒ Types::DescribeEntitiesDetectionJobResponse

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.entities_detection_job_properties.job_id #=> String
resp.entities_detection_job_properties.job_arn #=> String
resp.entities_detection_job_properties.job_name #=> String
resp.entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.entities_detection_job_properties.message #=> String
resp.entities_detection_job_properties.submit_time #=> Time
resp.entities_detection_job_properties.end_time #=> Time
resp.entities_detection_job_properties.entity_recognizer_arn #=> String
resp.entities_detection_job_properties.input_data_config.s3_uri #=> String
resp.entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entities_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.entities_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.entities_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.entities_detection_job_properties.output_data_config.s3_uri #=> String
resp.entities_detection_job_properties.output_data_config.kms_key_id #=> String
resp.entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entities_detection_job_properties.data_access_role_arn #=> String
resp.entities_detection_job_properties.volume_kms_key_id #=> String
resp.entities_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.entities_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.entities_detection_job_properties.vpc_config.subnets #=> Array
resp.entities_detection_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1557
1558
1559
1560
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1557

def describe_entities_detection_job(params = {}, options = {})
  req = build_request(:describe_entities_detection_job, params)
  req.send_request(options)
end

#describe_entity_recognizer(params = {}) ⇒ Types::DescribeEntityRecognizerResponse

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Examples:

Request syntax with placeholder values


resp = client.describe_entity_recognizer({
  entity_recognizer_arn: "EntityRecognizerArn", # required
})

Response structure


resp.entity_recognizer_properties.entity_recognizer_arn #=> String
resp.entity_recognizer_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
resp.entity_recognizer_properties.message #=> String
resp.entity_recognizer_properties.submit_time #=> Time
resp.entity_recognizer_properties.end_time #=> Time
resp.entity_recognizer_properties.training_start_time #=> Time
resp.entity_recognizer_properties.training_end_time #=> Time
resp.entity_recognizer_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.documents.test_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.annotations.test_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.entity_recognizer_properties..number_of_trained_documents #=> Integer
resp.entity_recognizer_properties..number_of_test_documents #=> Integer
resp.entity_recognizer_properties..evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties..evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties..evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties..entity_types #=> Array
resp.entity_recognizer_properties..entity_types[0].type #=> String
resp.entity_recognizer_properties..entity_types[0].evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties..entity_types[0].evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties..entity_types[0].evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties..entity_types[0].number_of_train_mentions #=> Integer
resp.entity_recognizer_properties.data_access_role_arn #=> String
resp.entity_recognizer_properties.volume_kms_key_id #=> String
resp.entity_recognizer_properties.vpc_config.security_group_ids #=> Array
resp.entity_recognizer_properties.vpc_config.security_group_ids[0] #=> String
resp.entity_recognizer_properties.vpc_config.subnets #=> Array
resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
resp.entity_recognizer_properties.model_kms_key_id #=> String
resp.entity_recognizer_properties.version_name #=> String
resp.entity_recognizer_properties.source_model_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entity_recognizer_arn (required, String)

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

Returns:

See Also:



1631
1632
1633
1634
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1631

def describe_entity_recognizer(params = {}, options = {})
  req = build_request(:describe_entity_recognizer, params)
  req.send_request(options)
end

#describe_events_detection_job(params = {}) ⇒ Types::DescribeEventsDetectionJobResponse

Gets the status and details of an events detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_events_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.events_detection_job_properties.job_id #=> String
resp.events_detection_job_properties.job_arn #=> String
resp.events_detection_job_properties.job_name #=> String
resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.events_detection_job_properties.message #=> String
resp.events_detection_job_properties.submit_time #=> Time
resp.events_detection_job_properties.end_time #=> Time
resp.events_detection_job_properties.input_data_config.s3_uri #=> String
resp.events_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.events_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.events_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.events_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.events_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.events_detection_job_properties.output_data_config.s3_uri #=> String
resp.events_detection_job_properties.output_data_config.kms_key_id #=> String
resp.events_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.events_detection_job_properties.data_access_role_arn #=> String
resp.events_detection_job_properties.target_event_types #=> Array
resp.events_detection_job_properties.target_event_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the events detection job.

Returns:

See Also:



1677
1678
1679
1680
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1677

def describe_events_detection_job(params = {}, options = {})
  req = build_request(:describe_events_detection_job, params)
  req.send_request(options)
end

#describe_key_phrases_detection_job(params = {}) ⇒ Types::DescribeKeyPhrasesDetectionJobResponse

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_key_phrases_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.key_phrases_detection_job_properties.job_id #=> String
resp.key_phrases_detection_job_properties.job_arn #=> String
resp.key_phrases_detection_job_properties.job_name #=> String
resp.key_phrases_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.key_phrases_detection_job_properties.message #=> String
resp.key_phrases_detection_job_properties.submit_time #=> Time
resp.key_phrases_detection_job_properties.end_time #=> Time
resp.key_phrases_detection_job_properties.input_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.key_phrases_detection_job_properties.output_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties.output_data_config.kms_key_id #=> String
resp.key_phrases_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.key_phrases_detection_job_properties.data_access_role_arn #=> String
resp.key_phrases_detection_job_properties.volume_kms_key_id #=> String
resp.key_phrases_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.key_phrases_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.key_phrases_detection_job_properties.vpc_config.subnets #=> Array
resp.key_phrases_detection_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1728
1729
1730
1731
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1728

def describe_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:describe_key_phrases_detection_job, params)
  req.send_request(options)
end

#describe_pii_entities_detection_job(params = {}) ⇒ Types::DescribePiiEntitiesDetectionJobResponse

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

Examples:

Request syntax with placeholder values


resp = client.describe_pii_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.pii_entities_detection_job_properties.job_id #=> String
resp.pii_entities_detection_job_properties.job_arn #=> String
resp.pii_entities_detection_job_properties.job_name #=> String
resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.pii_entities_detection_job_properties.message #=> String
resp.pii_entities_detection_job_properties.submit_time #=> Time
resp.pii_entities_detection_job_properties.end_time #=> Time
resp.pii_entities_detection_job_properties.input_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.pii_entities_detection_job_properties.data_access_role_arn #=> String
resp.pii_entities_detection_job_properties.mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1779
1780
1781
1782
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1779

def describe_pii_entities_detection_job(params = {}, options = {})
  req = build_request(:describe_pii_entities_detection_job, params)
  req.send_request(options)
end

#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_policy({
  resource_arn: "ComprehendModelArn", # required
})

Response structure


resp.resource_policy #=> String
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.policy_revision_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the policy to describe.

Returns:

See Also:



1814
1815
1816
1817
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1814

def describe_resource_policy(params = {}, options = {})
  req = build_request(:describe_resource_policy, params)
  req.send_request(options)
end

#describe_sentiment_detection_job(params = {}) ⇒ Types::DescribeSentimentDetectionJobResponse

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.sentiment_detection_job_properties.job_id #=> String
resp.sentiment_detection_job_properties.job_arn #=> String
resp.sentiment_detection_job_properties.job_name #=> String
resp.sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.sentiment_detection_job_properties.message #=> String
resp.sentiment_detection_job_properties.submit_time #=> Time
resp.sentiment_detection_job_properties.end_time #=> Time
resp.sentiment_detection_job_properties.input_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.sentiment_detection_job_properties.output_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
resp.sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.sentiment_detection_job_properties.data_access_role_arn #=> String
resp.sentiment_detection_job_properties.volume_kms_key_id #=> String
resp.sentiment_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.sentiment_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.sentiment_detection_job_properties.vpc_config.subnets #=> Array
resp.sentiment_detection_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1865
1866
1867
1868
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1865

def describe_sentiment_detection_job(params = {}, options = {})
  req = build_request(:describe_sentiment_detection_job, params)
  req.send_request(options)
end

#describe_targeted_sentiment_detection_job(params = {}) ⇒ Types::DescribeTargetedSentimentDetectionJobResponse

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

Examples:

Request syntax with placeholder values


resp = client.describe_targeted_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.targeted_sentiment_detection_job_properties.job_id #=> String
resp.targeted_sentiment_detection_job_properties.job_arn #=> String
resp.targeted_sentiment_detection_job_properties.job_name #=> String
resp.targeted_sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.targeted_sentiment_detection_job_properties.message #=> String
resp.targeted_sentiment_detection_job_properties.submit_time #=> Time
resp.targeted_sentiment_detection_job_properties.end_time #=> Time
resp.targeted_sentiment_detection_job_properties.input_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
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"
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.targeted_sentiment_detection_job_properties.output_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.targeted_sentiment_detection_job_properties.data_access_role_arn #=> String
resp.targeted_sentiment_detection_job_properties.volume_kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.targeted_sentiment_detection_job_properties.vpc_config.subnets #=> Array
resp.targeted_sentiment_detection_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Returns:

See Also:



1916
1917
1918
1919
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1916

def describe_targeted_sentiment_detection_job(params = {}, options = {})
  req = build_request(:describe_targeted_sentiment_detection_job, params)
  req.send_request(options)
end

#describe_topics_detection_job(params = {}) ⇒ Types::DescribeTopicsDetectionJobResponse

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_topics_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.topics_detection_job_properties.job_id #=> String
resp.topics_detection_job_properties.job_arn #=> String
resp.topics_detection_job_properties.job_name #=> String
resp.topics_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.topics_detection_job_properties.message #=> String
resp.topics_detection_job_properties.submit_time #=> Time
resp.topics_detection_job_properties.end_time #=> Time
resp.topics_detection_job_properties.input_data_config.s3_uri #=> String
resp.topics_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.topics_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.topics_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.topics_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.topics_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.topics_detection_job_properties.output_data_config.s3_uri #=> String
resp.topics_detection_job_properties.output_data_config.kms_key_id #=> String
resp.topics_detection_job_properties.number_of_topics #=> Integer
resp.topics_detection_job_properties.data_access_role_arn #=> String
resp.topics_detection_job_properties.volume_kms_key_id #=> String
resp.topics_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.topics_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.topics_detection_job_properties.vpc_config.subnets #=> Array
resp.topics_detection_job_properties.vpc_config.subnets[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier assigned by the user to the detection job.

Returns:

See Also:



1966
1967
1968
1969
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1966

def describe_topics_detection_job(params = {}, options = {})
  req = build_request(:describe_topics_detection_job, params)
  req.send_request(options)
end

#detect_dominant_language(params = {}) ⇒ Types::DetectDominantLanguageResponse

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Examples:

Request syntax with placeholder values


resp = client.detect_dominant_language({
  text: "CustomerInputString", # required
})

Response structure


resp.languages #=> Array
resp.languages[0].language_code #=> String
resp.languages[0].score #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.

Returns:

See Also:



2003
2004
2005
2006
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2003

def detect_dominant_language(params = {}, options = {})
  req = build_request(:detect_dominant_language, params)
  req.send_request(options)
end

#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse

Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.detect_entities({
  text: "CustomerInputString", # required
  language_code: "en", # accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  endpoint_arn: "EntityRecognizerEndpointArn",
})

Response structure


resp.entities #=> Array
resp.entities[0].score #=> Float
resp.entities[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "COMMERCIAL_ITEM", "EVENT", "DATE", "QUANTITY", "TITLE", "OTHER"
resp.entities[0].text #=> String
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The maximum string size is 100 KB.

  • :language_code (String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

  • :endpoint_arn (String)

    The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon 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.

Returns:

See Also:



2069
2070
2071
2072
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2069

def detect_entities(params = {}, options = {})
  req = build_request(:detect_entities, params)
  req.send_request(options)
end

#detect_key_phrases(params = {}) ⇒ Types::DetectKeyPhrasesResponse

Detects the key noun phrases found in the text.

Examples:

Request syntax with placeholder values


resp = client.detect_key_phrases({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.key_phrases #=> Array
resp.key_phrases[0].score #=> Float
resp.key_phrases[0].text #=> String
resp.key_phrases[0].begin_offset #=> Integer
resp.key_phrases[0].end_offset #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

See Also:



2108
2109
2110
2111
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2108

def detect_key_phrases(params = {}, options = {})
  req = build_request(:detect_key_phrases, params)
  req.send_request(options)
end

#detect_pii_entities(params = {}) ⇒ Types::DetectPiiEntitiesResponse

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Examples:

Request syntax with placeholder values


resp = client.detect_pii_entities({
  text: "String", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.entities #=> Array
resp.entities[0].score #=> Float
resp.entities[0].type #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The maximum string size is 100 KB.

  • :language_code (required, String)

    The language of the input documents. Currently, English is the only valid language.

Returns:

See Also:



2146
2147
2148
2149
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2146

def detect_pii_entities(params = {}, options = {})
  req = build_request(:detect_pii_entities, params)
  req.send_request(options)
end

#detect_sentiment(params = {}) ⇒ Types::DetectSentimentResponse

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Examples:

Request syntax with placeholder values


resp = client.detect_sentiment({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.sentiment_score.positive #=> Float
resp.sentiment_score.negative #=> Float
resp.sentiment_score.neutral #=> Float
resp.sentiment_score.mixed #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The maximum string size is 5 KB.

    Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

See Also:



2192
2193
2194
2195
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2192

def detect_sentiment(params = {}, options = {})
  req = build_request(:detect_sentiment, params)
  req.send_request(options)
end

#detect_syntax(params = {}) ⇒ Types::DetectSyntaxResponse

Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.detect_syntax({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

Response structure


resp.syntax_tokens #=> Array
resp.syntax_tokens[0].token_id #=> Integer
resp.syntax_tokens[0].text #=> String
resp.syntax_tokens[0].begin_offset #=> Integer
resp.syntax_tokens[0].end_offset #=> Integer
resp.syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "CCONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
resp.syntax_tokens[0].part_of_speech.score #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 string. The maximum string size is 5 KB.

  • :language_code (required, String)

    The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").

Returns:

See Also:



2239
2240
2241
2242
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2239

def detect_syntax(params = {}, options = {})
  req = build_request(:detect_syntax, params)
  req.send_request(options)
end

#detect_targeted_sentiment(params = {}) ⇒ Types::DetectTargetedSentimentResponse

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

For more information about targeted sentiment, see Targeted sentiment.

Examples:

Request syntax with placeholder values


resp = client.detect_targeted_sentiment({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.entities #=> Array
resp.entities[0].descriptive_mention_index #=> Array
resp.entities[0].descriptive_mention_index[0] #=> Integer
resp.entities[0].mentions #=> Array
resp.entities[0].mentions[0].score #=> Float
resp.entities[0].mentions[0].group_score #=> Float
resp.entities[0].mentions[0].text #=> String
resp.entities[0].mentions[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "FACILITY", "BRAND", "COMMERCIAL_ITEM", "MOVIE", "MUSIC", "BOOK", "SOFTWARE", "GAME", "PERSONAL_TITLE", "EVENT", "DATE", "QUANTITY", "ATTRIBUTE", "OTHER"
resp.entities[0].mentions[0].mention_sentiment.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.positive #=> Float
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.negative #=> Float
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.neutral #=> Float
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.mixed #=> Float
resp.entities[0].mentions[0].begin_offset #=> Integer
resp.entities[0].mentions[0].end_offset #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. The maximum string length is 5 KB.

  • :language_code (required, String)

    The language of the input documents. Currently, English is the only supported language.

Returns:

See Also:



2294
2295
2296
2297
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2294

def detect_targeted_sentiment(params = {}, options = {})
  req = build_request(:detect_targeted_sentiment, params)
  req.send_request(options)
end

#import_model(params = {}) ⇒ Types::ImportModelResponse

Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.

If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.

The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.

Examples:

Request syntax with placeholder values


resp = client.import_model({
  source_model_arn: "ComprehendModelArn", # required
  model_name: "ComprehendArnName",
  version_name: "VersionName",
  model_kms_key_id: "KmsKeyId",
  data_access_role_arn: "IamRoleArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.model_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :source_model_arn (required, String)

    The Amazon Resource Name (ARN) of the custom model to import.

  • :model_name (String)

    The name to assign to the custom model that is created in Amazon Comprehend by this import.

  • :version_name (String)

    The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

  • :model_kms_key_id (String)

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

  • :data_access_role_arn (String)

    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a 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.

Returns:

See Also:



2374
2375
2376
2377
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2374

def import_model(params = {}, options = {})
  req = build_request(:import_model, params)
  req.send_request(options)
end

#list_document_classification_jobs(params = {}) ⇒ Types::ListDocumentClassificationJobsResponse

Gets a list of the documentation classification jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_document_classification_jobs({
  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,
})

Response structure


resp.document_classification_job_properties_list #=> Array
resp.document_classification_job_properties_list[0].job_id #=> String
resp.document_classification_job_properties_list[0].job_arn #=> String
resp.document_classification_job_properties_list[0].job_name #=> String
resp.document_classification_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.document_classification_job_properties_list[0].message #=> String
resp.document_classification_job_properties_list[0].submit_time #=> Time
resp.document_classification_job_properties_list[0].end_time #=> Time
resp.document_classification_job_properties_list[0].document_classifier_arn #=> String
resp.document_classification_job_properties_list[0].input_data_config.s3_uri #=> String
resp.document_classification_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.document_classification_job_properties_list[0].output_data_config.s3_uri #=> String
resp.document_classification_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.document_classification_job_properties_list[0].data_access_role_arn #=> String
resp.document_classification_job_properties_list[0].volume_kms_key_id #=> String
resp.document_classification_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.document_classification_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.document_classification_job_properties_list[0].vpc_config.subnets #=> Array
resp.document_classification_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::DocumentClassificationJobFilter)

    Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



2445
2446
2447
2448
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2445

def list_document_classification_jobs(params = {}, options = {})
  req = build_request(:list_document_classification_jobs, params)
  req.send_request(options)
end

#list_document_classifier_summaries(params = {}) ⇒ Types::ListDocumentClassifierSummariesResponse

Gets a list of summaries of the document classifiers that you have created

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_document_classifier_summaries({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.document_classifier_summaries_list #=> Array
resp.document_classifier_summaries_list[0].document_classifier_name #=> String
resp.document_classifier_summaries_list[0].number_of_versions #=> Integer
resp.document_classifier_summaries_list[0].latest_version_created_at #=> Time
resp.document_classifier_summaries_list[0].latest_version_name #=> String
resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return on each page. The default is 100.

Returns:

See Also:



2488
2489
2490
2491
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2488

def list_document_classifier_summaries(params = {}, options = {})
  req = build_request(:list_document_classifier_summaries, params)
  req.send_request(options)
end

#list_document_classifiers(params = {}) ⇒ Types::ListDocumentClassifiersResponse

Gets a list of the document classifiers that you have created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_document_classifiers({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    document_classifier_name: "ComprehendArnName",
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.document_classifier_properties_list #=> Array
resp.document_classifier_properties_list[0].document_classifier_arn #=> String
resp.document_classifier_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
resp.document_classifier_properties_list[0].message #=> String
resp.document_classifier_properties_list[0].submit_time #=> Time
resp.document_classifier_properties_list[0].end_time #=> Time
resp.document_classifier_properties_list[0].training_start_time #=> Time
resp.document_classifier_properties_list[0].training_end_time #=> Time
resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.test_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
resp.document_classifier_properties_list[0]..number_of_labels #=> Integer
resp.document_classifier_properties_list[0]..number_of_trained_documents #=> Integer
resp.document_classifier_properties_list[0]..number_of_test_documents #=> Integer
resp.document_classifier_properties_list[0]..evaluation_metrics.accuracy #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.precision #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.recall #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.f1_score #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.micro_precision #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.micro_recall #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.micro_f1_score #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.hamming_loss #=> Float
resp.document_classifier_properties_list[0].data_access_role_arn #=> String
resp.document_classifier_properties_list[0].volume_kms_key_id #=> String
resp.document_classifier_properties_list[0].vpc_config.security_group_ids #=> Array
resp.document_classifier_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
resp.document_classifier_properties_list[0].model_kms_key_id #=> String
resp.document_classifier_properties_list[0].version_name #=> String
resp.document_classifier_properties_list[0].source_model_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::DocumentClassifierFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



2579
2580
2581
2582
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2579

def list_document_classifiers(params = {}, options = {})
  req = build_request(:list_document_classifiers, params)
  req.send_request(options)
end

#list_dominant_language_detection_jobs(params = {}) ⇒ Types::ListDominantLanguageDetectionJobsResponse

Gets a list of the dominant language detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dominant_language_detection_jobs({
  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,
})

Response structure


resp.dominant_language_detection_job_properties_list #=> Array
resp.dominant_language_detection_job_properties_list[0].job_id #=> String
resp.dominant_language_detection_job_properties_list[0].job_arn #=> String
resp.dominant_language_detection_job_properties_list[0].job_name #=> String
resp.dominant_language_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.dominant_language_detection_job_properties_list[0].message #=> String
resp.dominant_language_detection_job_properties_list[0].submit_time #=> Time
resp.dominant_language_detection_job_properties_list[0].end_time #=> Time
resp.dominant_language_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.dominant_language_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.dominant_language_detection_job_properties_list[0].data_access_role_arn #=> String
resp.dominant_language_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.dominant_language_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.dominant_language_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.dominant_language_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.dominant_language_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::DominantLanguageDetectionJobFilter)

    Filters that 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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



2649
2650
2651
2652
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2649

def list_dominant_language_detection_jobs(params = {}, options = {})
  req = build_request(:list_dominant_language_detection_jobs, params)
  req.send_request(options)
end

#list_endpoints(params = {}) ⇒ Types::ListEndpointsResponse

Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

Examples:

Request syntax with placeholder values


resp = client.list_endpoints({
  filter: {
    model_arn: "ComprehendModelArn",
    status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
    creation_time_before: Time.now,
    creation_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.endpoint_properties_list #=> Array
resp.endpoint_properties_list[0].endpoint_arn #=> String
resp.endpoint_properties_list[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
resp.endpoint_properties_list[0].message #=> String
resp.endpoint_properties_list[0].model_arn #=> String
resp.endpoint_properties_list[0].desired_model_arn #=> String
resp.endpoint_properties_list[0].desired_inference_units #=> Integer
resp.endpoint_properties_list[0].current_inference_units #=> Integer
resp.endpoint_properties_list[0].creation_time #=> Time
resp.endpoint_properties_list[0].last_modified_time #=> Time
resp.endpoint_properties_list[0].data_access_role_arn #=> String
resp.endpoint_properties_list[0].desired_data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::EndpointFilter)

    Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



2711
2712
2713
2714
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2711

def list_endpoints(params = {}, options = {})
  req = build_request(:list_endpoints, params)
  req.send_request(options)
end

#list_entities_detection_jobs(params = {}) ⇒ Types::ListEntitiesDetectionJobsResponse

Gets a list of the entity detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entities_detection_jobs({
  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,
})

Response structure


resp.entities_detection_job_properties_list #=> Array
resp.entities_detection_job_properties_list[0].job_id #=> String
resp.entities_detection_job_properties_list[0].job_arn #=> String
resp.entities_detection_job_properties_list[0].job_name #=> String
resp.entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.entities_detection_job_properties_list[0].message #=> String
resp.entities_detection_job_properties_list[0].submit_time #=> Time
resp.entities_detection_job_properties_list[0].end_time #=> Time
resp.entities_detection_job_properties_list[0].entity_recognizer_arn #=> String
resp.entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entities_detection_job_properties_list[0].data_access_role_arn #=> String
resp.entities_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.entities_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.entities_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.entities_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.entities_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::EntitiesDetectionJobFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



2782
2783
2784
2785
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2782

def list_entities_detection_jobs(params = {}, options = {})
  req = build_request(:list_entities_detection_jobs, params)
  req.send_request(options)
end

#list_entity_recognizer_summaries(params = {}) ⇒ Types::ListEntityRecognizerSummariesResponse

Gets a list of summaries for the entity recognizers that you have created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entity_recognizer_summaries({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.entity_recognizer_summaries_list #=> Array
resp.entity_recognizer_summaries_list[0].recognizer_name #=> String
resp.entity_recognizer_summaries_list[0].number_of_versions #=> Integer
resp.entity_recognizer_summaries_list[0].latest_version_created_at #=> Time
resp.entity_recognizer_summaries_list[0].latest_version_name #=> String
resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return on each page. The default is 100.

Returns:

See Also:



2825
2826
2827
2828
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2825

def list_entity_recognizer_summaries(params = {}, options = {})
  req = build_request(:list_entity_recognizer_summaries, params)
  req.send_request(options)
end

#list_entity_recognizers(params = {}) ⇒ Types::ListEntityRecognizersResponse

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entity_recognizers({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    recognizer_name: "ComprehendArnName",
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.entity_recognizer_properties_list #=> Array
resp.entity_recognizer_properties_list[0].entity_recognizer_arn #=> String
resp.entity_recognizer_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
resp.entity_recognizer_properties_list[0].message #=> String
resp.entity_recognizer_properties_list[0].submit_time #=> Time
resp.entity_recognizer_properties_list[0].end_time #=> Time
resp.entity_recognizer_properties_list[0].training_start_time #=> Time
resp.entity_recognizer_properties_list[0].training_end_time #=> Time
resp.entity_recognizer_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.documents.test_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.annotations.test_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.entity_recognizer_properties_list[0]..number_of_trained_documents #=> Integer
resp.entity_recognizer_properties_list[0]..number_of_test_documents #=> Integer
resp.entity_recognizer_properties_list[0]..evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties_list[0]..evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties_list[0]..evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties_list[0]..entity_types #=> Array
resp.entity_recognizer_properties_list[0]..entity_types[0].type #=> String
resp.entity_recognizer_properties_list[0]..entity_types[0].evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties_list[0]..entity_types[0].evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties_list[0]..entity_types[0].evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties_list[0]..entity_types[0].number_of_train_mentions #=> Integer
resp.entity_recognizer_properties_list[0].data_access_role_arn #=> String
resp.entity_recognizer_properties_list[0].volume_kms_key_id #=> String
resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids #=> Array
resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
resp.entity_recognizer_properties_list[0].version_name #=> String
resp.entity_recognizer_properties_list[0].source_model_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::EntityRecognizerFilter)

    Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return on each page. The default is 100.

Returns:

See Also:



2925
2926
2927
2928
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2925

def list_entity_recognizers(params = {}, options = {})
  req = build_request(:list_entity_recognizers, params)
  req.send_request(options)
end

#list_events_detection_jobs(params = {}) ⇒ Types::ListEventsDetectionJobsResponse

Gets a list of the events detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_events_detection_jobs({
  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,
})

Response structure


resp.events_detection_job_properties_list #=> Array
resp.events_detection_job_properties_list[0].job_id #=> String
resp.events_detection_job_properties_list[0].job_arn #=> String
resp.events_detection_job_properties_list[0].job_name #=> String
resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.events_detection_job_properties_list[0].message #=> String
resp.events_detection_job_properties_list[0].submit_time #=> Time
resp.events_detection_job_properties_list[0].end_time #=> Time
resp.events_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.events_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.events_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.events_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.events_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.events_detection_job_properties_list[0].data_access_role_arn #=> String
resp.events_detection_job_properties_list[0].target_event_types #=> Array
resp.events_detection_job_properties_list[0].target_event_types[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::EventsDetectionJobFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page.

Returns:

See Also:



2991
2992
2993
2994
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2991

def list_events_detection_jobs(params = {}, options = {})
  req = build_request(:list_events_detection_jobs, params)
  req.send_request(options)
end

#list_key_phrases_detection_jobs(params = {}) ⇒ Types::ListKeyPhrasesDetectionJobsResponse

Get a list of key phrase detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_key_phrases_detection_jobs({
  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,
})

Response structure


resp.key_phrases_detection_job_properties_list #=> Array
resp.key_phrases_detection_job_properties_list[0].job_id #=> String
resp.key_phrases_detection_job_properties_list[0].job_arn #=> String
resp.key_phrases_detection_job_properties_list[0].job_name #=> String
resp.key_phrases_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.key_phrases_detection_job_properties_list[0].message #=> String
resp.key_phrases_detection_job_properties_list[0].submit_time #=> Time
resp.key_phrases_detection_job_properties_list[0].end_time #=> Time
resp.key_phrases_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.key_phrases_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.key_phrases_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.key_phrases_detection_job_properties_list[0].data_access_role_arn #=> String
resp.key_phrases_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.key_phrases_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.key_phrases_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.key_phrases_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.key_phrases_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::KeyPhrasesDetectionJobFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



3061
3062
3063
3064
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3061

def list_key_phrases_detection_jobs(params = {}, options = {})
  req = build_request(:list_key_phrases_detection_jobs, params)
  req.send_request(options)
end

#list_pii_entities_detection_jobs(params = {}) ⇒ Types::ListPiiEntitiesDetectionJobsResponse

Gets a list of the PII entity detection jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_pii_entities_detection_jobs({
  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,
})

Response structure


resp.pii_entities_detection_job_properties_list #=> Array
resp.pii_entities_detection_job_properties_list[0].job_id #=> String
resp.pii_entities_detection_job_properties_list[0].job_arn #=> String
resp.pii_entities_detection_job_properties_list[0].job_name #=> String
resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.pii_entities_detection_job_properties_list[0].message #=> String
resp.pii_entities_detection_job_properties_list[0].submit_time #=> Time
resp.pii_entities_detection_job_properties_list[0].end_time #=> Time
resp.pii_entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
resp.pii_entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.pii_entities_detection_job_properties_list[0].data_access_role_arn #=> String
resp.pii_entities_detection_job_properties_list[0].mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::PiiEntitiesDetectionJobFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page.

Returns:

See Also:



3128
3129
3130
3131
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3128

def list_pii_entities_detection_jobs(params = {}, options = {})
  req = build_request(:list_pii_entities_detection_jobs, params)
  req.send_request(options)
end

#list_sentiment_detection_jobs(params = {}) ⇒ Types::ListSentimentDetectionJobsResponse

Gets a list of sentiment detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_sentiment_detection_jobs({
  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,
})

Response structure


resp.sentiment_detection_job_properties_list #=> Array
resp.sentiment_detection_job_properties_list[0].job_id #=> String
resp.sentiment_detection_job_properties_list[0].job_arn #=> String
resp.sentiment_detection_job_properties_list[0].job_name #=> String
resp.sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.sentiment_detection_job_properties_list[0].message #=> String
resp.sentiment_detection_job_properties_list[0].submit_time #=> Time
resp.sentiment_detection_job_properties_list[0].end_time #=> Time
resp.sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.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"
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
resp.sentiment_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.sentiment_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.sentiment_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.sentiment_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.sentiment_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::SentimentDetectionJobFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



3198
3199
3200
3201
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3198

def list_sentiment_detection_jobs(params = {}, options = {})
  req = build_request(:list_sentiment_detection_jobs, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a given Amazon Comprehend resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ComprehendArn", # required
})

Response structure


resp.resource_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

Returns:

See Also:



3231
3232
3233
3234
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3231

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_targeted_sentiment_detection_jobs(params = {}) ⇒ Types::ListTargetedSentimentDetectionJobsResponse

Gets a list of targeted sentiment detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_targeted_sentiment_detection_jobs({
  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,
})

Response structure


resp.targeted_sentiment_detection_job_properties_list #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].job_id #=> String
resp.targeted_sentiment_detection_job_properties_list[0].job_arn #=> String
resp.targeted_sentiment_detection_job_properties_list[0].job_name #=> String
resp.targeted_sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.targeted_sentiment_detection_job_properties_list[0].message #=> String
resp.targeted_sentiment_detection_job_properties_list[0].submit_time #=> Time
resp.targeted_sentiment_detection_job_properties_list[0].end_time #=> Time
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
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"
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"
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
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"
resp.targeted_sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
resp.targeted_sentiment_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::TargetedSentimentDetectionJobFilter)

    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.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



3302
3303
3304
3305
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3302

def list_targeted_sentiment_detection_jobs(params = {}, options = {})
  req = build_request(:list_targeted_sentiment_detection_jobs, params)
  req.send_request(options)
end

#list_topics_detection_jobs(params = {}) ⇒ Types::ListTopicsDetectionJobsResponse

Gets a list of the topic detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_topics_detection_jobs({
  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,
})

Response structure


resp.topics_detection_job_properties_list #=> Array
resp.topics_detection_job_properties_list[0].job_id #=> String
resp.topics_detection_job_properties_list[0].job_arn #=> String
resp.topics_detection_job_properties_list[0].job_name #=> String
resp.topics_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.topics_detection_job_properties_list[0].message #=> String
resp.topics_detection_job_properties_list[0].submit_time #=> Time
resp.topics_detection_job_properties_list[0].end_time #=> Time
resp.topics_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.topics_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.topics_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.topics_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.topics_detection_job_properties_list[0].number_of_topics #=> Integer
resp.topics_detection_job_properties_list[0].data_access_role_arn #=> String
resp.topics_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.topics_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.topics_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.topics_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.topics_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter (Types::TopicsDetectionJobFilter)

    Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

  • :next_token (String)

    Identifies the next page of results to return.

  • :max_results (Integer)

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



3372
3373
3374
3375
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3372

def list_topics_detection_jobs(params = {}, options = {})
  req = build_request(:list_topics_detection_jobs, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ComprehendModelArn", # required
  resource_policy: "Policy", # required
  policy_revision_id: "PolicyRevisionId",
})

Response structure


resp.policy_revision_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the custom model to attach the policy to.

  • :resource_policy (required, String)

    The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

    "\{"attribute": "value", "attribute": ["value"]\}"

    To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

    '\{"attribute": "value", "attribute": ["value"]\}'

  • :policy_revision_id (String)

    The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.

Returns:

See Also:



3426
3427
3428
3429
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3426

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#start_document_classification_job(params = {}) ⇒ Types::StartDocumentClassificationJobResponse

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

Examples:

Request syntax with placeholder values


resp = client.start_document_classification_job({
  job_name: "JobName",
  document_classifier_arn: "DocumentClassifierArn", # required
  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
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_name (String)

    The identifier of the job.

  • :document_classifier_arn (required, String)

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :client_request_token (String)

    A unique identifier for the request. If you do not 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.**

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the document classification 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.

Returns:

See Also:



3534
3535
3536
3537
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3534

def start_document_classification_job(params = {}, options = {})
  req = build_request(:start_document_classification_job, params)
  req.send_request(options)
end

#start_dominant_language_detection_job(params = {}) ⇒ Types::StartDominantLanguageDetectionJobResponse

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_dominant_language_detection_job({
  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",
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    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 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

  • :job_name (String)

    An identifier for the job.

  • :client_request_token (String)

    A unique identifier for the request. If you do not 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.**

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the dominant language 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.

Returns:

See Also:



3643
3644
3645
3646
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3643

def start_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:start_dominant_language_detection_job, params)
  req.send_request(options)
end

#start_entities_detection_job(params = {}) ⇒ Types::StartEntitiesDetectionJobResponse

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

Examples:

Request syntax with placeholder values


resp = client.start_entities_detection_job({
  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",
  entity_recognizer_arn: "EntityRecognizerArn",
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    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 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

  • :job_name (String)

    The identifier of the job.

  • :entity_recognizer_arn (String)

    The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

  • :language_code (required, String)

    The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

  • :client_request_token (String)

    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.**

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the entities 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.

Returns:

See Also:



3769
3770
3771
3772
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3769

def start_entities_detection_job(params = {}, options = {})
  req = build_request(:start_entities_detection_job, params)
  req.send_request(options)
end

#start_events_detection_job(params = {}) ⇒ Types::StartEventsDetectionJobResponse

Starts an asynchronous event detection job for a collection of documents.

Examples:

Request syntax with placeholder values


resp = client.start_events_detection_job({
  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",
  target_event_types: ["EventTypeString"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :job_name (String)

    The identifier of the events detection job.

  • :language_code (required, String)

    The language code of the input documents.

  • :client_request_token (String)

    An 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.**

  • :target_event_types (required, Array<String>)

    The types of events to detect in the input documents.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the events 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.

Returns:

See Also:



3855
3856
3857
3858
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3855

def start_events_detection_job(params = {}, options = {})
  req = build_request(:start_events_detection_job, params)
  req.send_request(options)
end

#start_key_phrases_detection_job(params = {}) ⇒ Types::StartKeyPhrasesDetectionJobResponse

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_key_phrases_detection_job({
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    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 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

  • :job_name (String)

    The identifier of the job.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

  • :client_request_token (String)

    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.**

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the key phrases 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.

Returns:

See Also:



3969
3970
3971
3972
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3969

def start_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:start_key_phrases_detection_job, params)
  req.send_request(options)
end

#start_pii_entities_detection_job(params = {}) ⇒ Types::StartPiiEntitiesDetectionJobResponse

Starts an asynchronous PII entity detection job for a collection of documents.

Examples:

Request syntax with placeholder values


resp = client.start_pii_entities_detection_job({
  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",
  },
  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, 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",
  },
  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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    The input properties for a PII entities detection job.

  • :output_data_config (required, Types::OutputDataConfig)

    Provides conīŦguration parameters for the output of PII entity detection jobs.

  • :mode (required, String)

    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

  • :redaction_config (Types::RedactionConfig)

    Provides configuration parameters for PII entity redaction.

    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :job_name (String)

    The identifier of the job.

  • :language_code (required, String)

    The language of the input documents. Currently, English is the only valid language.

  • :client_request_token (String)

    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.**

  • :tags (Array<Types::Tag>)

    Tags to be associated with the PII entities 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.

Returns:

See Also:



4070
4071
4072
4073
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4070

def start_pii_entities_detection_job(params = {}, options = {})
  req = build_request(:start_pii_entities_detection_job, params)
  req.send_request(options)
end

#start_sentiment_detection_job(params = {}) ⇒ Types::StartSentimentDetectionJobResponse

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_sentiment_detection_job({
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    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 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

  • :job_name (String)

    The identifier of the job.

  • :language_code (required, String)

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

  • :client_request_token (String)

    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.**

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the 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.

Returns:

See Also:



4184
4185
4186
4187
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4184

def start_sentiment_detection_job(params = {}, options = {})
  req = build_request(:start_sentiment_detection_job, params)
  req.send_request(options)
end

#start_targeted_sentiment_detection_job(params = {}) ⇒ Types::StartTargetedSentimentDetectionJobResponse

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_targeted_sentiment_detection_job({
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    The input properties for an inference job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files.

  • :data_access_role_arn (required, String)

    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.

  • :job_name (String)

    The identifier of the job.

  • :language_code (required, String)

    The language of the input documents. Currently, English is the only supported language.

  • :client_request_token (String)

    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.**

  • :volume_kms_key_id (String)

    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"

  • :vpc_config (Types::VpcConfig)

    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.

  • :tags (Array<Types::Tag>)

    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.

Returns:

See Also:



4298
4299
4300
4301
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4298

def start_targeted_sentiment_detection_job(params = {}, options = {})
  req = build_request(:start_targeted_sentiment_detection_job, params)
  req.send_request(options)
end

#start_topics_detection_job(params = {}) ⇒ Types::StartTopicsDetectionJobResponse

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_topics_detection_job({
  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",
  number_of_topics: 1,
  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",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig)

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig)

    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

  • :data_access_role_arn (required, String)

    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 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

  • :job_name (String)

    The identifier of the job.

  • :number_of_topics (Integer)

    The number of topics to detect.

  • :client_request_token (String)

    A unique identifier for the request. If you do not 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.**

  • :volume_kms_key_id (String)

    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 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"

  • :vpc_config (Types::VpcConfig)

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

  • :tags (Array<Types::Tag>)

    Tags to be associated with the topics 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.

Returns:

See Also:



4413
4414
4415
4416
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4413

def start_topics_detection_job(params = {}, options = {})
  req = build_request(:start_topics_detection_job, params)
  req.send_request(options)
end

#stop_dominant_language_detection_job(params = {}) ⇒ Types::StopDominantLanguageDetectionJobResponse

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_dominant_language_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the dominant language detection job to stop.

Returns:

See Also:



4455
4456
4457
4458
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4455

def stop_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:stop_dominant_language_detection_job, params)
  req.send_request(options)
end

#stop_entities_detection_job(params = {}) ⇒ Types::StopEntitiesDetectionJobResponse

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the entities detection job to stop.

Returns:

See Also:



4497
4498
4499
4500
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4497

def stop_entities_detection_job(params = {}, options = {})
  req = build_request(:stop_entities_detection_job, params)
  req.send_request(options)
end

#stop_events_detection_job(params = {}) ⇒ Types::StopEventsDetectionJobResponse

Stops an events detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_events_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the events detection job to stop.

Returns:

See Also:



4527
4528
4529
4530
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4527

def stop_events_detection_job(params = {}, options = {})
  req = build_request(:stop_events_detection_job, params)
  req.send_request(options)
end

#stop_key_phrases_detection_job(params = {}) ⇒ Types::StopKeyPhrasesDetectionJobResponse

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_key_phrases_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the key phrases detection job to stop.

Returns:

See Also:



4569
4570
4571
4572
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4569

def stop_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:stop_key_phrases_detection_job, params)
  req.send_request(options)
end

#stop_pii_entities_detection_job(params = {}) ⇒ Types::StopPiiEntitiesDetectionJobResponse

Stops a PII entities detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_pii_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the PII entities detection job to stop.

Returns:

See Also:



4599
4600
4601
4602
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4599

def stop_pii_entities_detection_job(params = {}, options = {})
  req = build_request(:stop_pii_entities_detection_job, params)
  req.send_request(options)
end

#stop_sentiment_detection_job(params = {}) ⇒ Types::StopSentimentDetectionJobResponse

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the sentiment detection job to stop.

Returns:

See Also:



4641
4642
4643
4644
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4641

def stop_sentiment_detection_job(params = {}, options = {})
  req = build_request(:stop_sentiment_detection_job, params)
  req.send_request(options)
end

#stop_targeted_sentiment_detection_job(params = {}) ⇒ Types::StopTargetedSentimentDetectionJobResponse

Stops a targeted sentiment detection job in progress.

If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_targeted_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the targeted sentiment detection job to stop.

Returns:

See Also:



4683
4684
4685
4686
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4683

def stop_targeted_sentiment_detection_job(params = {}, options = {})
  req = build_request(:stop_targeted_sentiment_detection_job, params)
  req.send_request(options)
end

#stop_training_document_classifier(params = {}) ⇒ Struct

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Examples:

Request syntax with placeholder values


resp = client.stop_training_document_classifier({
  document_classifier_arn: "DocumentClassifierArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_arn (required, String)

    The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4713
4714
4715
4716
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4713

def stop_training_document_classifier(params = {}, options = {})
  req = build_request(:stop_training_document_classifier, params)
  req.send_request(options)
end

#stop_training_entity_recognizer(params = {}) ⇒ Struct

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Examples:

Request syntax with placeholder values


resp = client.stop_training_entity_recognizer({
  entity_recognizer_arn: "EntityRecognizerArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entity_recognizer_arn (required, String)

    The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4743
4744
4745
4746
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4743

def stop_training_entity_recognizer(params = {}, options = {})
  req = build_request(:stop_training_entity_recognizer, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a 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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ComprehendArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

  • :tags (required, Array<Types::Tag>)

    Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4780
4781
4782
4783
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4780

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes a specific tag associated with an Amazon Comprehend resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ComprehendArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

  • :tag_keys (required, Array<String>)

    The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4811
4812
4813
4814
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4811

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_endpoint(params = {}) ⇒ Struct

Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

Examples:

Request syntax with placeholder values


resp = client.update_endpoint({
  endpoint_arn: "ComprehendEndpointArn", # required
  desired_model_arn: "ComprehendModelArn",
  desired_inference_units: 1,
  desired_data_access_role_arn: "IamRoleArn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_arn (required, String)

    The Amazon Resource Number (ARN) of the endpoint being updated.

  • :desired_model_arn (String)

    The ARN of the new model to use when updating an existing endpoint.

  • :desired_inference_units (Integer)

    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

  • :desired_data_access_role_arn (String)

    Data access role ARN to use in case the new model is encrypted with a customer CMK.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4853
4854
4855
4856
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4853

def update_endpoint(params = {}, options = {})
  req = build_request(:update_endpoint, params)
  req.send_request(options)
end