Comprehend

This page documents function available when using the Comprehend module, created with @service Comprehend.

Index

Documentation

Main.Comprehend.batch_detect_dominant_languageMethod
batch_detect_dominant_language(text_list)
batch_detect_dominant_language(text_list, params::Dict{String,<:Any})

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.

Arguments

  • text_list: 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.
Main.Comprehend.batch_detect_entitiesMethod
batch_detect_entities(language_code, text_list)
batch_detect_entities(language_code, text_list, params::Dict{String,<:Any})

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.

Arguments

  • language_code: 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.
  • text_list: 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.
Main.Comprehend.batch_detect_key_phrasesMethod
batch_detect_key_phrases(language_code, text_list)
batch_detect_key_phrases(language_code, text_list, params::Dict{String,<:Any})

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

Arguments

  • language_code: 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.
  • text_list: 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.
Main.Comprehend.batch_detect_sentimentMethod
batch_detect_sentiment(language_code, text_list)
batch_detect_sentiment(language_code, text_list, params::Dict{String,<:Any})

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

Arguments

  • language_code: 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.
  • text_list: 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.
Main.Comprehend.batch_detect_syntaxMethod
batch_detect_syntax(language_code, text_list)
batch_detect_syntax(language_code, text_list, params::Dict{String,<:Any})

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.

Arguments

  • language_code: 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.
  • text_list: 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.
Main.Comprehend.batch_detect_targeted_sentimentMethod
batch_detect_targeted_sentiment(language_code, text_list)
batch_detect_targeted_sentiment(language_code, text_list, params::Dict{String,<:Any})

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.

Arguments

  • language_code: The language of the input documents. Currently, English is the only supported language.
  • text_list: 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.
Main.Comprehend.classify_documentMethod
classify_document(endpoint_arn)
classify_document(endpoint_arn, params::Dict{String,<:Any})

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint. 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 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.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Bytes": Use the Bytes parameter to input a text, PDF, Word or image file. 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 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": Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
  • "Text": The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.
Main.Comprehend.contains_pii_entitiesMethod
contains_pii_entities(language_code, text)
contains_pii_entities(language_code, text, params::Dict{String,<:Any})

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.

Arguments

  • language_code: The language of the input documents. Currently, English is the only valid language.
  • text: A UTF-8 text string. The maximum string size is 100 KB.
Main.Comprehend.create_datasetMethod
create_dataset(dataset_name, flywheel_arn, input_data_config)
create_dataset(dataset_name, flywheel_arn, input_data_config, params::Dict{String,<:Any})

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.

Arguments

  • dataset_name: Name of the dataset.
  • flywheel_arn: The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
  • input_data_config: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "DatasetType": The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
  • "Description": Description of the dataset.
  • "Tags": Tags for the dataset.
Main.Comprehend.create_document_classifierMethod
create_document_classifier(data_access_role_arn, document_classifier_name, input_data_config, language_code)
create_document_classifier(data_access_role_arn, document_classifier_name, input_data_config, language_code, params::Dict{String,<:Any})

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.

Arguments

  • data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  • document_classifier_name: The name of the document classifier.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "Mode": Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
  • "ModelKmsKeyId": 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": 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"]}'
  • "OutputDataConfig": Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native classifier model.
  • "Tags": 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.
  • "VersionName": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.create_endpointMethod
create_endpoint(desired_inference_units, endpoint_name)
create_endpoint(desired_inference_units, endpoint_name, params::Dict{String,<:Any})

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

Arguments

  • desired_inference_units: 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.
  • endpoint_name: This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
  • "DataAccessRoleArn": 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": The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
  • "ModelArn": The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
  • "Tags": 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.
Main.Comprehend.create_entity_recognizerMethod
create_entity_recognizer(data_access_role_arn, input_data_config, language_code, recognizer_name)
create_entity_recognizer(data_access_role_arn, input_data_config, language_code, recognizer_name, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  • input_data_config: 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.
  • language_code: 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.
  • recognizer_name: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "ModelKmsKeyId": 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": 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"]}'
  • "Tags": 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.
  • "VersionName": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.create_flywheelMethod
create_flywheel(data_access_role_arn, data_lake_s3_uri, flywheel_name)
create_flywheel(data_access_role_arn, data_lake_s3_uri, flywheel_name, params::Dict{String,<:Any})

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.

Arguments

  • data_access_role_arn: 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.
  • data_lake_s3_uri: 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.
  • flywheel_name: Name for the flywheel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ActiveModelArn": To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "DataSecurityConfig": Data security configurations.
  • "ModelType": The model type.
  • "Tags": The tags to associate with this flywheel.
  • "TaskConfig": Configuration about the custom classifier associated with the flywheel.
Main.Comprehend.delete_document_classifierMethod
delete_document_classifier(document_classifier_arn)
delete_document_classifier(document_classifier_arn, params::Dict{String,<:Any})

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.

Arguments

  • document_classifier_arn: The Amazon Resource Name (ARN) that identifies the document classifier.
Main.Comprehend.delete_endpointMethod
delete_endpoint(endpoint_arn)
delete_endpoint(endpoint_arn, params::Dict{String,<:Any})

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.

Arguments

  • endpoint_arn: The Amazon Resource Number (ARN) of the endpoint being deleted.
Main.Comprehend.delete_entity_recognizerMethod
delete_entity_recognizer(entity_recognizer_arn)
delete_entity_recognizer(entity_recognizer_arn, params::Dict{String,<:Any})

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.

Arguments

  • entity_recognizer_arn: The Amazon Resource Name (ARN) that identifies the entity recognizer.
Main.Comprehend.delete_flywheelMethod
delete_flywheel(flywheel_arn)
delete_flywheel(flywheel_arn, params::Dict{String,<:Any})

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.

Arguments

  • flywheel_arn: The Amazon Resource Number (ARN) of the flywheel to delete.
Main.Comprehend.delete_resource_policyMethod
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "PolicyRevisionId": The revision ID of the policy to delete.
Main.Comprehend.describe_datasetMethod
describe_dataset(dataset_arn)
describe_dataset(dataset_arn, params::Dict{String,<:Any})

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

Arguments

  • dataset_arn: The ARN of the dataset.
Main.Comprehend.describe_document_classification_jobMethod
describe_document_classification_job(job_id)
describe_document_classification_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob operation returns this identifier in its response.
Main.Comprehend.describe_document_classifierMethod
describe_document_classifier(document_classifier_arn)
describe_document_classifier(document_classifier_arn, params::Dict{String,<:Any})

Gets the properties associated with a document classifier.

Arguments

  • document_classifier_arn: The Amazon Resource Name (ARN) that identifies the document classifier. The CreateDocumentClassifier operation returns this identifier in its response.
Main.Comprehend.describe_dominant_language_detection_jobMethod
describe_dominant_language_detection_job(job_id)
describe_dominant_language_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob operation returns this identifier in its response.
Main.Comprehend.describe_endpointMethod
describe_endpoint(endpoint_arn)
describe_endpoint(endpoint_arn, params::Dict{String,<:Any})

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.

Arguments

  • endpoint_arn: The Amazon Resource Number (ARN) of the endpoint being described.
Main.Comprehend.describe_entities_detection_jobMethod
describe_entities_detection_job(job_id)
describe_entities_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.
Main.Comprehend.describe_entity_recognizerMethod
describe_entity_recognizer(entity_recognizer_arn)
describe_entity_recognizer(entity_recognizer_arn, params::Dict{String,<:Any})

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

Arguments

  • entity_recognizer_arn: The Amazon Resource Name (ARN) that identifies the entity recognizer.
Main.Comprehend.describe_events_detection_jobMethod
describe_events_detection_job(job_id)
describe_events_detection_job(job_id, params::Dict{String,<:Any})

Gets the status and details of an events detection job.

Arguments

  • job_id: The identifier of the events detection job.
Main.Comprehend.describe_flywheelMethod
describe_flywheel(flywheel_arn)
describe_flywheel(flywheel_arn, params::Dict{String,<:Any})

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

Arguments

  • flywheel_arn: The Amazon Resource Number (ARN) of the flywheel.
Main.Comprehend.describe_flywheel_iterationMethod
describe_flywheel_iteration(flywheel_arn, flywheel_iteration_id)
describe_flywheel_iteration(flywheel_arn, flywheel_iteration_id, params::Dict{String,<:Any})

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Arguments

  • flywheel_arn:
  • flywheel_iteration_id:
Main.Comprehend.describe_key_phrases_detection_jobMethod
describe_key_phrases_detection_job(job_id)
describe_key_phrases_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.
Main.Comprehend.describe_pii_entities_detection_jobMethod
describe_pii_entities_detection_job(job_id)
describe_pii_entities_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
Main.Comprehend.describe_resource_policyMethod
describe_resource_policy(resource_arn)
describe_resource_policy(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
Main.Comprehend.describe_sentiment_detection_jobMethod
describe_sentiment_detection_job(job_id)
describe_sentiment_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
Main.Comprehend.describe_targeted_sentiment_detection_jobMethod
describe_targeted_sentiment_detection_job(job_id)
describe_targeted_sentiment_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob operation returns this identifier in its response.
Main.Comprehend.describe_topics_detection_jobMethod
describe_topics_detection_job(job_id)
describe_topics_detection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier assigned by the user to the detection job.
Main.Comprehend.detect_dominant_languageMethod
detect_dominant_language(text)
detect_dominant_language(text, params::Dict{String,<:Any})

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

Arguments

  • text: A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
Main.Comprehend.detect_entitiesMethod
detect_entities()
detect_entities(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Bytes": 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": Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
  • "EndpointArn": 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.
  • "LanguageCode": 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.
  • "Text": 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.
Main.Comprehend.detect_key_phrasesMethod
detect_key_phrases(language_code, text)
detect_key_phrases(language_code, text, params::Dict{String,<:Any})

Detects the key noun phrases found in the text.

Arguments

  • language_code: 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.
  • text: A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
Main.Comprehend.detect_pii_entitiesMethod
detect_pii_entities(language_code, text)
detect_pii_entities(language_code, text, params::Dict{String,<:Any})

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

Arguments

  • language_code: The language of the input documents. Currently, English is the only valid language.
  • text: A UTF-8 text string. The maximum string size is 100 KB.
Main.Comprehend.detect_sentimentMethod
detect_sentiment(language_code, text)
detect_sentiment(language_code, text, params::Dict{String,<:Any})

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

Arguments

  • language_code: 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.
  • text: A UTF-8 text string. The maximum string size is 5 KB.
Main.Comprehend.detect_syntaxMethod
detect_syntax(language_code, text)
detect_syntax(language_code, text, params::Dict{String,<:Any})

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

Arguments

  • language_code: 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").
  • text: A UTF-8 string. The maximum string size is 5 KB.
Main.Comprehend.detect_targeted_sentimentMethod
detect_targeted_sentiment(language_code, text)
detect_targeted_sentiment(language_code, text, params::Dict{String,<:Any})

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.

Arguments

  • language_code: The language of the input documents. Currently, English is the only supported language.
  • text: A UTF-8 text string. The maximum string length is 5 KB.
Main.Comprehend.import_modelMethod
import_model(source_model_arn)
import_model(source_model_arn, params::Dict{String,<:Any})

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.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DataAccessRoleArn": 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.
  • "ModelKmsKeyId": 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"
  • "ModelName": The name to assign to the custom model that is created in Amazon Comprehend by this import.
  • "Tags": 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.
  • "VersionName": 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.
Main.Comprehend.list_datasetsMethod
list_datasets()
list_datasets(params::Dict{String,<:Any})

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the datasets to be returned in the response.
  • "FlywheelArn": The Amazon Resource Number (ARN) of the flywheel.
  • "MaxResults": Maximum number of results to return in a response. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_document_classification_jobsMethod
list_document_classification_jobs()
list_document_classification_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": 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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_document_classifier_summariesMethod
list_document_classifier_summaries()
list_document_classifier_summaries(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return on each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_document_classifiersMethod
list_document_classifiers()
list_document_classifiers(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_dominant_language_detection_jobsMethod
list_dominant_language_detection_jobs()
list_dominant_language_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": 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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_endpointsMethod
list_endpoints()
list_endpoints(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": 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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_entities_detection_jobsMethod
list_entities_detection_jobs()
list_entities_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_entity_recognizer_summariesMethod
list_entity_recognizer_summaries()
list_entity_recognizer_summaries(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return on each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_entity_recognizersMethod
list_entity_recognizers()
list_entity_recognizers(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return on each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_events_detection_jobsMethod
list_events_detection_jobs()
list_events_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_flywheel_iteration_historyMethod
list_flywheel_iteration_history(flywheel_arn)
list_flywheel_iteration_history(flywheel_arn, params::Dict{String,<:Any})

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Arguments

  • flywheel_arn: The ARN of the flywheel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filter the flywheel iteration history based on creation time.
  • "MaxResults": Maximum number of iteration history results to return
  • "NextToken": Next token
Main.Comprehend.list_flywheelsMethod
list_flywheels()
list_flywheels(params::Dict{String,<:Any})

Gets a list of the flywheels that you have created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": 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.
  • "MaxResults": Maximum number of results to return in a response. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_key_phrases_detection_jobsMethod
list_key_phrases_detection_jobs()
list_key_phrases_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_pii_entities_detection_jobsMethod
list_pii_entities_detection_jobs()
list_pii_entities_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_sentiment_detection_jobsMethod
list_sentiment_detection_jobs()
list_sentiment_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists all tags associated with a given Amazon Comprehend resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
Main.Comprehend.list_targeted_sentiment_detection_jobsMethod
list_targeted_sentiment_detection_jobs()
list_targeted_sentiment_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.list_topics_detection_jobsMethod
list_topics_detection_jobs()
list_topics_detection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": 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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehend.put_resource_policyMethod
put_resource_policy(resource_arn, resource_policy)
put_resource_policy(resource_arn, resource_policy, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the custom model to attach the policy to.
  • resource_policy: 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"]}'

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "PolicyRevisionId": 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.
Main.Comprehend.start_document_classification_jobMethod
start_document_classification_job(data_access_role_arn, input_data_config, output_data_config)
start_document_classification_job(data_access_role_arn, input_data_config, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  • input_data_config: Specifies the format and location of the input data for the job.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
  • "DocumentClassifierArn": The Amazon Resource Name (ARN) of the document classifier to use to process the job.
  • "FlywheelArn": The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
  • "JobName": The identifier of the job.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.start_dominant_language_detection_jobMethod
start_dominant_language_detection_job(data_access_role_arn, input_data_config, output_data_config)
start_dominant_language_detection_job(data_access_role_arn, input_data_config, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
  • "JobName": An identifier for the job.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.start_entities_detection_jobMethod
start_entities_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_entities_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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.

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: 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.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "EntityRecognizerArn": 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.
  • "FlywheelArn": The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
  • "JobName": The identifier of the job.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.start_events_detection_jobMethod
start_events_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, target_event_types)
start_events_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, target_event_types, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: The language code of the input documents.
  • output_data_config: Specifies where to send the output files.
  • target_event_types: The types of events to detect in the input documents.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "JobName": The identifier of the events detection job.
  • "Tags": 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.
Main.Comprehend.start_flywheel_iterationMethod
start_flywheel_iteration(flywheel_arn)
start_flywheel_iteration(flywheel_arn, params::Dict{String,<:Any})

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.

Arguments

  • flywheel_arn: The ARN of the flywheel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Main.Comprehend.start_key_phrases_detection_jobMethod
start_key_phrases_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_key_phrases_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: 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.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "JobName": The identifier of the job.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.start_pii_entities_detection_jobMethod
start_pii_entities_detection_job(data_access_role_arn, input_data_config, language_code, mode, output_data_config)
start_pii_entities_detection_job(data_access_role_arn, input_data_config, language_code, mode, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  • input_data_config: The input properties for a PII entities detection job.
  • language_code: The language of the input documents. Currently, English is the only valid language.
  • mode: Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
  • output_data_config: Provides configuration parameters for the output of PII entity detection jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "JobName": The identifier of the job.
  • "RedactionConfig": Provides configuration parameters for PII entity redaction. This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
  • "Tags": 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.
Main.Comprehend.start_sentiment_detection_jobMethod
start_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: 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.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "JobName": The identifier of the job.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.start_targeted_sentiment_detection_jobMethod
start_targeted_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_targeted_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config:
  • language_code: The language of the input documents. Currently, English is the only supported language.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  • "JobName": The identifier of the job.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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":
Main.Comprehend.start_topics_detection_jobMethod
start_topics_detection_job(data_access_role_arn, input_data_config, output_data_config)
start_topics_detection_job(data_access_role_arn, input_data_config, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • output_data_config: 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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
  • "JobName": The identifier of the job.
  • "NumberOfTopics": The number of topics to detect.
  • "Tags": 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.
  • "VolumeKmsKeyId": 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": 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.
Main.Comprehend.stop_dominant_language_detection_jobMethod
stop_dominant_language_detection_job(job_id)
stop_dominant_language_detection_job(job_id, params::Dict{String,<:Any})

Stops a dominant language detection job in progress. If the job state is INPROGRESS the job is marked for termination and put into the STOPREQUESTED 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.

Arguments

  • job_id: The identifier of the dominant language detection job to stop.
Main.Comprehend.stop_entities_detection_jobMethod
stop_entities_detection_job(job_id)
stop_entities_detection_job(job_id, params::Dict{String,<:Any})

Stops an entities detection job in progress. If the job state is INPROGRESS the job is marked for termination and put into the STOPREQUESTED 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.

Arguments

  • job_id: The identifier of the entities detection job to stop.
Main.Comprehend.stop_events_detection_jobMethod
stop_events_detection_job(job_id)
stop_events_detection_job(job_id, params::Dict{String,<:Any})

Stops an events detection job in progress.

Arguments

  • job_id: The identifier of the events detection job to stop.
Main.Comprehend.stop_key_phrases_detection_jobMethod
stop_key_phrases_detection_job(job_id)
stop_key_phrases_detection_job(job_id, params::Dict{String,<:Any})

Stops a key phrases detection job in progress. If the job state is INPROGRESS the job is marked for termination and put into the STOPREQUESTED 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.

Arguments

  • job_id: The identifier of the key phrases detection job to stop.
Main.Comprehend.stop_pii_entities_detection_jobMethod
stop_pii_entities_detection_job(job_id)
stop_pii_entities_detection_job(job_id, params::Dict{String,<:Any})

Stops a PII entities detection job in progress.

Arguments

  • job_id: The identifier of the PII entities detection job to stop.
Main.Comprehend.stop_sentiment_detection_jobMethod
stop_sentiment_detection_job(job_id)
stop_sentiment_detection_job(job_id, params::Dict{String,<:Any})

Stops a sentiment detection job in progress. If the job state is INPROGRESS, the job is marked for termination and put into the STOPREQUESTED 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.

Arguments

  • job_id: The identifier of the sentiment detection job to stop.
Main.Comprehend.stop_targeted_sentiment_detection_jobMethod
stop_targeted_sentiment_detection_job(job_id)
stop_targeted_sentiment_detection_job(job_id, params::Dict{String,<:Any})

Stops a targeted sentiment detection job in progress. If the job state is INPROGRESS, the job is marked for termination and put into the STOPREQUESTED 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.

Arguments

  • job_id: The identifier of the targeted sentiment detection job to stop.
Main.Comprehend.stop_training_document_classifierMethod
stop_training_document_classifier(document_classifier_arn)
stop_training_document_classifier(document_classifier_arn, params::Dict{String,<:Any})

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.

Arguments

  • document_classifier_arn: The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
Main.Comprehend.stop_training_entity_recognizerMethod
stop_training_entity_recognizer(entity_recognizer_arn)
stop_training_entity_recognizer(entity_recognizer_arn, params::Dict{String,<:Any})

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.

Arguments

  • entity_recognizer_arn: The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
Main.Comprehend.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
  • tags: 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.
Main.Comprehend.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a specific tag associated with an Amazon Comprehend resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
  • tag_keys: 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.
Main.Comprehend.update_endpointMethod
update_endpoint(endpoint_arn)
update_endpoint(endpoint_arn, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DesiredDataAccessRoleArn": Data access role ARN to use in case the new model is encrypted with a customer CMK.
  • "DesiredInferenceUnits": 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.
  • "DesiredModelArn": The ARN of the new model to use when updating an existing endpoint.
  • "FlywheelArn": The Amazon Resource Number (ARN) of the flywheel
Main.Comprehend.update_flywheelMethod
update_flywheel(flywheel_arn)
update_flywheel(flywheel_arn, params::Dict{String,<:Any})

Update the configuration information for an existing flywheel.

Arguments

  • flywheel_arn: The Amazon Resource Number (ARN) of the flywheel to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ActiveModelArn": The Amazon Resource Number (ARN) of the active model version.
  • "DataAccessRoleArn": The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
  • "DataSecurityConfig": Flywheel data security configuration.