You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Comprehend

Inherits:
AWS.Service show all
Identifier:
comprehend
API Version:
2017-11-27
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

Sending a Request Using Comprehend

var comprehend = new AWS.Comprehend();
comprehend.batchDetectTargetedSentiment(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Comprehend object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var comprehend = new AWS.Comprehend({apiVersion: '2017-11-27'});

You can also set the API version globally in AWS.config.apiVersions using the comprehend service identifier:

AWS.config.apiVersions = {
  comprehend: '2017-11-27',
  // other service API versions
};

var comprehend = new AWS.Comprehend();

Version:

  • 2017-11-27

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Comprehend(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Comprehend object

var comprehend = new AWS.Comprehend({apiVersion: '2017-11-27'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Comprehend.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Comprehend.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Comprehend.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDetectDominantLanguage(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchDetectDominantLanguage operation

var params = {
  TextList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.batchDetectDominantLanguage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextList — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • Languages — (Array<map>)

          One or more DominantLanguage objects describing the dominant languages in the document.

          • LanguageCode — (String)

            The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

          • Score — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of the detection.

      • ErrorList — (Array<map>)

        A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • ErrorCode — (String)

          The numeric error code of the error.

        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDetectEntities(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchDetectEntities operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  TextList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.batchDetectEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextList — (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.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • Entities — (Array<map>)

          One or more Entity objects, one for each entity detected in the document.

          • Score — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of the detection.

          • Type — (String)

            The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

            For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

            Possible values include:
            • "PERSON"
            • "LOCATION"
            • "ORGANIZATION"
            • "COMMERCIAL_ITEM"
            • "EVENT"
            • "DATE"
            • "QUANTITY"
            • "TITLE"
            • "OTHER"
          • Text — (String)

            The text of the entity.

          • BeginOffset — (Integer)

            The zero-based offset from the beginning of the source text to the first character in the entity.

            This field is empty for non-text input.

          • EndOffset — (Integer)

            The zero-based offset from the beginning of the source text to the last character in the entity.

            This field is empty for non-text input.

          • BlockReferences — (Array<map>)

            A reference to each block for this entity. This field is empty for plain-text input.

            • BlockId — (String)

              Unique identifier for the block.

            • BeginOffset — (Integer)

              Offset of the start of the block within its parent block.

            • EndOffset — (Integer)

              Offset of the end of the block within its parent block.

            • ChildBlocks — (Array<map>)

              List of child blocks within this block.

              • ChildBlockId — (String)

                Unique identifier for the child block.

              • BeginOffset — (Integer)

                Offset of the start of the child block within its parent block.

              • EndOffset — (Integer)

                Offset of the end of the child block within its parent block.

      • ErrorList — (Array<map>)

        A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • ErrorCode — (String)

          The numeric error code of the error.

        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDetectKeyPhrases(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the batchDetectKeyPhrases operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  TextList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.batchDetectKeyPhrases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextList — (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.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • KeyPhrases — (Array<map>)

          One or more KeyPhrase objects, one for each key phrase detected in the document.

          • Score — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of the detection.

          • Text — (String)

            The text of a key noun phrase.

          • BeginOffset — (Integer)

            The zero-based offset from the beginning of the source text to the first character in the key phrase.

          • EndOffset — (Integer)

            The zero-based offset from the beginning of the source text to the last character in the key phrase.

      • ErrorList — (Array<map>)

        A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • ErrorCode — (String)

          The numeric error code of the error.

        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDetectSentiment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the batchDetectSentiment operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  TextList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.batchDetectSentiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextList — (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.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • Sentiment — (String)

          The sentiment detected in the document.

          Possible values include:
          • "POSITIVE"
          • "NEGATIVE"
          • "NEUTRAL"
          • "MIXED"
        • SentimentScore — (map)

          The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.

          • Positive — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

          • Negative — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

          • Neutral — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

          • Mixed — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

      • ErrorList — (Array<map>)

        A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • ErrorCode — (String)

          The numeric error code of the error.

        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDetectSyntax(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchDetectSyntax operation

var params = {
  LanguageCode: en | es | fr | de | it | pt, /* required */
  TextList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.batchDetectSyntax(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextList — (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.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • SyntaxTokens — (Array<map>)

          The syntax tokens for the words in the document, one token for each word.

          • TokenId — (Integer)

            A unique identifier for a token.

          • Text — (String)

            The word that was recognized in the source text.

          • BeginOffset — (Integer)

            The zero-based offset from the beginning of the source text to the first character in the word.

          • EndOffset — (Integer)

            The zero-based offset from the beginning of the source text to the last character in the word.

          • PartOfSpeech — (map)

            Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

            • Tag — (String)

              Identifies the part of speech that the token represents.

              Possible values include:
              • "ADJ"
              • "ADP"
              • "ADV"
              • "AUX"
              • "CONJ"
              • "CCONJ"
              • "DET"
              • "INTJ"
              • "NOUN"
              • "NUM"
              • "O"
              • "PART"
              • "PRON"
              • "PROPN"
              • "PUNCT"
              • "SCONJ"
              • "SYM"
              • "VERB"
            • Score — (Float)

              The confidence that Amazon Comprehend has that the part of speech was correctly identified.

      • ErrorList — (Array<map>)

        A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • ErrorCode — (String)

          The numeric error code of the error.

        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDetectTargetedSentiment(params = {}, callback) ⇒ AWS.Request

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 in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the batchDetectTargetedSentiment operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  TextList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.batchDetectTargetedSentiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextList — (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.

    • LanguageCode — (String)

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

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

        • Index — (Integer)

          The zero-based index of this result in the input list.

        • Entities — (Array<map>)

          An array of targeted sentiment entities.

          • DescriptiveMentionIndex — (Array<Integer>)

            One or more index into the Mentions array that provides the best name for the entity group.

          • Mentions — (Array<map>)

            An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.

            • Score — (Float)

              Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

            • GroupScore — (Float)

              The confidence that all the entities mentioned in the group relate to the same entity.

            • Text — (String)

              The text in the document that identifies the entity.

            • Type — (String)

              The type of the entity. Amazon Comprehend supports a variety of entity types.

              Possible values include:
              • "PERSON"
              • "LOCATION"
              • "ORGANIZATION"
              • "FACILITY"
              • "BRAND"
              • "COMMERCIAL_ITEM"
              • "MOVIE"
              • "MUSIC"
              • "BOOK"
              • "SOFTWARE"
              • "GAME"
              • "PERSONAL_TITLE"
              • "EVENT"
              • "DATE"
              • "QUANTITY"
              • "ATTRIBUTE"
              • "OTHER"
            • MentionSentiment — (map)

              Contains the sentiment and sentiment score for the mention.

              • Sentiment — (String)

                The sentiment of the mention.

                Possible values include:
                • "POSITIVE"
                • "NEGATIVE"
                • "NEUTRAL"
                • "MIXED"
              • SentimentScore — (map)

                Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

                • Positive — (Float)

                  The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

                • Negative — (Float)

                  The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

                • Neutral — (Float)

                  The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

                • Mixed — (Float)

                  The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

            • BeginOffset — (Integer)

              The offset into the document text where the mention begins.

            • EndOffset — (Integer)

              The offset into the document text where the mention ends.

      • ErrorList — (Array<map>)

        List of errors that the operation can return.

        • Index — (Integer)

          The zero-based index of the document in the input list.

        • ErrorCode — (String)

          The numeric error code of the error.

        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

classifyDocument(params = {}, callback) ⇒ AWS.Request

Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

  • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

  • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

Service Reference:

Examples:

Calling the classifyDocument operation

var params = {
  EndpointArn: 'STRING_VALUE', /* required */
  Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  DocumentReaderConfig: {
    DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
    DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
    FeatureTypes: [
      TABLES | FORMS,
      /* more items */
    ]
  },
  Text: 'STRING_VALUE'
};
comprehend.classifyDocument(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

      The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.

    • EndpointArn — (String)

      The Amazon Resource Number (ARN) of the endpoint.

      For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide

      For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.

    • Bytes — (Buffer, Typed Array, Blob, String)

      Use the Bytes parameter to input a text, PDF, Word or image file.

      When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

      To classify a document using the prompt safety classifier, use the Text parameter for input.

      Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.

      The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

      If you use the Bytes parameter, do not use the Text parameter.

    • DocumentReaderConfig — (map)

      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

      • DocumentReadActionrequired — (String)

        This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

        • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

        • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

        Possible values include:
        • "TEXTRACT_DETECT_DOCUMENT_TEXT"
        • "TEXTRACT_ANALYZE_DOCUMENT"
      • DocumentReadMode — (String)

        Determines the text extraction actions for PDF files. Enter one of the following values:

        • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

        • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

        Possible values include:
        • "SERVICE_DEFAULT"
        • "FORCE_DOCUMENT_READ_ACTION"
      • FeatureTypes — (Array<String>)

        Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

        • TABLES - Returns additional information about any tables that are detected in the input document.

        • FORMS - Returns additional information about any forms that are detected in the input document.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Classes — (Array<map>)

        The classes used by the document being analyzed. These are used for models trained in multi-class mode. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

        For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

        • Name — (String)

          The name of the class.

        • Score — (Float)

          The confidence score that Amazon Comprehend has this class correctly attributed.

        • Page — (Integer)

          Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

      • Labels — (Array<map>)

        The labels used in the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

        • Name — (String)

          The name of the label.

        • Score — (Float)

          The confidence score that Amazon Comprehend has this label correctly attributed.

        • Page — (Integer)

          Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

      • DocumentMetadata — (map)

        Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

        • Pages — (Integer)

          Number of pages in the document.

        • ExtractedCharacters — (Array<map>)

          List of pages in the document, with the number of characters extracted from each page.

          • Page — (Integer)

            Page number.

          • Count — (Integer)

            Number of characters extracted from each page.

      • DocumentType — (Array<map>)

        The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

        • Page — (Integer)

          Page number.

        • Type — (String)

          Document type.

          Possible values include:
          • "NATIVE_PDF"
          • "SCANNED_PDF"
          • "MS_WORD"
          • "IMAGE"
          • "PLAIN_TEXT"
          • "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON"
          • "TEXTRACT_ANALYZE_DOCUMENT_JSON"
      • Errors — (Array<map>)

        Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

        • Page — (Integer)

          Page number where the error occurred.

        • ErrorCode — (String)

          Error code for the cause of the error.

          Possible values include:
          • "TEXTRACT_BAD_PAGE"
          • "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED"
          • "PAGE_CHARACTERS_EXCEEDED"
          • "PAGE_SIZE_EXCEEDED"
          • "INTERNAL_SERVER_ERROR"
        • ErrorMessage — (String)

          Text message explaining the reason for the error.

      • Warnings — (Array<map>)

        Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

        The field is empty if the system generated no warnings.

        • Page — (Integer)

          Page number in the input document.

        • WarnCode — (String)

          The type of warning.

          Possible values include:
          • "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL"
          • "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL"
        • WarnMessage — (String)

          Text message associated with the warning.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

containsPiiEntities(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the containsPiiEntities operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  Text: 'STRING_VALUE' /* required */
};
comprehend.containsPiiEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

    • LanguageCode — (String)

      The language of the input documents.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Labels — (Array<map>)

        The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.

        • Name — (String)

          The name of the label.

          Possible values include:
          • "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"
        • Score — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataset(params = {}, callback) ⇒ AWS.Request

Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the createDataset operation

var params = {
  DatasetName: 'STRING_VALUE', /* required */
  FlywheelArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    AugmentedManifests: [
      {
        AttributeNames: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        S3Uri: 'STRING_VALUE', /* required */
        AnnotationDataS3Uri: 'STRING_VALUE',
        DocumentType: PLAIN_TEXT_DOCUMENT | SEMI_STRUCTURED_DOCUMENT,
        SourceDocumentsS3Uri: 'STRING_VALUE'
      },
      /* more items */
    ],
    DataFormat: COMPREHEND_CSV | AUGMENTED_MANIFEST,
    DocumentClassifierInputDataConfig: {
      S3Uri: 'STRING_VALUE', /* required */
      LabelDelimiter: 'STRING_VALUE'
    },
    EntityRecognizerInputDataConfig: {
      Documents: { /* required */
        S3Uri: 'STRING_VALUE', /* required */
        InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
      },
      Annotations: {
        S3Uri: 'STRING_VALUE' /* required */
      },
      EntityList: {
        S3Uri: 'STRING_VALUE' /* required */
      }
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  DatasetType: TRAIN | TEST,
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
comprehend.createDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

    • DatasetName — (String)

      Name of the dataset.

    • DatasetType — (String)

      The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.

      Possible values include:
      • "TRAIN"
      • "TEST"
    • Description — (String)

      Description of the dataset.

    • InputDataConfig — (map)

      Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.

      • AugmentedManifests — (Array<map>)

        A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

        • AttributeNamesrequired — (Array<String>)

          The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

          If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

          If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

        • S3Urirequired — (String)

          The Amazon S3 location of the augmented manifest file.

        • AnnotationDataS3Uri — (String)

          The S3 prefix to the annotation files that are referred in the augmented manifest file.

        • SourceDocumentsS3Uri — (String)

          The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

        • DocumentType — (String)

          The type of augmented manifest. If you don't specify, the default is PlainTextDocument.

          PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

          Possible values include:
          • "PLAIN_TEXT_DOCUMENT"
          • "SEMI_STRUCTURED_DOCUMENT"
      • DataFormat — (String)

        COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.

        AUGMENTED_MANIFEST: The data format

        Possible values include:
        • "COMPREHEND_CSV"
        • "AUGMENTED_MANIFEST"
      • DocumentClassifierInputDataConfig — (map)

        The input properties for training a document classifier model.

        For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

        • S3Urirequired — (String)

          The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

          For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          This parameter is required if you set DataFormat to COMPREHEND_CSV.

        • LabelDelimiter — (String)

          Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

      • EntityRecognizerInputDataConfig — (map)

        The input properties for training an entity recognizer model.

        • Annotations — (map)

          The S3 location of the annotation documents for your custom entity recognizer.

          • S3Urirequired — (String)

            Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

        • Documentsrequired — (map)

          The format and location of the training documents for your custom entity recognizer.

          • S3Urirequired — (String)

            Specifies the Amazon S3 location where the documents for the dataset are located.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
        • EntityList — (map)

          The S3 location of the entity list for your custom entity recognizer.

          • S3Urirequired — (String)

            Specifies the Amazon S3 location where the entity list is located.

    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Tags for the dataset.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetArn — (String)

        The ARN of the dataset.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDocumentClassifier(params = {}, callback) ⇒ AWS.Request

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.

Service Reference:

Examples:

Calling the createDocumentClassifier operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  DocumentClassifierName: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    AugmentedManifests: [
      {
        AttributeNames: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        S3Uri: 'STRING_VALUE', /* required */
        AnnotationDataS3Uri: 'STRING_VALUE',
        DocumentType: PLAIN_TEXT_DOCUMENT | SEMI_STRUCTURED_DOCUMENT,
        SourceDocumentsS3Uri: 'STRING_VALUE',
        Split: TRAIN | TEST
      },
      /* more items */
    ],
    DataFormat: COMPREHEND_CSV | AUGMENTED_MANIFEST,
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    DocumentType: PLAIN_TEXT_DOCUMENT | SEMI_STRUCTURED_DOCUMENT,
    Documents: {
      S3Uri: 'STRING_VALUE', /* required */
      TestS3Uri: 'STRING_VALUE'
    },
    LabelDelimiter: 'STRING_VALUE',
    S3Uri: 'STRING_VALUE',
    TestS3Uri: 'STRING_VALUE'
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  ClientRequestToken: 'STRING_VALUE',
  Mode: MULTI_CLASS | MULTI_LABEL,
  ModelKmsKeyId: 'STRING_VALUE',
  ModelPolicy: 'STRING_VALUE',
  OutputDataConfig: {
    FlywheelStatsS3Prefix: 'STRING_VALUE',
    KmsKeyId: 'STRING_VALUE',
    S3Uri: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VersionName: 'STRING_VALUE',
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.createDocumentClassifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DocumentClassifierName — (String)

      The name of the document classifier.

    • VersionName — (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 Amazon Web Services account/Amazon Web Services Region.

    • DataAccessRoleArn — (String)

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

    • Tags — (Array<map>)

      Tags to associate with the document classifier. 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

    • InputDataConfig — (map)

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

      • DataFormat — (String)

        The format of your training data:

        • COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

        • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.

          If you use this value, you must provide the AugmentedManifests parameter in your request.

        If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

        Possible values include:
        • "COMPREHEND_CSV"
        • "AUGMENTED_MANIFEST"
      • S3Uri — (String)

        The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

        This parameter is required if you set DataFormat to COMPREHEND_CSV.

      • TestS3Uri — (String)

        This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

      • LabelDelimiter — (String)

        Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

      • AugmentedManifests — (Array<map>)

        A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

        This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

        • S3Urirequired — (String)

          The Amazon S3 location of the augmented manifest file.

        • Split — (String)

          The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

          TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

          TEST - all of the documents in the manifest will be used for testing.

          Possible values include:
          • "TRAIN"
          • "TEST"
        • AttributeNamesrequired — (Array<String>)

          The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

          If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

          If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

        • AnnotationDataS3Uri — (String)

          The S3 prefix to the annotation files that are referred in the augmented manifest file.

        • SourceDocumentsS3Uri — (String)

          The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

        • DocumentType — (String)

          The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

          • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

          • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

          Possible values include:
          • "PLAIN_TEXT_DOCUMENT"
          • "SEMI_STRUCTURED_DOCUMENT"
      • DocumentType — (String)

        The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.

        Possible values include:
        • "PLAIN_TEXT_DOCUMENT"
        • "SEMI_STRUCTURED_DOCUMENT"
      • Documents — (map)

        The S3 location of the training documents. This parameter is required in a request to create a native document model.

        • S3Urirequired — (String)

          The S3 URI location of the training documents specified in the S3Uri CSV file.

        • TestS3Uri — (String)

          The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file.

      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

        • Word files - Amazon Comprehend parser extracts the text.

        • Digital PDF files - Amazon Comprehend parser extracts the text.

        • Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.

        DocumentReaderConfig does not apply to plain text files or Word files.

        For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.

      • S3Uri — (String)

        When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

        When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

      • FlywheelStatsS3Prefix — (String)

        The Amazon S3 prefix for the data lake location of the flywheel statistics.

    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • LanguageCode — (String)

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

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Mode — (String)

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

      Possible values include:
      • "MULTI_CLASS"
      • "MULTI_LABEL"
    • ModelKmsKeyId — (String)

      ID for the 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"

    • ModelPolicy — (String)

      The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services 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"]}'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DocumentClassifierArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEndpoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createEndpoint operation

var params = {
  DesiredInferenceUnits: 'NUMBER_VALUE', /* required */
  EndpointName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  DataAccessRoleArn: 'STRING_VALUE',
  FlywheelArn: 'STRING_VALUE',
  ModelArn: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
comprehend.createEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EndpointName — (String)

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

    • ModelArn — (String)

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

    • DesiredInferenceUnits — (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.

    • ClientRequestToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Tags to associate with the endpoint. 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

    • DataAccessRoleArn — (String)

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

    • FlywheelArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointArn — (String)

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

      • ModelArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEntityRecognizer(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createEntityRecognizer operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    EntityTypes: [ /* required */
      {
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Annotations: {
      S3Uri: 'STRING_VALUE', /* required */
      TestS3Uri: 'STRING_VALUE'
    },
    AugmentedManifests: [
      {
        AttributeNames: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        S3Uri: 'STRING_VALUE', /* required */
        AnnotationDataS3Uri: 'STRING_VALUE',
        DocumentType: PLAIN_TEXT_DOCUMENT | SEMI_STRUCTURED_DOCUMENT,
        SourceDocumentsS3Uri: 'STRING_VALUE',
        Split: TRAIN | TEST
      },
      /* more items */
    ],
    DataFormat: COMPREHEND_CSV | AUGMENTED_MANIFEST,
    Documents: {
      S3Uri: 'STRING_VALUE', /* required */
      InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE,
      TestS3Uri: 'STRING_VALUE'
    },
    EntityList: {
      S3Uri: 'STRING_VALUE' /* required */
    }
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  RecognizerName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  ModelKmsKeyId: 'STRING_VALUE',
  ModelPolicy: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VersionName: 'STRING_VALUE',
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.createEntityRecognizer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RecognizerName — (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.

    • VersionName — (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/Region.

    • DataAccessRoleArn — (String)

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

    • Tags — (Array<map>)

      Tags to associate with the entity recognizer. 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

    • InputDataConfig — (map)

      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.

      • DataFormat — (String)

        The format of your training data:

        • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

          If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

        • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.

          If you use this value, you must provide the AugmentedManifests parameter in your request.

        If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

        Possible values include:
        • "COMPREHEND_CSV"
        • "AUGMENTED_MANIFEST"
      • EntityTypesrequired — (Array<map>)

        The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

        A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break), \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), space, and , (comma).

        • Typerequired — (String)

          An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

          Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break, \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), and , (comma).

      • Documents — (map)

        The S3 location of the folder that contains the training documents for your custom entity recognizer.

        This parameter is required if you set DataFormat to COMPREHEND_CSV.

        • S3Urirequired — (String)

          Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

        • TestS3Uri — (String)

          Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

        • InputFormat — (String)

          Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

          Possible values include:
          • "ONE_DOC_PER_FILE"
          • "ONE_DOC_PER_LINE"
      • Annotations — (map)

        The S3 location of the CSV file that annotates your training documents.

        • S3Urirequired — (String)

          Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

        • TestS3Uri — (String)

          Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

      • EntityList — (map)

        The S3 location of the CSV file that has the entity list for your custom entity recognizer.

        • S3Urirequired — (String)

          Specifies the Amazon S3 location where the entity list is located. The URI must be in the same Region as the API endpoint that you are calling.

      • AugmentedManifests — (Array<map>)

        A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

        This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

        • S3Urirequired — (String)

          The Amazon S3 location of the augmented manifest file.

        • Split — (String)

          The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

          TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

          TEST - all of the documents in the manifest will be used for testing.

          Possible values include:
          • "TRAIN"
          • "TEST"
        • AttributeNamesrequired — (Array<String>)

          The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

          If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

          If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

        • AnnotationDataS3Uri — (String)

          The S3 prefix to the annotation files that are referred in the augmented manifest file.

        • SourceDocumentsS3Uri — (String)

          The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

        • DocumentType — (String)

          The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

          • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

          • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

          Possible values include:
          • "PLAIN_TEXT_DOCUMENT"
          • "SEMI_STRUCTURED_DOCUMENT"
    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • LanguageCode — (String)

      You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • ModelKmsKeyId — (String)

      ID for the 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"

    • ModelPolicy — (String)

      The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services 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"]}'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntityRecognizerArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFlywheel(params = {}, callback) ⇒ AWS.Request

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the createFlywheel operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  DataLakeS3Uri: 'STRING_VALUE', /* required */
  FlywheelName: 'STRING_VALUE', /* required */
  ActiveModelArn: 'STRING_VALUE',
  ClientRequestToken: 'STRING_VALUE',
  DataSecurityConfig: {
    DataLakeKmsKeyId: 'STRING_VALUE',
    ModelKmsKeyId: 'STRING_VALUE',
    VolumeKmsKeyId: 'STRING_VALUE',
    VpcConfig: {
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  ModelType: DOCUMENT_CLASSIFIER | ENTITY_RECOGNIZER,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TaskConfig: {
    LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
    DocumentClassificationConfig: {
      Mode: MULTI_CLASS | MULTI_LABEL, /* required */
      Labels: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    EntityRecognitionConfig: {
      EntityTypes: [ /* required */
        {
          Type: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  }
};
comprehend.createFlywheel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelName — (String)

      Name for the flywheel.

    • ActiveModelArn — (String)

      To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

    • TaskConfig — (map)

      Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

      • LanguageCoderequired — (String)

        Language code for the language that the model supports.

        Possible values include:
        • "en"
        • "es"
        • "fr"
        • "de"
        • "it"
        • "pt"
        • "ar"
        • "hi"
        • "ja"
        • "ko"
        • "zh"
        • "zh-TW"
      • DocumentClassificationConfig — (map)

        Configuration required for a document classification model.

        • Moderequired — (String)

          Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

          Possible values include:
          • "MULTI_CLASS"
          • "MULTI_LABEL"
        • Labels — (Array<String>)

          One or more labels to associate with the custom classifier.

      • EntityRecognitionConfig — (map)

        Configuration required for an entity recognition model.

        • EntityTypesrequired — (Array<map>)

          Up to 25 entity types that the model is trained to recognize.

          • Typerequired — (String)

            An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

            Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break, \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), and , (comma).

    • ModelType — (String)

      The model type. You need to set ModelType if you are creating a flywheel for a new model.

      Possible values include:
      • "DOCUMENT_CLASSIFIER"
      • "ENTITY_RECOGNIZER"
    • DataLakeS3Uri — (String)

      Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

    • DataSecurityConfig — (map)

      Data security configurations.

      • ModelKmsKeyId — (String)

        ID for the 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"

      • VolumeKmsKeyId — (String)

        ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

      • DataLakeKmsKeyId — (String)

        ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.

      • VpcConfig — (map)

        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.

        • SecurityGroupIdsrequired — (Array<String>)

          The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

        • Subnetsrequired — (Array<String>)

          The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags to associate with this flywheel.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelArn — (String)

        The Amazon Resource Number (ARN) of the flywheel.

      • ActiveModelArn — (String)

        The Amazon Resource Number (ARN) of the active model version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDocumentClassifier(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteDocumentClassifier operation

var params = {
  DocumentClassifierArn: 'STRING_VALUE' /* required */
};
comprehend.deleteDocumentClassifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DocumentClassifierArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEndpoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteEndpoint operation

var params = {
  EndpointArn: 'STRING_VALUE' /* required */
};
comprehend.deleteEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EndpointArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEntityRecognizer(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteEntityRecognizer operation

var params = {
  EntityRecognizerArn: 'STRING_VALUE' /* required */
};
comprehend.deleteEntityRecognizer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EntityRecognizerArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFlywheel(params = {}, callback) ⇒ AWS.Request

Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the deleteFlywheel operation

var params = {
  FlywheelArn: 'STRING_VALUE' /* required */
};
comprehend.deleteFlywheel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  PolicyRevisionId: 'STRING_VALUE'
};
comprehend.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • PolicyRevisionId — (String)

      The revision ID of the policy to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDataset(params = {}, callback) ⇒ AWS.Request

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the describeDataset operation

var params = {
  DatasetArn: 'STRING_VALUE' /* required */
};
comprehend.describeDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DatasetArn — (String)

      The ARN of the dataset.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetProperties — (map)

        The dataset properties.

        • DatasetArn — (String)

          The ARN of the dataset.

        • DatasetName — (String)

          The name of the dataset.

        • DatasetType — (String)

          The dataset type (training data or test data).

          Possible values include:
          • "TRAIN"
          • "TEST"
        • DatasetS3Uri — (String)

          The S3 URI where the dataset is stored.

        • Description — (String)

          Description of the dataset.

        • Status — (String)

          The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

          Possible values include:
          • "CREATING"
          • "COMPLETED"
          • "FAILED"
        • Message — (String)

          A description of the status of the dataset.

        • NumberOfDocuments — (Integer)

          The number of documents in the dataset.

        • CreationTime — (Date)

          Creation time of the dataset.

        • EndTime — (Date)

          Time when the data from the dataset becomes available in the data lake.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDocumentClassificationJob(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the describeDocumentClassificationJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeDocumentClassificationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DocumentClassificationJobProperties — (map)

        An object that describes the properties associated with the document classification job.

        • JobId — (String)

          The identifier assigned to the document classification job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the document classification job.

        • JobStatus — (String)

          The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of the job.

        • SubmitTime — (Date)

          The time that the document classification job was submitted for processing.

        • EndTime — (Date)

          The time that the document classification job completed.

        • DocumentClassifierArn — (String)

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

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the document classification job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the document classification job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDocumentClassifier(params = {}, callback) ⇒ AWS.Request

Gets the properties associated with a document classifier.

Service Reference:

Examples:

Calling the describeDocumentClassifier operation

var params = {
  DocumentClassifierArn: 'STRING_VALUE' /* required */
};
comprehend.describeDocumentClassifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DocumentClassifierArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DocumentClassifierProperties — (map)

        An object that contains the properties associated with a document classifier.

        • DocumentClassifierArn — (String)

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

        • LanguageCode — (String)

          The language code for the language of the documents that the classifier was trained on.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • Status — (String)

          The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

          If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

          Possible values include:
          • "SUBMITTED"
          • "TRAINING"
          • "DELETING"
          • "STOP_REQUESTED"
          • "STOPPED"
          • "IN_ERROR"
          • "TRAINED"
          • "TRAINED_WITH_WARNING"
        • Message — (String)

          Additional information about the status of the classifier.

        • SubmitTime — (Date)

          The time that the document classifier was submitted for training.

        • EndTime — (Date)

          The time that training the document classifier completed.

        • TrainingStartTime — (Date)

          Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

        • TrainingEndTime — (Date)

          The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the document classifier for training.

          • DataFormat — (String)

            The format of your training data:

            • COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

            • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.

              If you use this value, you must provide the AugmentedManifests parameter in your request.

            If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

            Possible values include:
            • "COMPREHEND_CSV"
            • "AUGMENTED_MANIFEST"
          • S3Uri — (String)

            The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

            This parameter is required if you set DataFormat to COMPREHEND_CSV.

          • TestS3Uri — (String)

            This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

          • LabelDelimiter — (String)

            Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

          • AugmentedManifests — (Array<map>)

            A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

            This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

            • S3Urirequired — (String)

              The Amazon S3 location of the augmented manifest file.

            • Split — (String)

              The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

              TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

              TEST - all of the documents in the manifest will be used for testing.

              Possible values include:
              • "TRAIN"
              • "TEST"
            • AttributeNamesrequired — (Array<String>)

              The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

              If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

              If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

            • AnnotationDataS3Uri — (String)

              The S3 prefix to the annotation files that are referred in the augmented manifest file.

            • SourceDocumentsS3Uri — (String)

              The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

            • DocumentType — (String)

              The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

              • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

              • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

              Possible values include:
              • "PLAIN_TEXT_DOCUMENT"
              • "SEMI_STRUCTURED_DOCUMENT"
          • DocumentType — (String)

            The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.

            Possible values include:
            • "PLAIN_TEXT_DOCUMENT"
            • "SEMI_STRUCTURED_DOCUMENT"
          • Documents — (map)

            The S3 location of the training documents. This parameter is required in a request to create a native document model.

            • S3Urirequired — (String)

              The S3 URI location of the training documents specified in the S3Uri CSV file.

            • TestS3Uri — (String)

              The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file.

          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

            • Word files - Amazon Comprehend parser extracts the text.

            • Digital PDF files - Amazon Comprehend parser extracts the text.

            • Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.

            DocumentReaderConfig does not apply to plain text files or Word files.

            For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          Provides output results configuration parameters for custom classifier jobs.

          • S3Uri — (String)

            When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

            When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

          • FlywheelStatsS3Prefix — (String)

            The Amazon S3 prefix for the data lake location of the flywheel statistics.

        • ClassifierMetadata — (map)

          Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

          • NumberOfLabels — (Integer)

            The number of labels in the input data.

          • NumberOfTrainedDocuments — (Integer)

            The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

          • NumberOfTestDocuments — (Integer)

            The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

          • EvaluationMetrics — (map)

            Describes the result metrics for the test data associated with an documentation classifier.

            • Accuracy — (Float)

              The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

            • Precision — (Float)

              A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

            • Recall — (Float)

              A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

            • F1Score — (Float)

              A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

            • MicroPrecision — (Float)

              A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.

            • MicroRecall — (Float)

              A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.

            • MicroF1Score — (Float)

              A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.

            • HammingLoss — (Float)

              Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • Mode — (String)

          Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

          Possible values include:
          • "MULTI_CLASS"
          • "MULTI_LABEL"
        • ModelKmsKeyId — (String)

          ID for the 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"

        • VersionName — (String)

          The version name that you assigned to the document classifier.

        • SourceModelArn — (String)

          The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDominantLanguageDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the describeDominantLanguageDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeDominantLanguageDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DominantLanguageDetectionJobProperties — (map)

        An object that contains the properties associated with a dominant language detection job.

        • JobId — (String)

          The identifier assigned to the dominant language detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the dominant language detection job.

        • JobStatus — (String)

          The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description for the status of a job.

        • SubmitTime — (Date)

          The time that the dominant language detection job was submitted for processing.

        • EndTime — (Date)

          The time that the dominant language detection job completed.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the dominant language detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the dominant language detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeEndpoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeEndpoint operation

var params = {
  EndpointArn: 'STRING_VALUE' /* required */
};
comprehend.describeEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EndpointArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointProperties — (map)

        Describes information associated with the specific endpoint.

        • EndpointArn — (String)

          The Amazon Resource Number (ARN) of the endpoint.

        • Status — (String)

          Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "FAILED"
          • "IN_SERVICE"
          • "UPDATING"
        • Message — (String)

          Specifies a reason for failure in cases of Failed status.

        • ModelArn — (String)

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

        • DesiredModelArn — (String)

          ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

        • DesiredInferenceUnits — (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.

        • CurrentInferenceUnits — (Integer)

          The number of inference units currently used by the model using this endpoint.

        • CreationTime — (Date)

          The creation date and time of the endpoint.

        • LastModifiedTime — (Date)

          The date and time that the endpoint was last modified.

        • DataAccessRoleArn — (String)

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

        • DesiredDataAccessRoleArn — (String)

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

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeEntitiesDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeEntitiesDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeEntitiesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntitiesDetectionJobProperties — (map)

        An object that contains the properties associated with an entities detection job.

        • JobId — (String)

          The identifier assigned to the entities detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned the entities detection job.

        • JobStatus — (String)

          The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the entities detection job was submitted for processing.

        • EndTime — (Date)

          The time that the entities detection job completed

        • EntityRecognizerArn — (String)

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

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the entities detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the entities detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • FlywheelArn — (String)

          The Amazon Resource Name (ARN) of the flywheel associated with this job.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeEntityRecognizer(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeEntityRecognizer operation

var params = {
  EntityRecognizerArn: 'STRING_VALUE' /* required */
};
comprehend.describeEntityRecognizer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EntityRecognizerArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntityRecognizerProperties — (map)

        Describes information associated with an entity recognizer.

        • EntityRecognizerArn — (String)

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

        • LanguageCode — (String)

          The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • Status — (String)

          Provides the status of the entity recognizer.

          Possible values include:
          • "SUBMITTED"
          • "TRAINING"
          • "DELETING"
          • "STOP_REQUESTED"
          • "STOPPED"
          • "IN_ERROR"
          • "TRAINED"
          • "TRAINED_WITH_WARNING"
        • Message — (String)

          A description of the status of the recognizer.

        • SubmitTime — (Date)

          The time that the recognizer was submitted for processing.

        • EndTime — (Date)

          The time that the recognizer creation completed.

        • TrainingStartTime — (Date)

          The time that training of the entity recognizer started.

        • TrainingEndTime — (Date)

          The time that training of the entity recognizer was completed.

        • InputDataConfig — (map)

          The input data properties of an entity recognizer.

          • DataFormat — (String)

            The format of your training data:

            • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

              If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

            • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.

              If you use this value, you must provide the AugmentedManifests parameter in your request.

            If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

            Possible values include:
            • "COMPREHEND_CSV"
            • "AUGMENTED_MANIFEST"
          • EntityTypesrequired — (Array<map>)

            The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

            A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break), \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), space, and , (comma).

            • Typerequired — (String)

              An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

              Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break, \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), and , (comma).

          • Documents — (map)

            The S3 location of the folder that contains the training documents for your custom entity recognizer.

            This parameter is required if you set DataFormat to COMPREHEND_CSV.

            • S3Urirequired — (String)

              Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

            • TestS3Uri — (String)

              Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

            • InputFormat — (String)

              Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

              Possible values include:
              • "ONE_DOC_PER_FILE"
              • "ONE_DOC_PER_LINE"
          • Annotations — (map)

            The S3 location of the CSV file that annotates your training documents.

            • S3Urirequired — (String)

              Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

            • TestS3Uri — (String)

              Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

          • EntityList — (map)

            The S3 location of the CSV file that has the entity list for your custom entity recognizer.

            • S3Urirequired — (String)

              Specifies the Amazon S3 location where the entity list is located. The URI must be in the same Region as the API endpoint that you are calling.

          • AugmentedManifests — (Array<map>)

            A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

            This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

            • S3Urirequired — (String)

              The Amazon S3 location of the augmented manifest file.

            • Split — (String)

              The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

              TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

              TEST - all of the documents in the manifest will be used for testing.

              Possible values include:
              • "TRAIN"
              • "TEST"
            • AttributeNamesrequired — (Array<String>)

              The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

              If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

              If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

            • AnnotationDataS3Uri — (String)

              The S3 prefix to the annotation files that are referred in the augmented manifest file.

            • SourceDocumentsS3Uri — (String)

              The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

            • DocumentType — (String)

              The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

              • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

              • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

              Possible values include:
              • "PLAIN_TEXT_DOCUMENT"
              • "SEMI_STRUCTURED_DOCUMENT"
        • RecognizerMetadata — (map)

          Provides information about an entity recognizer.

          • NumberOfTrainedDocuments — (Integer)

            The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

          • NumberOfTestDocuments — (Integer)

            The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

          • EvaluationMetrics — (map)

            Detailed information about the accuracy of an entity recognizer.

            • Precision — (Float)

              A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

            • Recall — (Float)

              A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

            • F1Score — (Float)

              A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.

          • EntityTypes — (Array<map>)

            Entity types from the metadata of an entity recognizer.

            • Type — (String)

              Type of entity from the list of entity types in the metadata of an entity recognizer.

            • EvaluationMetrics — (map)

              Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

              • Precision — (Float)

                A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

              • Recall — (Float)

                A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

              • F1Score — (Float)

                A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

            • NumberOfTrainMentions — (Integer)

              Indicates the number of times the given entity type was seen in the training data.

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • ModelKmsKeyId — (String)

          ID for the 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"

        • VersionName — (String)

          The version name you assigned to the entity recognizer.

        • SourceModelArn — (String)

          The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

        • OutputDataConfig — (map)

          Output data configuration.

          • FlywheelStatsS3Prefix — (String)

            The Amazon S3 prefix for the data lake location of the flywheel statistics.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeEventsDetectionJob(params = {}, callback) ⇒ AWS.Request

Gets the status and details of an events detection job.

Service Reference:

Examples:

Calling the describeEventsDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeEventsDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the events detection job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventsDetectionJobProperties — (map)

        An object that contains the properties associated with an event detection job.

        • JobId — (String)

          The identifier assigned to the events detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name you assigned the events detection job.

        • JobStatus — (String)

          The current status of the events detection job.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of the events detection job.

        • SubmitTime — (Date)

          The time that the events detection job was submitted for processing.

        • EndTime — (Date)

          The time that the events detection job completed.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the events detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the events detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • TargetEventTypes — (Array<String>)

          The types of events that are detected by the job.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFlywheel(params = {}, callback) ⇒ AWS.Request

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the describeFlywheel operation

var params = {
  FlywheelArn: 'STRING_VALUE' /* required */
};
comprehend.describeFlywheel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelProperties — (map)

        The flywheel properties.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel.

        • ActiveModelArn — (String)

          The Amazon Resource Number (ARN) of the active model version.

        • DataAccessRoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

        • TaskConfig — (map)

          Configuration about the model associated with a flywheel.

          • LanguageCoderequired — (String)

            Language code for the language that the model supports.

            Possible values include:
            • "en"
            • "es"
            • "fr"
            • "de"
            • "it"
            • "pt"
            • "ar"
            • "hi"
            • "ja"
            • "ko"
            • "zh"
            • "zh-TW"
          • DocumentClassificationConfig — (map)

            Configuration required for a document classification model.

            • Moderequired — (String)

              Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

              Possible values include:
              • "MULTI_CLASS"
              • "MULTI_LABEL"
            • Labels — (Array<String>)

              One or more labels to associate with the custom classifier.

          • EntityRecognitionConfig — (map)

            Configuration required for an entity recognition model.

            • EntityTypesrequired — (Array<map>)

              Up to 25 entity types that the model is trained to recognize.

              • Typerequired — (String)

                An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

                Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break, \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), and , (comma).

        • DataLakeS3Uri — (String)

          Amazon S3 URI of the data lake location.

        • DataSecurityConfig — (map)

          Data security configuration.

          • ModelKmsKeyId — (String)

            ID for the 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"

          • VolumeKmsKeyId — (String)

            ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

          • DataLakeKmsKeyId — (String)

            ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.

          • VpcConfig — (map)

            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.

            • SecurityGroupIdsrequired — (Array<String>)

              The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

            • Subnetsrequired — (Array<String>)

              The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • Status — (String)

          The status of the flywheel.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • ModelType — (String)

          Model type of the flywheel's model.

          Possible values include:
          • "DOCUMENT_CLASSIFIER"
          • "ENTITY_RECOGNIZER"
        • Message — (String)

          A description of the status of the flywheel.

        • CreationTime — (Date)

          Creation time of the flywheel.

        • LastModifiedTime — (Date)

          Last modified time for the flywheel.

        • LatestFlywheelIteration — (String)

          The most recent flywheel iteration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFlywheelIteration(params = {}, callback) ⇒ AWS.Request

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the describeFlywheelIteration operation

var params = {
  FlywheelArn: 'STRING_VALUE', /* required */
  FlywheelIterationId: 'STRING_VALUE' /* required */
};
comprehend.describeFlywheelIteration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

    • FlywheelIterationId — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelIterationProperties — (map)

        The configuration properties of a flywheel iteration.

        • FlywheelArn — (String)

        • FlywheelIterationId — (String)

        • CreationTime — (Date)

          The creation start time of the flywheel iteration.

        • EndTime — (Date)

          The completion time of this flywheel iteration.

        • Status — (String)

          The status of the flywheel iteration.

          Possible values include:
          • "TRAINING"
          • "EVALUATING"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of the flywheel iteration.

        • EvaluatedModelArn — (String)

          The ARN of the evaluated model associated with this flywheel iteration.

        • EvaluatedModelMetrics — (map)

          The evaluation metrics associated with the evaluated model.

          • AverageF1Score — (Float)

            The average F1 score from the evaluation metrics.

          • AveragePrecision — (Float)

            Average precision metric for the model.

          • AverageRecall — (Float)

            Average recall metric for the model.

          • AverageAccuracy — (Float)

            Average accuracy metric for the model.

        • TrainedModelArn — (String)

          The ARN of the trained model associated with this flywheel iteration.

        • TrainedModelMetrics — (map)

          The metrics associated with the trained model.

          • AverageF1Score — (Float)

            The average F1 score from the evaluation metrics.

          • AveragePrecision — (Float)

            Average precision metric for the model.

          • AverageRecall — (Float)

            Average recall metric for the model.

          • AverageAccuracy — (Float)

            Average accuracy metric for the model.

        • EvaluationManifestS3Prefix — (String)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeKeyPhrasesDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeKeyPhrasesDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeKeyPhrasesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyPhrasesDetectionJobProperties — (map)

        An object that contains the properties associated with a key phrases detection job.

        • JobId — (String)

          The identifier assigned to the key phrases detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned the key phrases detection job.

        • JobStatus — (String)

          The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the key phrases detection job was submitted for processing.

        • EndTime — (Date)

          The time that the key phrases detection job completed.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the key phrases detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the key phrases detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describePiiEntitiesDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describePiiEntitiesDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describePiiEntitiesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PiiEntitiesDetectionJobProperties — (map)

        Provides information about a PII entities detection job.

        • JobId — (String)

          The identifier assigned to the PII entities detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned the PII entities detection job.

        • JobStatus — (String)

          The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the PII entities detection job was submitted for processing.

        • EndTime — (Date)

          The time that the PII entities detection job completed.

        • InputDataConfig — (map)

          The input properties for a PII entities detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the PII entities detection job.

          • S3Urirequired — (String)

            When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

        • RedactionConfig — (map)

          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.

          • PiiEntityTypes — (Array<String>)

            An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

          • MaskMode — (String)

            Specifies whether the PII entity is redacted with the mask character or the entity type.

            Possible values include:
            • "MASK"
            • "REPLACE_WITH_PII_ENTITY_TYPE"
          • MaskCharacter — (String)

            A character that replaces each character in the redacted PII entity.

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • Mode — (String)

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

          Possible values include:
          • "ONLY_REDACTION"
          • "ONLY_OFFSETS"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeResourcePolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeResourcePolicy operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
comprehend.describeResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourcePolicy — (String)

        The JSON body of the resource-based policy.

      • CreationTime — (Date)

        The time at which the policy was created.

      • LastModifiedTime — (Date)

        The time at which the policy was last modified.

      • PolicyRevisionId — (String)

        The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSentimentDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeSentimentDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeSentimentDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SentimentDetectionJobProperties — (map)

        An object that contains the properties associated with a sentiment detection job.

        • JobId — (String)

          The identifier assigned to the sentiment detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the sentiment detection job

        • JobStatus — (String)

          The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the sentiment detection job was submitted for processing.

        • EndTime — (Date)

          The time that the sentiment detection job ended.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the sentiment detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the sentiment detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTargetedSentimentDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the describeTargetedSentimentDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeTargetedSentimentDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TargetedSentimentDetectionJobProperties — (map)

        An object that contains the properties associated with a targeted sentiment detection job.

        • JobId — (String)

          The identifier assigned to the targeted sentiment detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the targeted sentiment detection job.

        • JobStatus — (String)

          The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the targeted sentiment detection job was submitted for processing.

        • EndTime — (Date)

          The time that the targeted sentiment detection job ended.

        • InputDataConfig — (map)

          The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          Provides configuration parameters for the output of inference jobs.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:

          • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

          • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • VpcConfig — (map)

          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.

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTopicsDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeTopicsDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.describeTopicsDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier assigned by the user to the detection job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TopicsDetectionJobProperties — (map)

        The list of properties for the requested job.

        • JobId — (String)

          The identifier assigned to the topic detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name of the topic detection job.

        • JobStatus — (String)

          The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description for the status of a job.

        • SubmitTime — (Date)

          The time that the topic detection job was submitted for processing.

        • EndTime — (Date)

          The time that the topic detection job was completed.

        • InputDataConfig — (map)

          The input data configuration supplied when you created the topic detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration supplied when you created the topic detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • NumberOfTopics — (Integer)

          The number of topics to detect supplied when you created the topic detection job. The default is 10.

        • DataAccessRoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectDominantLanguage(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the detectDominantLanguage operation

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehend.detectDominantLanguage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Languages — (Array<map>)

        Array of languages that Amazon Comprehend detected in the input text. The array is sorted in descending order of the score (the dominant language is always the first element in the array).

        For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

        • LanguageCode — (String)

          The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

        • Score — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectEntities(params = {}, callback) ⇒ AWS.Request

Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.

When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

Service Reference:

Examples:

Calling the detectEntities operation

var params = {
  Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  DocumentReaderConfig: {
    DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
    DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
    FeatureTypes: [
      TABLES | FORMS,
      /* more items */
    ]
  },
  EndpointArn: 'STRING_VALUE',
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW,
  Text: 'STRING_VALUE'
};
comprehend.detectEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

      A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.

    • LanguageCode — (String)

      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.

      All input documents must be in the same language.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • EndpointArn — (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.

    • Bytes — (Buffer, Typed Array, Blob, String)

      This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.

      Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).

      You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

      Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

      The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

      If you use the Bytes parameter, do not use the Text parameter.

    • DocumentReaderConfig — (map)

      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

      • DocumentReadActionrequired — (String)

        This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

        • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

        • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

        Possible values include:
        • "TEXTRACT_DETECT_DOCUMENT_TEXT"
        • "TEXTRACT_ANALYZE_DOCUMENT"
      • DocumentReadMode — (String)

        Determines the text extraction actions for PDF files. Enter one of the following values:

        • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

        • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

        Possible values include:
        • "SERVICE_DEFAULT"
        • "FORCE_DOCUMENT_READ_ACTION"
      • FeatureTypes — (Array<String>)

        Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

        • TABLES - Returns additional information about any tables that are detected in the input document.

        • FORMS - Returns additional information about any forms that are detected in the input document.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Entities — (Array<map>)

        A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

        If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

        • Score — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of the detection.

        • Type — (String)

          The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

          For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

          Possible values include:
          • "PERSON"
          • "LOCATION"
          • "ORGANIZATION"
          • "COMMERCIAL_ITEM"
          • "EVENT"
          • "DATE"
          • "QUANTITY"
          • "TITLE"
          • "OTHER"
        • Text — (String)

          The text of the entity.

        • BeginOffset — (Integer)

          The zero-based offset from the beginning of the source text to the first character in the entity.

          This field is empty for non-text input.

        • EndOffset — (Integer)

          The zero-based offset from the beginning of the source text to the last character in the entity.

          This field is empty for non-text input.

        • BlockReferences — (Array<map>)

          A reference to each block for this entity. This field is empty for plain-text input.

          • BlockId — (String)

            Unique identifier for the block.

          • BeginOffset — (Integer)

            Offset of the start of the block within its parent block.

          • EndOffset — (Integer)

            Offset of the end of the block within its parent block.

          • ChildBlocks — (Array<map>)

            List of child blocks within this block.

            • ChildBlockId — (String)

              Unique identifier for the child block.

            • BeginOffset — (Integer)

              Offset of the start of the child block within its parent block.

            • EndOffset — (Integer)

              Offset of the end of the child block within its parent block.

      • DocumentMetadata — (map)

        Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

        • Pages — (Integer)

          Number of pages in the document.

        • ExtractedCharacters — (Array<map>)

          List of pages in the document, with the number of characters extracted from each page.

          • Page — (Integer)

            Page number.

          • Count — (Integer)

            Number of characters extracted from each page.

      • DocumentType — (Array<map>)

        The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

        • Page — (Integer)

          Page number.

        • Type — (String)

          Document type.

          Possible values include:
          • "NATIVE_PDF"
          • "SCANNED_PDF"
          • "MS_WORD"
          • "IMAGE"
          • "PLAIN_TEXT"
          • "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON"
          • "TEXTRACT_ANALYZE_DOCUMENT_JSON"
      • Blocks — (Array<map>)

        Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

        The Block content for a Word input document does not include a Geometry field.

        The Block field is not present in the response for plain-text inputs.

        • Id — (String)

          Unique identifier for the block.

        • BlockType — (String)

          The block represents a line of text or one word of text.

          • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

          • LINE - A string of tab-delimited, contiguous words that are detected on a document page

          Possible values include:
          • "LINE"
          • "WORD"
        • Text — (String)

          The word or line of text extracted from the block.

        • Page — (Integer)

          Page number where the block appears.

        • Geometry — (map)

          Co-ordinates of the rectangle or polygon that contains the text.

          • BoundingBox — (map)

            An axis-aligned coarse representation of the location of the recognized item on the document page.

            • Height — (Float)

              The height of the bounding box as a ratio of the overall document page height.

            • Left — (Float)

              The left coordinate of the bounding box as a ratio of overall document page width.

            • Top — (Float)

              The top coordinate of the bounding box as a ratio of overall document page height.

            • Width — (Float)

              The width of the bounding box as a ratio of the overall document page width.

          • Polygon — (Array<map>)

            Within the bounding box, a fine-grained polygon around the recognized item.

            • X — (Float)

              The value of the X coordinate for a point on a polygon

            • Y — (Float)

              The value of the Y coordinate for a point on a polygon

        • Relationships — (Array<map>)

          A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.

          • Ids — (Array<String>)

            Identifers of the child blocks.

          • Type — (String)

            Only supported relationship is a child relationship.

            Possible values include:
            • "CHILD"
      • Errors — (Array<map>)

        Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

        • Page — (Integer)

          Page number where the error occurred.

        • ErrorCode — (String)

          Error code for the cause of the error.

          Possible values include:
          • "TEXTRACT_BAD_PAGE"
          • "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED"
          • "PAGE_CHARACTERS_EXCEEDED"
          • "PAGE_SIZE_EXCEEDED"
          • "INTERNAL_SERVER_ERROR"
        • ErrorMessage — (String)

          Text message explaining the reason for the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectKeyPhrases(params = {}, callback) ⇒ AWS.Request

Detects the key noun phrases found in the text.

Service Reference:

Examples:

Calling the detectKeyPhrases operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  Text: 'STRING_VALUE' /* required */
};
comprehend.detectKeyPhrases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyPhrases — (Array<map>)

        A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

        • Score — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of the detection.

        • Text — (String)

          The text of a key noun phrase.

        • BeginOffset — (Integer)

          The zero-based offset from the beginning of the source text to the first character in the key phrase.

        • EndOffset — (Integer)

          The zero-based offset from the beginning of the source text to the last character in the key phrase.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectPiiEntities(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the detectPiiEntities operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  Text: 'STRING_VALUE' /* required */
};
comprehend.detectPiiEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

    • LanguageCode — (String)

      The language of the input text. Enter the language code for English (en) or Spanish (es).

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Entities — (Array<map>)

        A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

        • Score — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of the detection.

        • Type — (String)

          The entity's type.

          Possible values include:
          • "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"
        • BeginOffset — (Integer)

          The zero-based offset from the beginning of the source text to the first character in the entity.

        • EndOffset — (Integer)

          The zero-based offset from the beginning of the source text to the last character in the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectSentiment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the detectSentiment operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  Text: 'STRING_VALUE' /* required */
};
comprehend.detectSentiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Sentiment — (String)

        The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

        Possible values include:
        • "POSITIVE"
        • "NEGATIVE"
        • "NEUTRAL"
        • "MIXED"
      • SentimentScore — (map)

        An object that lists the sentiments, and their corresponding confidence levels.

        • Positive — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

        • Negative — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

        • Neutral — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

        • Mixed — (Float)

          The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectSyntax(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the detectSyntax operation

var params = {
  LanguageCode: en | es | fr | de | it | pt, /* required */
  Text: 'STRING_VALUE' /* required */
};
comprehend.detectSyntax(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

    • LanguageCode — (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").

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SyntaxTokens — (Array<map>)

        A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide.

        • TokenId — (Integer)

          A unique identifier for a token.

        • Text — (String)

          The word that was recognized in the source text.

        • BeginOffset — (Integer)

          The zero-based offset from the beginning of the source text to the first character in the word.

        • EndOffset — (Integer)

          The zero-based offset from the beginning of the source text to the last character in the word.

        • PartOfSpeech — (map)

          Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

          • Tag — (String)

            Identifies the part of speech that the token represents.

            Possible values include:
            • "ADJ"
            • "ADP"
            • "ADV"
            • "AUX"
            • "CONJ"
            • "CCONJ"
            • "DET"
            • "INTJ"
            • "NOUN"
            • "NUM"
            • "O"
            • "PART"
            • "PRON"
            • "PROPN"
            • "PUNCT"
            • "SCONJ"
            • "SYM"
            • "VERB"
          • Score — (Float)

            The confidence that Amazon Comprehend has that the part of speech was correctly identified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectTargetedSentiment(params = {}, callback) ⇒ AWS.Request

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 in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the detectTargetedSentiment operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  Text: 'STRING_VALUE' /* required */
};
comprehend.detectTargetedSentiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Text — (String)

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

    • LanguageCode — (String)

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

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Entities — (Array<map>)

        Targeted sentiment analysis for each of the entities identified in the input text.

        • DescriptiveMentionIndex — (Array<Integer>)

          One or more index into the Mentions array that provides the best name for the entity group.

        • Mentions — (Array<map>)

          An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.

          • Score — (Float)

            Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

          • GroupScore — (Float)

            The confidence that all the entities mentioned in the group relate to the same entity.

          • Text — (String)

            The text in the document that identifies the entity.

          • Type — (String)

            The type of the entity. Amazon Comprehend supports a variety of entity types.

            Possible values include:
            • "PERSON"
            • "LOCATION"
            • "ORGANIZATION"
            • "FACILITY"
            • "BRAND"
            • "COMMERCIAL_ITEM"
            • "MOVIE"
            • "MUSIC"
            • "BOOK"
            • "SOFTWARE"
            • "GAME"
            • "PERSONAL_TITLE"
            • "EVENT"
            • "DATE"
            • "QUANTITY"
            • "ATTRIBUTE"
            • "OTHER"
          • MentionSentiment — (map)

            Contains the sentiment and sentiment score for the mention.

            • Sentiment — (String)

              The sentiment of the mention.

              Possible values include:
              • "POSITIVE"
              • "NEGATIVE"
              • "NEUTRAL"
              • "MIXED"
            • SentimentScore — (map)

              Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

              • Positive — (Float)

                The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

              • Negative — (Float)

                The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

              • Neutral — (Float)

                The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

              • Mixed — (Float)

                The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

          • BeginOffset — (Integer)

            The offset into the document text where the mention begins.

          • EndOffset — (Integer)

            The offset into the document text where the mention ends.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detectToxicContent(params = {}, callback) ⇒ AWS.Request

Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the detectToxicContent operation

var params = {
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  TextSegments: [ /* required */
    {
      Text: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
comprehend.detectToxicContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TextSegments — (Array<map>)

      A list of up to 10 text strings. Each string has a maximum size of 1 KB, and the maximum size of the list is 10 KB.

      • Textrequired — (String)

        The text content.

    • LanguageCode — (String)

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

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResultList — (Array<map>)

        Results of the content moderation analysis. Each entry in the results list contains a list of toxic content types identified in the text, along with a confidence score for each content type. The results list also includes a toxicity score for each entry in the results list.

        • Labels — (Array<map>)

          Array of toxic content types identified in the string.

          • Name — (String)

            The name of the toxic content type.

            Possible values include:
            • "GRAPHIC"
            • "HARASSMENT_OR_ABUSE"
            • "HATE_SPEECH"
            • "INSULT"
            • "PROFANITY"
            • "SEXUAL"
            • "VIOLENCE_OR_THREAT"
          • Score — (Float)

            Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.

        • Toxicity — (Float)

          Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

importModel(params = {}, callback) ⇒ AWS.Request

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

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

The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

Service Reference:

Examples:

Calling the importModel operation

var params = {
  SourceModelArn: 'STRING_VALUE', /* required */
  DataAccessRoleArn: 'STRING_VALUE',
  ModelKmsKeyId: 'STRING_VALUE',
  ModelName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VersionName: 'STRING_VALUE'
};
comprehend.importModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SourceModelArn — (String)

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

    • ModelName — (String)

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

    • VersionName — (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/Region.

    • ModelKmsKeyId — (String)

      ID for the 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"

    • DataAccessRoleArn — (String)

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

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the custom model being imported.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDatasets(params = {}, callback) ⇒ AWS.Request

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the listDatasets operation

var params = {
  Filter: {
    CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    DatasetType: TRAIN | TEST,
    Status: CREATING | COMPLETED | FAILED
  },
  FlywheelArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listDatasets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel.

    • Filter — (map)

      Filters the datasets to be returned in the response.

      • Status — (String)

        Filter the datasets based on the dataset status.

        Possible values include:
        • "CREATING"
        • "COMPLETED"
        • "FAILED"
      • DatasetType — (String)

        Filter the datasets based on the dataset type.

        Possible values include:
        • "TRAIN"
        • "TEST"
      • CreationTimeAfter — (Date)

        Filter the datasets to include datasets created after the specified time.

      • CreationTimeBefore — (Date)

        Filter the datasets to include datasets created before the specified time.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

      Maximum number of results to return in a response. The default is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetPropertiesList — (Array<map>)

        The dataset properties list.

        • DatasetArn — (String)

          The ARN of the dataset.

        • DatasetName — (String)

          The name of the dataset.

        • DatasetType — (String)

          The dataset type (training data or test data).

          Possible values include:
          • "TRAIN"
          • "TEST"
        • DatasetS3Uri — (String)

          The S3 URI where the dataset is stored.

        • Description — (String)

          Description of the dataset.

        • Status — (String)

          The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

          Possible values include:
          • "CREATING"
          • "COMPLETED"
          • "FAILED"
        • Message — (String)

          A description of the status of the dataset.

        • NumberOfDocuments — (Integer)

          The number of documents in the dataset.

        • CreationTime — (Date)

          Creation time of the dataset.

        • EndTime — (Date)

          Time when the data from the dataset becomes available in the data lake.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDocumentClassificationJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDocumentClassificationJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listDocumentClassificationJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DocumentClassificationJobPropertiesList — (Array<map>)

        A list containing the properties of each job returned.

        • JobId — (String)

          The identifier assigned to the document classification job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the document classification job.

        • JobStatus — (String)

          The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of the job.

        • SubmitTime — (Date)

          The time that the document classification job was submitted for processing.

        • EndTime — (Date)

          The time that the document classification job completed.

        • DocumentClassifierArn — (String)

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

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the document classification job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the document classification job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDocumentClassifiers(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDocumentClassifiers operation

var params = {
  Filter: {
    DocumentClassifierName: 'STRING_VALUE',
    Status: SUBMITTED | TRAINING | DELETING | STOP_REQUESTED | STOPPED | IN_ERROR | TRAINED | TRAINED_WITH_WARNING,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listDocumentClassifiers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • Status — (String)

        Filters the list of classifiers based on status.

        Possible values include:
        • "SUBMITTED"
        • "TRAINING"
        • "DELETING"
        • "STOP_REQUESTED"
        • "STOPPED"
        • "IN_ERROR"
        • "TRAINED"
        • "TRAINED_WITH_WARNING"
      • DocumentClassifierName — (String)

        The name that you assigned to the document classifier

      • SubmitTimeBefore — (Date)

        Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DocumentClassifierPropertiesList — (Array<map>)

        A list containing the properties of each job returned.

        • DocumentClassifierArn — (String)

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

        • LanguageCode — (String)

          The language code for the language of the documents that the classifier was trained on.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • Status — (String)

          The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

          If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

          Possible values include:
          • "SUBMITTED"
          • "TRAINING"
          • "DELETING"
          • "STOP_REQUESTED"
          • "STOPPED"
          • "IN_ERROR"
          • "TRAINED"
          • "TRAINED_WITH_WARNING"
        • Message — (String)

          Additional information about the status of the classifier.

        • SubmitTime — (Date)

          The time that the document classifier was submitted for training.

        • EndTime — (Date)

          The time that training the document classifier completed.

        • TrainingStartTime — (Date)

          Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

        • TrainingEndTime — (Date)

          The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the document classifier for training.

          • DataFormat — (String)

            The format of your training data:

            • COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

            • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.

              If you use this value, you must provide the AugmentedManifests parameter in your request.

            If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

            Possible values include:
            • "COMPREHEND_CSV"
            • "AUGMENTED_MANIFEST"
          • S3Uri — (String)

            The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

            This parameter is required if you set DataFormat to COMPREHEND_CSV.

          • TestS3Uri — (String)

            This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

          • LabelDelimiter — (String)

            Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

          • AugmentedManifests — (Array<map>)

            A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

            This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

            • S3Urirequired — (String)

              The Amazon S3 location of the augmented manifest file.

            • Split — (String)

              The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

              TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

              TEST - all of the documents in the manifest will be used for testing.

              Possible values include:
              • "TRAIN"
              • "TEST"
            • AttributeNamesrequired — (Array<String>)

              The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

              If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

              If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

            • AnnotationDataS3Uri — (String)

              The S3 prefix to the annotation files that are referred in the augmented manifest file.

            • SourceDocumentsS3Uri — (String)

              The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

            • DocumentType — (String)

              The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

              • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

              • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

              Possible values include:
              • "PLAIN_TEXT_DOCUMENT"
              • "SEMI_STRUCTURED_DOCUMENT"
          • DocumentType — (String)

            The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.

            Possible values include:
            • "PLAIN_TEXT_DOCUMENT"
            • "SEMI_STRUCTURED_DOCUMENT"
          • Documents — (map)

            The S3 location of the training documents. This parameter is required in a request to create a native document model.

            • S3Urirequired — (String)

              The S3 URI location of the training documents specified in the S3Uri CSV file.

            • TestS3Uri — (String)

              The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file.

          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

            • Word files - Amazon Comprehend parser extracts the text.

            • Digital PDF files - Amazon Comprehend parser extracts the text.

            • Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.

            DocumentReaderConfig does not apply to plain text files or Word files.

            For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          Provides output results configuration parameters for custom classifier jobs.

          • S3Uri — (String)

            When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

            When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

          • FlywheelStatsS3Prefix — (String)

            The Amazon S3 prefix for the data lake location of the flywheel statistics.

        • ClassifierMetadata — (map)

          Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

          • NumberOfLabels — (Integer)

            The number of labels in the input data.

          • NumberOfTrainedDocuments — (Integer)

            The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

          • NumberOfTestDocuments — (Integer)

            The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

          • EvaluationMetrics — (map)

            Describes the result metrics for the test data associated with an documentation classifier.

            • Accuracy — (Float)

              The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

            • Precision — (Float)

              A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

            • Recall — (Float)

              A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

            • F1Score — (Float)

              A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

            • MicroPrecision — (Float)

              A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.

            • MicroRecall — (Float)

              A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.

            • MicroF1Score — (Float)

              A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.

            • HammingLoss — (Float)

              Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • Mode — (String)

          Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

          Possible values include:
          • "MULTI_CLASS"
          • "MULTI_LABEL"
        • ModelKmsKeyId — (String)

          ID for the 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"

        • VersionName — (String)

          The version name that you assigned to the document classifier.

        • SourceModelArn — (String)

          The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDocumentClassifierSummaries(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDocumentClassifierSummaries operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listDocumentClassifierSummaries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DocumentClassifierSummariesList — (Array<map>)

        The list of summaries of document classifiers.

        • DocumentClassifierName — (String)

          The name that you assigned the document classifier.

        • NumberOfVersions — (Integer)

          The number of versions you created.

        • LatestVersionCreatedAt — (Date)

          The time that the latest document classifier version was submitted for processing.

        • LatestVersionName — (String)

          The version name you assigned to the latest document classifier version.

        • LatestVersionStatus — (String)

          Provides the status of the latest document classifier version.

          Possible values include:
          • "SUBMITTED"
          • "TRAINING"
          • "DELETING"
          • "STOP_REQUESTED"
          • "STOPPED"
          • "IN_ERROR"
          • "TRAINED"
          • "TRAINED_WITH_WARNING"
      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDominantLanguageDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the listDominantLanguageDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listDominantLanguageDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DominantLanguageDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the dominant language detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the dominant language detection job.

        • JobStatus — (String)

          The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description for the status of a job.

        • SubmitTime — (Date)

          The time that the dominant language detection job was submitted for processing.

        • EndTime — (Date)

          The time that the dominant language detection job completed.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the dominant language detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the dominant language detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEndpoints(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listEndpoints operation

var params = {
  Filter: {
    CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ModelArn: 'STRING_VALUE',
    Status: CREATING | DELETING | FAILED | IN_SERVICE | UPDATING
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • ModelArn — (String)

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

      • Status — (String)

        Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "IN_SERVICE"
        • "UPDATING"
      • CreationTimeBefore — (Date)

        Specifies a date before which the returned endpoint or endpoints were created.

      • CreationTimeAfter — (Date)

        Specifies a date after which the returned endpoint or endpoints were created.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointPropertiesList — (Array<map>)

        Displays a list of endpoint properties being retrieved by the service in response to the request.

        • EndpointArn — (String)

          The Amazon Resource Number (ARN) of the endpoint.

        • Status — (String)

          Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "FAILED"
          • "IN_SERVICE"
          • "UPDATING"
        • Message — (String)

          Specifies a reason for failure in cases of Failed status.

        • ModelArn — (String)

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

        • DesiredModelArn — (String)

          ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

        • DesiredInferenceUnits — (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.

        • CurrentInferenceUnits — (Integer)

          The number of inference units currently used by the model using this endpoint.

        • CreationTime — (Date)

          The creation date and time of the endpoint.

        • LastModifiedTime — (Date)

          The date and time that the endpoint was last modified.

        • DataAccessRoleArn — (String)

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

        • DesiredDataAccessRoleArn — (String)

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

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEntitiesDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listEntitiesDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listEntitiesDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntitiesDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the entities detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned the entities detection job.

        • JobStatus — (String)

          The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the entities detection job was submitted for processing.

        • EndTime — (Date)

          The time that the entities detection job completed

        • EntityRecognizerArn — (String)

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

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the entities detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the entities detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • FlywheelArn — (String)

          The Amazon Resource Name (ARN) of the flywheel associated with this job.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEntityRecognizers(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listEntityRecognizers operation

var params = {
  Filter: {
    RecognizerName: 'STRING_VALUE',
    Status: SUBMITTED | TRAINING | DELETING | STOP_REQUESTED | STOPPED | IN_ERROR | TRAINED | TRAINED_WITH_WARNING,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listEntityRecognizers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

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

      • Status — (String)

        The status of an entity recognizer.

        Possible values include:
        • "SUBMITTED"
        • "TRAINING"
        • "DELETING"
        • "STOP_REQUESTED"
        • "STOPPED"
        • "IN_ERROR"
        • "TRAINED"
        • "TRAINED_WITH_WARNING"
      • RecognizerName — (String)

        The name that you assigned the entity recognizer.

      • SubmitTimeBefore — (Date)

        Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

      • SubmitTimeAfter — (Date)

        Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntityRecognizerPropertiesList — (Array<map>)

        The list of properties of an entity recognizer.

        • EntityRecognizerArn — (String)

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

        • LanguageCode — (String)

          The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • Status — (String)

          Provides the status of the entity recognizer.

          Possible values include:
          • "SUBMITTED"
          • "TRAINING"
          • "DELETING"
          • "STOP_REQUESTED"
          • "STOPPED"
          • "IN_ERROR"
          • "TRAINED"
          • "TRAINED_WITH_WARNING"
        • Message — (String)

          A description of the status of the recognizer.

        • SubmitTime — (Date)

          The time that the recognizer was submitted for processing.

        • EndTime — (Date)

          The time that the recognizer creation completed.

        • TrainingStartTime — (Date)

          The time that training of the entity recognizer started.

        • TrainingEndTime — (Date)

          The time that training of the entity recognizer was completed.

        • InputDataConfig — (map)

          The input data properties of an entity recognizer.

          • DataFormat — (String)

            The format of your training data:

            • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

              If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

            • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.

              If you use this value, you must provide the AugmentedManifests parameter in your request.

            If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

            Possible values include:
            • "COMPREHEND_CSV"
            • "AUGMENTED_MANIFEST"
          • EntityTypesrequired — (Array<map>)

            The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

            A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break), \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), space, and , (comma).

            • Typerequired — (String)

              An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

              Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break, \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), and , (comma).

          • Documents — (map)

            The S3 location of the folder that contains the training documents for your custom entity recognizer.

            This parameter is required if you set DataFormat to COMPREHEND_CSV.

            • S3Urirequired — (String)

              Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

            • TestS3Uri — (String)

              Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

            • InputFormat — (String)

              Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

              Possible values include:
              • "ONE_DOC_PER_FILE"
              • "ONE_DOC_PER_LINE"
          • Annotations — (map)

            The S3 location of the CSV file that annotates your training documents.

            • S3Urirequired — (String)

              Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

            • TestS3Uri — (String)

              Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

          • EntityList — (map)

            The S3 location of the CSV file that has the entity list for your custom entity recognizer.

            • S3Urirequired — (String)

              Specifies the Amazon S3 location where the entity list is located. The URI must be in the same Region as the API endpoint that you are calling.

          • AugmentedManifests — (Array<map>)

            A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

            This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

            • S3Urirequired — (String)

              The Amazon S3 location of the augmented manifest file.

            • Split — (String)

              The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

              TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

              TEST - all of the documents in the manifest will be used for testing.

              Possible values include:
              • "TRAIN"
              • "TEST"
            • AttributeNamesrequired — (Array<String>)

              The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

              If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

              If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

            • AnnotationDataS3Uri — (String)

              The S3 prefix to the annotation files that are referred in the augmented manifest file.

            • SourceDocumentsS3Uri — (String)

              The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

            • DocumentType — (String)

              The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

              • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

              • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

              Possible values include:
              • "PLAIN_TEXT_DOCUMENT"
              • "SEMI_STRUCTURED_DOCUMENT"
        • RecognizerMetadata — (map)

          Provides information about an entity recognizer.

          • NumberOfTrainedDocuments — (Integer)

            The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

          • NumberOfTestDocuments — (Integer)

            The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

          • EvaluationMetrics — (map)

            Detailed information about the accuracy of an entity recognizer.

            • Precision — (Float)

              A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

            • Recall — (Float)

              A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

            • F1Score — (Float)

              A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.

          • EntityTypes — (Array<map>)

            Entity types from the metadata of an entity recognizer.

            • Type — (String)

              Type of entity from the list of entity types in the metadata of an entity recognizer.

            • EvaluationMetrics — (map)

              Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

              • Precision — (Float)

                A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

              • Recall — (Float)

                A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

              • F1Score — (Float)

                A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

            • NumberOfTrainMentions — (Integer)

              Indicates the number of times the given entity type was seen in the training data.

        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • ModelKmsKeyId — (String)

          ID for the 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"

        • VersionName — (String)

          The version name you assigned to the entity recognizer.

        • SourceModelArn — (String)

          The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

        • OutputDataConfig — (map)

          Output data configuration.

          • FlywheelStatsS3Prefix — (String)

            The Amazon S3 prefix for the data lake location of the flywheel statistics.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEntityRecognizerSummaries(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listEntityRecognizerSummaries operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listEntityRecognizerSummaries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntityRecognizerSummariesList — (Array<map>)

        The list entity recognizer summaries.

        • RecognizerName — (String)

          The name that you assigned the entity recognizer.

        • NumberOfVersions — (Integer)

          The number of versions you created.

        • LatestVersionCreatedAt — (Date)

          The time that the latest entity recognizer version was submitted for processing.

        • LatestVersionName — (String)

          The version name you assigned to the latest entity recognizer version.

        • LatestVersionStatus — (String)

          Provides the status of the latest entity recognizer version.

          Possible values include:
          • "SUBMITTED"
          • "TRAINING"
          • "DELETING"
          • "STOP_REQUESTED"
          • "STOPPED"
          • "IN_ERROR"
          • "TRAINED"
          • "TRAINED_WITH_WARNING"
      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEventsDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listEventsDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listEventsDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the events detection job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

      The maximum number of results to return in each page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventsDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the events detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name you assigned the events detection job.

        • JobStatus — (String)

          The current status of the events detection job.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of the events detection job.

        • SubmitTime — (Date)

          The time that the events detection job was submitted for processing.

        • EndTime — (Date)

          The time that the events detection job completed.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the events detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the events detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • TargetEventTypes — (Array<String>)

          The types of events that are detected by the job.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFlywheelIterationHistory(params = {}, callback) ⇒ AWS.Request

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the listFlywheelIterationHistory operation

var params = {
  FlywheelArn: 'STRING_VALUE', /* required */
  Filter: {
    CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listFlywheelIterationHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The ARN of the flywheel.

    • Filter — (map)

      Filter the flywheel iteration history based on creation time.

      • CreationTimeAfter — (Date)

        Filter the flywheel iterations to include iterations created after the specified time.

      • CreationTimeBefore — (Date)

        Filter the flywheel iterations to include iterations created before the specified time.

    • NextToken — (String)

      Next token

    • MaxResults — (Integer)

      Maximum number of iteration history results to return

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelIterationPropertiesList — (Array<map>)

        List of flywheel iteration properties

        • FlywheelArn — (String)

        • FlywheelIterationId — (String)

        • CreationTime — (Date)

          The creation start time of the flywheel iteration.

        • EndTime — (Date)

          The completion time of this flywheel iteration.

        • Status — (String)

          The status of the flywheel iteration.

          Possible values include:
          • "TRAINING"
          • "EVALUATING"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of the flywheel iteration.

        • EvaluatedModelArn — (String)

          The ARN of the evaluated model associated with this flywheel iteration.

        • EvaluatedModelMetrics — (map)

          The evaluation metrics associated with the evaluated model.

          • AverageF1Score — (Float)

            The average F1 score from the evaluation metrics.

          • AveragePrecision — (Float)

            Average precision metric for the model.

          • AverageRecall — (Float)

            Average recall metric for the model.

          • AverageAccuracy — (Float)

            Average accuracy metric for the model.

        • TrainedModelArn — (String)

          The ARN of the trained model associated with this flywheel iteration.

        • TrainedModelMetrics — (map)

          The metrics associated with the trained model.

          • AverageF1Score — (Float)

            The average F1 score from the evaluation metrics.

          • AveragePrecision — (Float)

            Average precision metric for the model.

          • AverageRecall — (Float)

            Average recall metric for the model.

          • AverageAccuracy — (Float)

            Average accuracy metric for the model.

        • EvaluationManifestS3Prefix — (String)

      • NextToken — (String)

        Next token

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFlywheels(params = {}, callback) ⇒ AWS.Request

Gets a list of the flywheels that you have created.

Service Reference:

Examples:

Calling the listFlywheels operation

var params = {
  Filter: {
    CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Status: CREATING | ACTIVE | UPDATING | DELETING | FAILED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listFlywheels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

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

      • Status — (String)

        Filter the flywheels based on the flywheel status.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "FAILED"
      • CreationTimeAfter — (Date)

        Filter the flywheels to include flywheels created after the specified time.

      • CreationTimeBefore — (Date)

        Filter the flywheels to include flywheels created before the specified time.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

      Maximum number of results to return in a response. The default is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelSummaryList — (Array<map>)

        A list of flywheel properties retrieved by the service in response to the request.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel

        • ActiveModelArn — (String)

          ARN of the active model version for the flywheel.

        • DataLakeS3Uri — (String)

          Amazon S3 URI of the data lake location.

        • Status — (String)

          The status of the flywheel.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • ModelType — (String)

          Model type of the flywheel's model.

          Possible values include:
          • "DOCUMENT_CLASSIFIER"
          • "ENTITY_RECOGNIZER"
        • Message — (String)

          A description of the status of the flywheel.

        • CreationTime — (Date)

          Creation time of the flywheel.

        • LastModifiedTime — (Date)

          Last modified time for the flywheel.

        • LatestFlywheelIteration — (String)

          The most recent flywheel iteration.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listKeyPhrasesDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listKeyPhrasesDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listKeyPhrasesDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyPhrasesDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the key phrases detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned the key phrases detection job.

        • JobStatus — (String)

          The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the key phrases detection job was submitted for processing.

        • EndTime — (Date)

          The time that the key phrases detection job completed.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the key phrases detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the key phrases detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPiiEntitiesDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listPiiEntitiesDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listPiiEntitiesDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

      The maximum number of results to return in each page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PiiEntitiesDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the PII entities detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned the PII entities detection job.

        • JobStatus — (String)

          The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the PII entities detection job was submitted for processing.

        • EndTime — (Date)

          The time that the PII entities detection job completed.

        • InputDataConfig — (map)

          The input properties for a PII entities detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the PII entities detection job.

          • S3Urirequired — (String)

            When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

        • RedactionConfig — (map)

          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.

          • PiiEntityTypes — (Array<String>)

            An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

          • MaskMode — (String)

            Specifies whether the PII entity is redacted with the mask character or the entity type.

            Possible values include:
            • "MASK"
            • "REPLACE_WITH_PII_ENTITY_TYPE"
          • MaskCharacter — (String)

            A character that replaces each character in the redacted PII entity.

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • Mode — (String)

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

          Possible values include:
          • "ONLY_REDACTION"
          • "ONLY_OFFSETS"
      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSentimentDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSentimentDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listSentimentDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SentimentDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the sentiment detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the sentiment detection job

        • JobStatus — (String)

          The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the sentiment detection job was submitted for processing.

        • EndTime — (Date)

          The time that the sentiment detection job ended.

        • InputDataConfig — (map)

          The input data configuration that you supplied when you created the sentiment detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration that you supplied when you created the sentiment detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags associated with a given Amazon Comprehend resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
comprehend.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArn — (String)

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

      • Tags — (Array<map>)

        Tags associated with the Amazon Comprehend resource being queried. 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.

        • Keyrequired — (String)

          The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

        • Value — (String)

          The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTargetedSentimentDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the listTargetedSentimentDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listTargetedSentimentDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

        Filters on the name of the job.

      • JobStatus — (String)

        Filters the list of jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TargetedSentimentDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the targeted sentiment detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name that you assigned to the targeted sentiment detection job.

        • JobStatus — (String)

          The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description of the status of a job.

        • SubmitTime — (Date)

          The time that the targeted sentiment detection job was submitted for processing.

        • EndTime — (Date)

          The time that the targeted sentiment detection job ended.

        • InputDataConfig — (map)

          The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          Provides configuration parameters for the output of inference jobs.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • LanguageCode — (String)

          The language code of the input documents.

          Possible values include:
          • "en"
          • "es"
          • "fr"
          • "de"
          • "it"
          • "pt"
          • "ar"
          • "hi"
          • "ja"
          • "ko"
          • "zh"
          • "zh-TW"
        • DataAccessRoleArn — (String)

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

        • VolumeKmsKeyId — (String)

          ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:

          • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

          • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • VpcConfig — (map)

          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.

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTopicsDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTopicsDetectionJobs operation

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehend.listTopicsDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filter — (map)

      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.

      • JobName — (String)

      • JobStatus — (String)

        Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • SubmitTimeBefore — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

      • SubmitTimeAfter — (Date)

        Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TopicsDetectionJobPropertiesList — (Array<map>)

        A list containing the properties of each job that is returned.

        • JobId — (String)

          The identifier assigned to the topic detection job.

        • JobArn — (String)

          The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

          arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

          The following is an example job ARN:

          arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab

        • JobName — (String)

          The name of the topic detection job.

        • JobStatus — (String)

          The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STOP_REQUESTED"
          • "STOPPED"
        • Message — (String)

          A description for the status of a job.

        • SubmitTime — (Date)

          The time that the topic detection job was submitted for processing.

        • EndTime — (Date)

          The time that the topic detection job was completed.

        • InputDataConfig — (map)

          The input data configuration supplied when you created the topic detection job.

          • S3Urirequired — (String)

            The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

            For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

          • InputFormat — (String)

            Specifies how the text in an input file should be processed:

            • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

            • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

            Possible values include:
            • "ONE_DOC_PER_FILE"
            • "ONE_DOC_PER_LINE"
          • DocumentReaderConfig — (map)

            Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

            • DocumentReadActionrequired — (String)

              This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

              • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

              • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

              Possible values include:
              • "TEXTRACT_DETECT_DOCUMENT_TEXT"
              • "TEXTRACT_ANALYZE_DOCUMENT"
            • DocumentReadMode — (String)

              Determines the text extraction actions for PDF files. Enter one of the following values:

              • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

              • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

              Possible values include:
              • "SERVICE_DEFAULT"
              • "FORCE_DOCUMENT_READ_ACTION"
            • FeatureTypes — (Array<String>)

              Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

              • TABLES - Returns additional information about any tables that are detected in the input document.

              • FORMS - Returns additional information about any forms that are detected in the input document.

        • OutputDataConfig — (map)

          The output data configuration supplied when you created the topic detection job.

          • S3Urirequired — (String)

            When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

            When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

            For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

          • KmsKeyId — (String)

            ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

            The KmsKeyId can be one 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"

            • KMS Key Alias: "alias/ExampleAlias"

            • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        • NumberOfTopics — (Integer)

          The number of topics to detect supplied when you created the topic detection job. The default is 10.

        • DataAccessRoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.

        • VolumeKmsKeyId — (String)

          ID for the Amazon Web Services 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"

        • VpcConfig — (map)

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

          • SecurityGroupIdsrequired — (Array<String>)

            The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

          • Subnetsrequired — (Array<String>)

            The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  ResourcePolicy: 'STRING_VALUE', /* required */
  PolicyRevisionId: 'STRING_VALUE'
};
comprehend.putResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • ResourcePolicy — (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"]}'

    • PolicyRevisionId — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyRevisionId — (String)

        The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startDocumentClassificationJob(params = {}, callback) ⇒ AWS.Request

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

Service Reference:

Examples:

Calling the startDocumentClassificationJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  DocumentClassifierArn: 'STRING_VALUE',
  FlywheelArn: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startDocumentClassificationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobName — (String)

      The identifier of the job.

    • DocumentClassifierArn — (String)

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

    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

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

    • ClientRequestToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job:

        • SUBMITTED - The job has been received and queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

        • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

        • STOPPED - The job was successfully stopped without completing.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • DocumentClassifierArn — (String)

        The ARN of the custom classification model.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startDominantLanguageDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the startDominantLanguageDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startDominantLanguageDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    • JobName — (String)

      An identifier for the job.

    • ClientRequestToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of a job, use this identifier with the operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job.

        • SUBMITTED - The job has been received and is queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. To get details, use the operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startEntitiesDetectionJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startEntitiesDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  EntityRecognizerArn: 'STRING_VALUE',
  FlywheelArn: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startEntitiesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    • JobName — (String)

      The identifier of the job.

    • EntityRecognizerArn — (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.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of job, use this identifier with the operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job.

        • SUBMITTED - The job has been received and is queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. To get details, use the operation.

        • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

        • STOPPED - The job was successfully stopped without completing.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • EntityRecognizerArn — (String)

        The ARN of the custom entity recognition model.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startEventsDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startEventsDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  TargetEventTypes: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
comprehend.startEventsDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

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

    • JobName — (String)

      The identifier of the events detection job.

    • LanguageCode — (String)

      The language code of the input documents.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • ClientRequestToken — (String)

      An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TargetEventTypes — (Array<String>)

      The types of events to detect in the input documents.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the events detection job.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startFlywheelIteration(params = {}, callback) ⇒ AWS.Request

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Service Reference:

Examples:

Calling the startFlywheelIteration operation

var params = {
  FlywheelArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
comprehend.startFlywheelIteration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The ARN of the flywheel.

    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelArn — (String)

      • FlywheelIterationId — (String)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startKeyPhrasesDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startKeyPhrasesDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startKeyPhrasesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    • JobName — (String)

      The identifier of the job.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of a job, use this identifier with the operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job.

        • SUBMITTED - The job has been received and is queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. To get details, use the operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startPiiEntitiesDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startPiiEntitiesDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  Mode: ONLY_REDACTION | ONLY_OFFSETS, /* required */
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  RedactionConfig: {
    MaskCharacter: 'STRING_VALUE',
    MaskMode: MASK | REPLACE_WITH_PII_ENTITY_TYPE,
    PiiEntityTypes: [
      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,
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
comprehend.startPiiEntitiesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

      The input properties for a PII entities detection job.

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Provides configuration parameters for the output of PII entity detection jobs.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • Mode — (String)

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

      Possible values include:
      • "ONLY_REDACTION"
      • "ONLY_OFFSETS"
    • RedactionConfig — (map)

      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.

      • PiiEntityTypes — (Array<String>)

        An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

      • MaskMode — (String)

        Specifies whether the PII entity is redacted with the mask character or the entity type.

        Possible values include:
        • "MASK"
        • "REPLACE_WITH_PII_ENTITY_TYPE"
      • MaskCharacter — (String)

        A character that replaces each character in the redacted PII entity.

    • DataAccessRoleArn — (String)

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

    • JobName — (String)

      The identifier of the job.

    • LanguageCode — (String)

      The language of the input documents. Enter the language code for English (en) or Spanish (es).

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startSentimentDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startSentimentDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startSentimentDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    • JobName — (String)

      The identifier of the job.

    • LanguageCode — (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.

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of a job, use this identifier with the operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job.

        • SUBMITTED - The job has been received and is queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. To get details, use the operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startTargetedSentimentDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the startTargetedSentimentDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  LanguageCode: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW, /* required */
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startTargetedSentimentDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

      The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    • JobName — (String)

      The identifier of the job.

    • LanguageCode — (String)

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

      Possible values include:
      • "en"
      • "es"
      • "fr"
      • "de"
      • "it"
      • "pt"
      • "ar"
      • "hi"
      • "ja"
      • "ko"
      • "zh"
      • "zh-TW"
    • ClientRequestToken — (String)

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of a job, use this identifier with the DescribeTargetedSentimentDetectionJob operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job.

        • SUBMITTED - The job has been received and is queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startTopicsDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startTopicsDetectionJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    DocumentReaderConfig: {
      DocumentReadAction: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT, /* required */
      DocumentReadMode: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION,
      FeatureTypes: [
        TABLES | FORMS,
        /* more items */
      ]
    },
    InputFormat: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE
  },
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  NumberOfTopics: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VolumeKmsKeyId: 'STRING_VALUE',
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
comprehend.startTopicsDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InputDataConfig — (map)

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

      • S3Urirequired — (String)

        The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

        For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

      • InputFormat — (String)

        Specifies how the text in an input file should be processed:

        • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

        • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

        Possible values include:
        • "ONE_DOC_PER_FILE"
        • "ONE_DOC_PER_LINE"
      • DocumentReaderConfig — (map)

        Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

        • DocumentReadActionrequired — (String)

          This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

          • TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.

          • TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.

          Possible values include:
          • "TEXTRACT_DETECT_DOCUMENT_TEXT"
          • "TEXTRACT_ANALYZE_DOCUMENT"
        • DocumentReadMode — (String)

          Determines the text extraction actions for PDF files. Enter one of the following values:

          • SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

          • FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

          Possible values include:
          • "SERVICE_DEFAULT"
          • "FORCE_DOCUMENT_READ_ACTION"
        • FeatureTypes — (Array<String>)

          Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

          • TABLES - Returns additional information about any tables that are detected in the input document.

          • FORMS - Returns additional information about any forms that are detected in the input document.

    • OutputDataConfig — (map)

      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

      • S3Urirequired — (String)

        When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

        When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

        For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      • KmsKeyId — (String)

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

        The KmsKeyId can be one 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"

        • KMS Key Alias: "alias/ExampleAlias"

        • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    • JobName — (String)

      The identifier of the job.

    • NumberOfTopics — (Integer)

      The number of topics to detect.

    • ClientRequestToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeKmsKeyId — (String)

      ID for the Amazon Web Services 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"

    • VpcConfig — (map)

      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.

      • SecurityGroupIdsrequired — (Array<String>)

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

      • Subnetsrequired — (Array<String>)

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

    • Tags — (Array<map>)

      Tags to associate 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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

      • JobArn — (String)

        The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

        arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

      • JobStatus — (String)

        The status of the job:

        • SUBMITTED - The job has been received and is queued for processing.

        • IN_PROGRESS - Amazon Comprehend is processing the job.

        • COMPLETED - The job was successfully completed and the output is available.

        • FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopDominantLanguageDetectionJob(params = {}, callback) ⇒ AWS.Request

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:

Calling the stopDominantLanguageDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopDominantLanguageDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the dominant language detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the dominant language detection job to stop.

      • JobStatus — (String)

        Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopEntitiesDetectionJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopEntitiesDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopEntitiesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the entities detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the entities detection job to stop.

      • JobStatus — (String)

        Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopEventsDetectionJob(params = {}, callback) ⇒ AWS.Request

Stops an events detection job in progress.

Service Reference:

Examples:

Calling the stopEventsDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopEventsDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the events detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the events detection job to stop.

      • JobStatus — (String)

        The status of the events detection job.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopKeyPhrasesDetectionJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopKeyPhrasesDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopKeyPhrasesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the key phrases detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the key phrases detection job to stop.

      • JobStatus — (String)

        Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopPiiEntitiesDetectionJob(params = {}, callback) ⇒ AWS.Request

Stops a PII entities detection job in progress.

Service Reference:

Examples:

Calling the stopPiiEntitiesDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopPiiEntitiesDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the PII entities detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the PII entities detection job to stop.

      • JobStatus — (String)

        The status of the PII entities detection job.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopSentimentDetectionJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopSentimentDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopSentimentDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the sentiment detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the sentiment detection job to stop.

      • JobStatus — (String)

        Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopTargetedSentimentDetectionJob(params = {}, callback) ⇒ AWS.Request

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:

Calling the stopTargetedSentimentDetectionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehend.stopTargetedSentimentDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The identifier of the targeted sentiment detection job to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier of the targeted sentiment detection job to stop.

      • JobStatus — (String)

        Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopTrainingDocumentClassifier(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopTrainingDocumentClassifier operation

var params = {
  DocumentClassifierArn: 'STRING_VALUE' /* required */
};
comprehend.stopTrainingDocumentClassifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DocumentClassifierArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopTrainingEntityRecognizer(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopTrainingEntityRecognizer operation

var params = {
  EntityRecognizerArn: 'STRING_VALUE' /* required */
};
comprehend.stopTrainingEntityRecognizer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EntityRecognizerArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
comprehend.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • Tags — (Array<map>)

      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.

      • Keyrequired — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

      • Value — (String)

        The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a specific tag associated with an Amazon Comprehend resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
comprehend.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • TagKeys — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEndpoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateEndpoint operation

var params = {
  EndpointArn: 'STRING_VALUE', /* required */
  DesiredDataAccessRoleArn: 'STRING_VALUE',
  DesiredInferenceUnits: 'NUMBER_VALUE',
  DesiredModelArn: 'STRING_VALUE',
  FlywheelArn: 'STRING_VALUE'
};
comprehend.updateEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EndpointArn — (String)

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

    • DesiredModelArn — (String)

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

    • DesiredInferenceUnits — (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.

    • DesiredDataAccessRoleArn — (String)

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

    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DesiredModelArn — (String)

        The Amazon Resource Number (ARN) of the new model.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFlywheel(params = {}, callback) ⇒ AWS.Request

Update the configuration information for an existing flywheel.

Service Reference:

Examples:

Calling the updateFlywheel operation

var params = {
  FlywheelArn: 'STRING_VALUE', /* required */
  ActiveModelArn: 'STRING_VALUE',
  DataAccessRoleArn: 'STRING_VALUE',
  DataSecurityConfig: {
    ModelKmsKeyId: 'STRING_VALUE',
    VolumeKmsKeyId: 'STRING_VALUE',
    VpcConfig: {
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
comprehend.updateFlywheel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FlywheelArn — (String)

      The Amazon Resource Number (ARN) of the flywheel to update.

    • ActiveModelArn — (String)

      The Amazon Resource Number (ARN) of the active model version.

    • DataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

    • DataSecurityConfig — (map)

      Flywheel data security configuration.

      • ModelKmsKeyId — (String)

        ID for the 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"

      • VolumeKmsKeyId — (String)

        ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

      • VpcConfig — (map)

        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.

        • SecurityGroupIdsrequired — (Array<String>)

          The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

        • Subnetsrequired — (Array<String>)

          The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlywheelProperties — (map)

        The flywheel properties.

        • FlywheelArn — (String)

          The Amazon Resource Number (ARN) of the flywheel.

        • ActiveModelArn — (String)

          The Amazon Resource Number (ARN) of the active model version.

        • DataAccessRoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

        • TaskConfig — (map)

          Configuration about the model associated with a flywheel.

          • LanguageCoderequired — (String)

            Language code for the language that the model supports.

            Possible values include:
            • "en"
            • "es"
            • "fr"
            • "de"
            • "it"
            • "pt"
            • "ar"
            • "hi"
            • "ja"
            • "ko"
            • "zh"
            • "zh-TW"
          • DocumentClassificationConfig — (map)

            Configuration required for a document classification model.

            • Moderequired — (String)

              Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

              Possible values include:
              • "MULTI_CLASS"
              • "MULTI_LABEL"
            • Labels — (Array<String>)

              One or more labels to associate with the custom classifier.

          • EntityRecognitionConfig — (map)

            Configuration required for an entity recognition model.

            • EntityTypesrequired — (Array<map>)

              Up to 25 entity types that the model is trained to recognize.

              • Typerequired — (String)

                An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

                Entity types must not contain the following invalid characters: \n (line break), \n (escaped line break, \r (carriage return), \r (escaped carriage return), \t (tab), \t (escaped tab), and , (comma).

        • DataLakeS3Uri — (String)

          Amazon S3 URI of the data lake location.

        • DataSecurityConfig — (map)

          Data security configuration.

          • ModelKmsKeyId — (String)

            ID for the 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"

          • VolumeKmsKeyId — (String)

            ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

          • DataLakeKmsKeyId — (String)

            ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.

          • VpcConfig — (map)

            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.

            • SecurityGroupIdsrequired — (Array<String>)

              The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

            • Subnetsrequired — (Array<String>)

              The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

        • Status — (String)

          The status of the flywheel.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • ModelType — (String)

          Model type of the flywheel's model.

          Possible values include:
          • "DOCUMENT_CLASSIFIER"
          • "ENTITY_RECOGNIZER"
        • Message — (String)

          A description of the status of the flywheel.

        • CreationTime — (Date)

          Creation time of the flywheel.

        • LastModifiedTime — (Date)

          Last modified time for the flywheel.

        • LatestFlywheelIteration — (String)

          The most recent flywheel iteration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.