AWS API Changes

2019/03/29 - Amazon Comprehend - 24 updated api methods

Changes With this release AWS Comprehend supports encryption of output results of analysis jobs and volume data on the storage volume attached to the compute instance that processes the analysis job.

CreateDocumentClassifier (updated)

Link ¶
Changes (request)

{'VolumeKmsKeyId': 'string'}

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

See also: AWS API Documentation

Request Syntax

client.create_document_classifier(
    DocumentClassifierName='string',
    DataAccessRoleArn='string',
    InputDataConfig={
        'S3Uri': 'string'
    },
    ClientRequestToken='string',
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt',
    VolumeKmsKeyId='string'
)

type DocumentClassifierName

string

param DocumentClassifierName

[REQUIRED]

The name of the document classifier.

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

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

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type LanguageCode

string

param LanguageCode

[REQUIRED]

The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

rtype

dict

returns

Response Syntax

{
    'DocumentClassifierArn': 'string'
}

Response Structure

(dict) --
- DocumentClassifierArn (string) --
  
  The Amazon Resource Name (ARN) that identifies the document classifier.

CreateEntityRecognizer (updated)

Link ¶
Changes (request)

{'VolumeKmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.create_entity_recognizer(
    RecognizerName='string',
    DataAccessRoleArn='string',
    InputDataConfig={
        'EntityTypes': [
            {
                'Type': 'string'
            },
        ],
        'Documents': {
            'S3Uri': 'string'
        },
        'Annotations': {
            'S3Uri': 'string'
        },
        'EntityList': {
            'S3Uri': 'string'
        }
    },
    ClientRequestToken='string',
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt',
    VolumeKmsKeyId='string'
)

type RecognizerName

string

param RecognizerName

[REQUIRED]

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.

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

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

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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.

EntityTypes (list) -- [REQUIRED]

The entity types in the input data for an entity recognizer.
- (dict) --
  
  Information about an individual item on a list of entity types.
  - Type (string) -- [REQUIRED]
    
    Entity type of an item on an entity type list.
Documents (dict) -- [REQUIRED]

S3 location of the documents folder for an entity recognizer
- S3Uri (string) -- [REQUIRED]
  
  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.
Annotations (dict) --

S3 location of the annotations file for an entity recognizer.
- S3Uri (string) -- [REQUIRED]
  
  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.
EntityList (dict) --

S3 location of the entity list for an entity recognizer.
- S3Uri (string) -- [REQUIRED]
  
  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.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type LanguageCode

string

param LanguageCode

[REQUIRED]

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'EntityRecognizerArn': 'string'
}

Response Structure

(dict) --
- EntityRecognizerArn (string) --
  
  The Amazon Resource Name (ARN) that identifies the entity recognizer.

DescribeDocumentClassificationJob (updated)

Link ¶
Changes (response)

{'DocumentClassificationJobProperties': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                         'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_document_classification_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'DocumentClassificationJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'DocumentClassifierArn': 'string',
        'InputDataConfig': {
            'S3Uri': 'string',
            'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
        },
        'OutputDataConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        },
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- DocumentClassificationJobProperties (dict) --
  
  An object that describes the properties associated with the document classification job.
  - JobId (string) --
    
    The identifier assigned to the document classification job.
  - 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.
  - Message (string) --
    
    A description of the status of the job.
  - SubmitTime (datetime) --
    
    The time that the document classification job was submitted for processing.
  - EndTime (datetime) --
    
    The time that the document classification job completed.
  - DocumentClassifierArn (string) --
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - InputDataConfig (dict) --
    
    The input data configuration that you supplied when you created the document classification job.
    - S3Uri (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.
  - OutputDataConfig (dict) --
    
    The output data configuration that you supplied when you created the document classification job.
    - S3Uri (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.
    - KmsKeyId (string) --
      
      ID for the AWS 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"
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeDocumentClassifier (updated)

Link ¶
Changes (response)

{'DocumentClassifierProperties': {'VolumeKmsKeyId': 'string'}}

Gets the properties associated with a document classifier.

See also: AWS API Documentation

Request Syntax

client.describe_document_classifier(
    DocumentClassifierArn='string'
)

type DocumentClassifierArn

string

param DocumentClassifierArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'DocumentClassifierProperties': {
        'DocumentClassifierArn': 'string',
        'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
        'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'TrainingStartTime': datetime(2015, 1, 1),
        'TrainingEndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'S3Uri': 'string'
        },
        'ClassifierMetadata': {
            'NumberOfLabels': 123,
            'NumberOfTrainedDocuments': 123,
            'NumberOfTestDocuments': 123,
            'EvaluationMetrics': {
                'Accuracy': 123.0,
                'Precision': 123.0,
                'Recall': 123.0,
                'F1Score': 123.0
            }
        },
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- DocumentClassifierProperties (dict) --
  
  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.
  - Status (string) --
    
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
  - Message (string) --
    
    Additional information about the status of the classifier.
  - SubmitTime (datetime) --
    
    The time that the document classifier was submitted for training.
  - EndTime (datetime) --
    
    The time that training the document classifier completed.
  - TrainingStartTime (datetime) --
    
    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 (datetime) --
    
    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 (dict) --
    
    The input data configuration that you supplied when you created the document classifier for training.
    - 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.
  - ClassifierMetadata (dict) --
    
    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.
    - EvaluationMetrics (dict) --
      
      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.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeDominantLanguageDetectionJob (updated)

Link ¶
Changes (response)

{'DominantLanguageDetectionJobProperties': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                            'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_dominant_language_detection_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'DominantLanguageDetectionJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'S3Uri': 'string',
            'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
        },
        'OutputDataConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        },
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- DominantLanguageDetectionJobProperties (dict) --
  
  An object that contains the properties associated with a dominant language detection job.
  - JobId (string) --
    
    The identifier assigned to the dominant language detection job.
  - 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.
  - Message (string) --
    
    A description for the status of a job.
  - SubmitTime (datetime) --
    
    The time that the dominant language detection job was submitted for processing.
  - EndTime (datetime) --
    
    The time that the dominant language detection job completed.
  - InputDataConfig (dict) --
    
    The input data configuration that you supplied when you created the dominant language detection job.
    - S3Uri (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.
  - OutputDataConfig (dict) --
    
    The output data configuration that you supplied when you created the dominant language detection job.
    - S3Uri (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.
    - KmsKeyId (string) --
      
      ID for the AWS 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"
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeEntitiesDetectionJob (updated)

Link ¶
Changes (response)

{'EntitiesDetectionJobProperties': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                    'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_entities_detection_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'EntitiesDetectionJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'EntityRecognizerArn': 'string',
        'InputDataConfig': {
            'S3Uri': 'string',
            'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
        },
        'OutputDataConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        },
        'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- EntitiesDetectionJobProperties (dict) --
  
  An object that contains the properties associated with an entities detection job.
  - JobId (string) --
    
    The identifier assigned to the entities detection job.
  - 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.
  - Message (string) --
    
    A description of the status of a job.
  - SubmitTime (datetime) --
    
    The time that the entities detection job was submitted for processing.
  - EndTime (datetime) --
    
    The time that the entities detection job completed
  - EntityRecognizerArn (string) --
    
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
  - InputDataConfig (dict) --
    
    The input data configuration that you supplied when you created the entities detection job.
    - S3Uri (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.
  - OutputDataConfig (dict) --
    
    The output data configuration that you supplied when you created the entities detection job.
    - S3Uri (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.
    - KmsKeyId (string) --
      
      ID for the AWS 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"
  - LanguageCode (string) --
    
    The language code of the input documents.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeEntityRecognizer (updated)

Link ¶
Changes (response)

{'EntityRecognizerProperties': {'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_entity_recognizer(
    EntityRecognizerArn='string'
)

type EntityRecognizerArn

string

param EntityRecognizerArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'EntityRecognizerProperties': {
        'EntityRecognizerArn': 'string',
        'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
        'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'TrainingStartTime': datetime(2015, 1, 1),
        'TrainingEndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'EntityTypes': [
                {
                    'Type': 'string'
                },
            ],
            'Documents': {
                'S3Uri': 'string'
            },
            'Annotations': {
                'S3Uri': 'string'
            },
            'EntityList': {
                'S3Uri': 'string'
            }
        },
        'RecognizerMetadata': {
            'NumberOfTrainedDocuments': 123,
            'NumberOfTestDocuments': 123,
            'EvaluationMetrics': {
                'Precision': 123.0,
                'Recall': 123.0,
                'F1Score': 123.0
            },
            'EntityTypes': [
                {
                    'Type': 'string'
                },
            ]
        },
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- EntityRecognizerProperties (dict) --
  
  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.
  - Status (string) --
    
    Provides the status of the entity recognizer.
  - Message (string) --
    
    A description of the status of the recognizer.
  - SubmitTime (datetime) --
    
    The time that the recognizer was submitted for processing.
  - EndTime (datetime) --
    
    The time that the recognizer creation completed.
  - TrainingStartTime (datetime) --
    
    The time that training of the entity recognizer started.
  - TrainingEndTime (datetime) --
    
    The time that training of the entity recognizer was completed.
  - InputDataConfig (dict) --
    
    The input data properties of an entity recognizer.
    - EntityTypes (list) --
      
      The entity types in the input data for an entity recognizer.
      - (dict) --
        
        Information about an individual item on a list of entity types.
        
        Type (string) --
        
        Entity type of an item on an entity type list.
    - Documents (dict) --
      
      S3 location of the documents folder for an entity recognizer
      - S3Uri (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.
    - Annotations (dict) --
      
      S3 location of the annotations file for an entity recognizer.
      - S3Uri (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.
    - EntityList (dict) --
      
      S3 location of the entity list for an entity recognizer.
      - S3Uri (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.
  - RecognizerMetadata (dict) --
    
    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 (dict) --
      
      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. The highest score is 1, and the worst score is 0.
    - EntityTypes (list) --
      
      Entity types from the metadata of an entity recognizer.
      - (dict) --
        
        Individual item from the list of entity types in the metadata of an entity recognizer.
        
        Type (string) --
        
        Type of entity from the list of entity types in the metadata of an entity recognizer.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeKeyPhrasesDetectionJob (updated)

Link ¶
Changes (response)

{'KeyPhrasesDetectionJobProperties': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                      'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_key_phrases_detection_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'KeyPhrasesDetectionJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'S3Uri': 'string',
            'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
        },
        'OutputDataConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        },
        'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- KeyPhrasesDetectionJobProperties (dict) --
  
  An object that contains the properties associated with a key phrases detection job.
  - JobId (string) --
    
    The identifier assigned to the key phrases detection job.
  - 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.
  - Message (string) --
    
    A description of the status of a job.
  - SubmitTime (datetime) --
    
    The time that the key phrases detection job was submitted for processing.
  - EndTime (datetime) --
    
    The time that the key phrases detection job completed.
  - InputDataConfig (dict) --
    
    The input data configuration that you supplied when you created the key phrases detection job.
    - S3Uri (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.
  - OutputDataConfig (dict) --
    
    The output data configuration that you supplied when you created the key phrases detection job.
    - S3Uri (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.
    - KmsKeyId (string) --
      
      ID for the AWS 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"
  - LanguageCode (string) --
    
    The language code of the input documents.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeSentimentDetectionJob (updated)

Link ¶
Changes (response)

{'SentimentDetectionJobProperties': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                     'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_sentiment_detection_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'SentimentDetectionJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'S3Uri': 'string',
            'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
        },
        'OutputDataConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        },
        'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- SentimentDetectionJobProperties (dict) --
  
  An object that contains the properties associated with a sentiment detection job.
  - JobId (string) --
    
    The identifier assigned to the sentiment detection job.
  - 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.
  - Message (string) --
    
    A description of the status of a job.
  - SubmitTime (datetime) --
    
    The time that the sentiment detection job was submitted for processing.
  - EndTime (datetime) --
    
    The time that the sentiment detection job ended.
  - InputDataConfig (dict) --
    
    The input data configuration that you supplied when you created the sentiment detection job.
    - S3Uri (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.
  - OutputDataConfig (dict) --
    
    The output data configuration that you supplied when you created the sentiment detection job.
    - S3Uri (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.
    - KmsKeyId (string) --
      
      ID for the AWS 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"
  - LanguageCode (string) --
    
    The language code of the input documents.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

DescribeTopicsDetectionJob (updated)

Link ¶
Changes (response)

{'TopicsDetectionJobProperties': {'DataAccessRoleArn': 'string',
                                  'OutputDataConfig': {'KmsKeyId': 'string'},
                                  'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_topics_detection_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

The identifier assigned by the user to the detection job.

rtype

dict

returns

Response Syntax

{
    'TopicsDetectionJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'S3Uri': 'string',
            'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
        },
        'OutputDataConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        },
        'NumberOfTopics': 123,
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string'
    }
}

Response Structure

(dict) --
- TopicsDetectionJobProperties (dict) --
  
  The list of properties for the requested job.
  - JobId (string) --
    
    The identifier assigned to the topic detection job.
  - 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.
  - Message (string) --
    
    A description for the status of a job.
  - SubmitTime (datetime) --
    
    The time that the topic detection job was submitted for processing.
  - EndTime (datetime) --
    
    The time that the topic detection job was completed.
  - InputDataConfig (dict) --
    
    The input data configuration supplied when you created the topic detection job.
    - S3Uri (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.
  - OutputDataConfig (dict) --
    
    The output data configuration supplied when you created the topic detection job.
    - S3Uri (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.
    - KmsKeyId (string) --
      
      ID for the AWS 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"
  - 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 AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - VolumeKmsKeyId (string) --
    
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

ListDocumentClassificationJobs (updated)

Link ¶
Changes (response)

{'DocumentClassificationJobPropertiesList': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                             'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_document_classification_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

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.
SubmitTimeBefore (datetime) --

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 ascending order, oldest to newest.
SubmitTimeAfter (datetime) --

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 descending order, newest to oldest.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'DocumentClassificationJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'DocumentClassifierArn': 'string',
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DocumentClassificationJobPropertiesList (list) --
  
  A list containing the properties of each job returned.
  - (dict) --
    
    Provides information about a document classification job.
    - JobId (string) --
      
      The identifier assigned to the document classification job.
    - 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.
    - Message (string) --
      
      A description of the status of the job.
    - SubmitTime (datetime) --
      
      The time that the document classification job was submitted for processing.
    - EndTime (datetime) --
      
      The time that the document classification job completed.
    - DocumentClassifierArn (string) --
      
      The Amazon Resource Name (ARN) that identifies the document classifier.
    - InputDataConfig (dict) --
      
      The input data configuration that you supplied when you created the document classification job.
      - S3Uri (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.
    - OutputDataConfig (dict) --
      
      The output data configuration that you supplied when you created the document classification job.
      - S3Uri (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.
      - KmsKeyId (string) --
        
        ID for the AWS 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"
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListDocumentClassifiers (updated)

Link ¶
Changes (response)

{'DocumentClassifierPropertiesList': {'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_document_classifiers(
    Filter={
        'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

Status (string) --

Filters the list of classifiers based on status.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'DocumentClassifierPropertiesList': [
        {
            'DocumentClassifierArn': 'string',
            'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
            'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'TrainingStartTime': datetime(2015, 1, 1),
            'TrainingEndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string'
            },
            'ClassifierMetadata': {
                'NumberOfLabels': 123,
                'NumberOfTrainedDocuments': 123,
                'NumberOfTestDocuments': 123,
                'EvaluationMetrics': {
                    'Accuracy': 123.0,
                    'Precision': 123.0,
                    'Recall': 123.0,
                    'F1Score': 123.0
                }
            },
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DocumentClassifierPropertiesList (list) --
  
  A list containing the properties of each job returned.
  - (dict) --
    
    Provides information about 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.
    - Status (string) --
      
      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    - Message (string) --
      
      Additional information about the status of the classifier.
    - SubmitTime (datetime) --
      
      The time that the document classifier was submitted for training.
    - EndTime (datetime) --
      
      The time that training the document classifier completed.
    - TrainingStartTime (datetime) --
      
      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 (datetime) --
      
      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 (dict) --
      
      The input data configuration that you supplied when you created the document classifier for training.
      - 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.
    - ClassifierMetadata (dict) --
      
      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.
      - EvaluationMetrics (dict) --
        
        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.
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListDominantLanguageDetectionJobs (updated)

Link ¶
Changes (response)

{'DominantLanguageDetectionJobPropertiesList': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                                'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_dominant_language_detection_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

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.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'DominantLanguageDetectionJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DominantLanguageDetectionJobPropertiesList (list) --
  
  A list containing the properties of each job that is returned.
  - (dict) --
    
    Provides information about a dominant language detection job.
    - JobId (string) --
      
      The identifier assigned to the dominant language detection job.
    - 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.
    - Message (string) --
      
      A description for the status of a job.
    - SubmitTime (datetime) --
      
      The time that the dominant language detection job was submitted for processing.
    - EndTime (datetime) --
      
      The time that the dominant language detection job completed.
    - InputDataConfig (dict) --
      
      The input data configuration that you supplied when you created the dominant language detection job.
      - S3Uri (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.
    - OutputDataConfig (dict) --
      
      The output data configuration that you supplied when you created the dominant language detection job.
      - S3Uri (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.
      - KmsKeyId (string) --
        
        ID for the AWS 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"
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListEntitiesDetectionJobs (updated)

Link ¶
Changes (response)

{'EntitiesDetectionJobPropertiesList': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                        'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_entities_detection_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

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.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'EntitiesDetectionJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'EntityRecognizerArn': 'string',
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- EntitiesDetectionJobPropertiesList (list) --
  
  A list containing the properties of each job that is returned.
  - (dict) --
    
    Provides information about an entities detection job.
    - JobId (string) --
      
      The identifier assigned to the entities detection job.
    - 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.
    - Message (string) --
      
      A description of the status of a job.
    - SubmitTime (datetime) --
      
      The time that the entities detection job was submitted for processing.
    - EndTime (datetime) --
      
      The time that the entities detection job completed
    - EntityRecognizerArn (string) --
      
      The Amazon Resource Name (ARN) that identifies the entity recognizer.
    - InputDataConfig (dict) --
      
      The input data configuration that you supplied when you created the entities detection job.
      - S3Uri (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.
    - OutputDataConfig (dict) --
      
      The output data configuration that you supplied when you created the entities detection job.
      - S3Uri (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.
      - KmsKeyId (string) --
        
        ID for the AWS 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"
    - LanguageCode (string) --
      
      The language code of the input documents.
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListEntityRecognizers (updated)

Link ¶
Changes (response)

{'EntityRecognizerPropertiesList': {'VolumeKmsKeyId': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.list_entity_recognizers(
    Filter={
        'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

param Filter

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.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'EntityRecognizerPropertiesList': [
        {
            'EntityRecognizerArn': 'string',
            'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
            'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'TrainingStartTime': datetime(2015, 1, 1),
            'TrainingEndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'EntityTypes': [
                    {
                        'Type': 'string'
                    },
                ],
                'Documents': {
                    'S3Uri': 'string'
                },
                'Annotations': {
                    'S3Uri': 'string'
                },
                'EntityList': {
                    'S3Uri': 'string'
                }
            },
            'RecognizerMetadata': {
                'NumberOfTrainedDocuments': 123,
                'NumberOfTestDocuments': 123,
                'EvaluationMetrics': {
                    'Precision': 123.0,
                    'Recall': 123.0,
                    'F1Score': 123.0
                },
                'EntityTypes': [
                    {
                        'Type': 'string'
                    },
                ]
            },
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- EntityRecognizerPropertiesList (list) --
  
  The list of properties of an entity recognizer.
  - (dict) --
    
    Describes information about 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.
    - Status (string) --
      
      Provides the status of the entity recognizer.
    - Message (string) --
      
      A description of the status of the recognizer.
    - SubmitTime (datetime) --
      
      The time that the recognizer was submitted for processing.
    - EndTime (datetime) --
      
      The time that the recognizer creation completed.
    - TrainingStartTime (datetime) --
      
      The time that training of the entity recognizer started.
    - TrainingEndTime (datetime) --
      
      The time that training of the entity recognizer was completed.
    - InputDataConfig (dict) --
      
      The input data properties of an entity recognizer.
      - EntityTypes (list) --
        
        The entity types in the input data for an entity recognizer.
        
        (dict) --
        
        Information about an individual item on a list of entity types.
        
        Type (string) --
        
        Entity type of an item on an entity type list.
      - Documents (dict) --
        
        S3 location of the documents folder for an entity recognizer
        
        S3Uri (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.
      - Annotations (dict) --
        
        S3 location of the annotations file for an entity recognizer.
        
        S3Uri (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.
      - EntityList (dict) --
        
        S3 location of the entity list for an entity recognizer.
        
        S3Uri (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.
    - RecognizerMetadata (dict) --
      
      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 (dict) --
        
        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. The highest score is 1, and the worst score is 0.
      - EntityTypes (list) --
        
        Entity types from the metadata of an entity recognizer.
        
        (dict) --
        
        Individual item from the list of entity types in the metadata of an entity recognizer.
        
        Type (string) --
        
        Type of entity from the list of entity types in the metadata of an entity recognizer.
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListKeyPhrasesDetectionJobs (updated)

Link ¶
Changes (response)

{'KeyPhrasesDetectionJobPropertiesList': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                          'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_key_phrases_detection_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

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.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'KeyPhrasesDetectionJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- KeyPhrasesDetectionJobPropertiesList (list) --
  
  A list containing the properties of each job that is returned.
  - (dict) --
    
    Provides information about a key phrases detection job.
    - JobId (string) --
      
      The identifier assigned to the key phrases detection job.
    - 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.
    - Message (string) --
      
      A description of the status of a job.
    - SubmitTime (datetime) --
      
      The time that the key phrases detection job was submitted for processing.
    - EndTime (datetime) --
      
      The time that the key phrases detection job completed.
    - InputDataConfig (dict) --
      
      The input data configuration that you supplied when you created the key phrases detection job.
      - S3Uri (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.
    - OutputDataConfig (dict) --
      
      The output data configuration that you supplied when you created the key phrases detection job.
      - S3Uri (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.
      - KmsKeyId (string) --
        
        ID for the AWS 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"
    - LanguageCode (string) --
      
      The language code of the input documents.
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListSentimentDetectionJobs (updated)

Link ¶
Changes (response)

{'SentimentDetectionJobPropertiesList': {'OutputDataConfig': {'KmsKeyId': 'string'},
                                         'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_sentiment_detection_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

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.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'SentimentDetectionJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt',
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SentimentDetectionJobPropertiesList (list) --
  
  A list containing the properties of each job that is returned.
  - (dict) --
    
    Provides information about a sentiment detection job.
    - JobId (string) --
      
      The identifier assigned to the sentiment detection job.
    - 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.
    - Message (string) --
      
      A description of the status of a job.
    - SubmitTime (datetime) --
      
      The time that the sentiment detection job was submitted for processing.
    - EndTime (datetime) --
      
      The time that the sentiment detection job ended.
    - InputDataConfig (dict) --
      
      The input data configuration that you supplied when you created the sentiment detection job.
      - S3Uri (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.
    - OutputDataConfig (dict) --
      
      The output data configuration that you supplied when you created the sentiment detection job.
      - S3Uri (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.
      - KmsKeyId (string) --
        
        ID for the AWS 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"
    - LanguageCode (string) --
      
      The language code of the input documents.
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

ListTopicsDetectionJobs (updated)

Link ¶
Changes (response)

{'TopicsDetectionJobPropertiesList': {'DataAccessRoleArn': 'string',
                                      'OutputDataConfig': {'KmsKeyId': 'string'},
                                      'VolumeKmsKeyId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_topics_detection_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmitTimeBefore': datetime(2015, 1, 1),
        'SubmitTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

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

JobName (string) --
JobStatus (string) --

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
SubmitTimeBefore (datetime) --

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 (datetime) --

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.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

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

rtype

dict

returns

Response Syntax

{
    'TopicsDetectionJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'Message': 'string',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'OutputDataConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            },
            'NumberOfTopics': 123,
            'DataAccessRoleArn': 'string',
            'VolumeKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TopicsDetectionJobPropertiesList (list) --
  
  A list containing the properties of each job that is returned.
  - (dict) --
    
    Provides information about a topic detection job.
    - JobId (string) --
      
      The identifier assigned to the topic detection job.
    - 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.
    - Message (string) --
      
      A description for the status of a job.
    - SubmitTime (datetime) --
      
      The time that the topic detection job was submitted for processing.
    - EndTime (datetime) --
      
      The time that the topic detection job was completed.
    - InputDataConfig (dict) --
      
      The input data configuration supplied when you created the topic detection job.
      - S3Uri (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.
    - OutputDataConfig (dict) --
      
      The output data configuration supplied when you created the topic detection job.
      - S3Uri (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.
      - KmsKeyId (string) --
        
        ID for the AWS 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"
    - 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 AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - VolumeKmsKeyId (string) --
      
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- NextToken (string) --
  
  Identifies the next page of results to return.

StartDocumentClassificationJob (updated)

Link ¶
Changes (request)

{'OutputDataConfig': {'KmsKeyId': 'string'}, 'VolumeKmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.start_document_classification_job(
    JobName='string',
    DocumentClassifierArn='string',
    InputDataConfig={
        'S3Uri': 'string',
        'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'KmsKeyId': 'string'
    },
    DataAccessRoleArn='string',
    ClientRequestToken='string',
    VolumeKmsKeyId='string'
)

type JobName

string

param JobName

The identifier of the job.

type DocumentClassifierArn

string

param DocumentClassifierArn

[REQUIRED]

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

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

Specifies where to send the output files.

S3Uri (string) -- [REQUIRED]

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.
KmsKeyId (string) --

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

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

type ClientRequestToken

string

param ClientRequestToken

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

This field is autopopulated if not provided.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of the job, use this identifier with the operation.
- 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 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.

StartDominantLanguageDetectionJob (updated)

Link ¶
Changes (request)

{'OutputDataConfig': {'KmsKeyId': 'string'}, 'VolumeKmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.start_dominant_language_detection_job(
    InputDataConfig={
        'S3Uri': 'string',
        'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'KmsKeyId': 'string'
    },
    DataAccessRoleArn='string',
    JobName='string',
    ClientRequestToken='string',
    VolumeKmsKeyId='string'
)

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

Specifies where to send the output files.

S3Uri (string) -- [REQUIRED]

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.
KmsKeyId (string) --

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

type JobName

string

param JobName

An identifier for the job.

type ClientRequestToken

string

param ClientRequestToken

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

This field is autopopulated if not provided.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of a job, use this identifier with the operation.
- 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.

StartEntitiesDetectionJob (updated)

Link ¶
Changes (request)

{'OutputDataConfig': {'KmsKeyId': 'string'}, 'VolumeKmsKeyId': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.start_entities_detection_job(
    InputDataConfig={
        'S3Uri': 'string',
        'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'KmsKeyId': 'string'
    },
    DataAccessRoleArn='string',
    JobName='string',
    EntityRecognizerArn='string',
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt',
    ClientRequestToken='string',
    VolumeKmsKeyId='string'
)

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

Specifies where to send the output files.

S3Uri (string) -- [REQUIRED]

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.
KmsKeyId (string) --

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

type JobName

string

param JobName

The identifier of the job.

type EntityRecognizerArn

string

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

type LanguageCode

string

param LanguageCode

[REQUIRED]

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: English ("en"), Spanish ("es"), French ("fr"), German ("de"), Italian ("it"), or Portuguese ("pt"). If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of job, use this identifier with the operation.
- 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.

StartKeyPhrasesDetectionJob (updated)

Link ¶
Changes (request)

{'OutputDataConfig': {'KmsKeyId': 'string'}, 'VolumeKmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.start_key_phrases_detection_job(
    InputDataConfig={
        'S3Uri': 'string',
        'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'KmsKeyId': 'string'
    },
    DataAccessRoleArn='string',
    JobName='string',
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt',
    ClientRequestToken='string',
    VolumeKmsKeyId='string'
)

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

Specifies where to send the output files.

S3Uri (string) -- [REQUIRED]

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.
KmsKeyId (string) --

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

type JobName

string

param JobName

The identifier of the job.

type LanguageCode

string

param LanguageCode

[REQUIRED]

The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of a job, use this identifier with the operation.
- 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.

StartSentimentDetectionJob (updated)

Link ¶
Changes (request)

{'OutputDataConfig': {'KmsKeyId': 'string'}, 'VolumeKmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.start_sentiment_detection_job(
    InputDataConfig={
        'S3Uri': 'string',
        'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'KmsKeyId': 'string'
    },
    DataAccessRoleArn='string',
    JobName='string',
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt',
    ClientRequestToken='string',
    VolumeKmsKeyId='string'
)

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

Specifies where to send the output files.

S3Uri (string) -- [REQUIRED]

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.
KmsKeyId (string) --

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

type JobName

string

param JobName

The identifier of the job.

type LanguageCode

string

param LanguageCode

[REQUIRED]

The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

type ClientRequestToken

string

param ClientRequestToken

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

This field is autopopulated if not provided.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of a job, use this identifier with the operation.
- 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.

StartTopicsDetectionJob (updated)

Link ¶
Changes (request)

{'OutputDataConfig': {'KmsKeyId': 'string'}, 'VolumeKmsKeyId': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.start_topics_detection_job(
    InputDataConfig={
        'S3Uri': 'string',
        'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'KmsKeyId': 'string'
    },
    DataAccessRoleArn='string',
    JobName='string',
    NumberOfTopics=123,
    ClientRequestToken='string',
    VolumeKmsKeyId='string'
)

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

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

S3Uri (string) -- [REQUIRED]

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.
KmsKeyId (string) --

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

type JobName

string

param JobName

The identifier of the job.

type NumberOfTopics

integer

param NumberOfTopics

The number of topics to detect.

type ClientRequestToken

string

param ClientRequestToken

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

This field is autopopulated if not provided.

type VolumeKmsKeyId

string

param VolumeKmsKeyId

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"

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
- 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.