BatchDetectDominantLanguage

$result = $client->batchDetectDominantLanguage([/* ... */]);
$promise = $client->batchDetectDominantLanguageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDetectDominantLanguage([
    'TextList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorList' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Index' => <integer>,
        ],
        // ...
    ],
    'ResultList' => [
        [
            'Index' => <integer>,
            'Languages' => [
                [
                    'LanguageCode' => '<string>',
                    'Score' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

BatchSizeLimitExceededException:

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

InternalServerException:

An internal server error occurred. Retry your request.

BatchDetectEntities

$result = $client->batchDetectEntities([/* ... */]);
$promise = $client->batchDetectEntitiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDetectEntities([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'TextList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorList' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Index' => <integer>,
        ],
        // ...
    ],
    'ResultList' => [
        [
            'Entities' => [
                [
                    'BeginOffset' => <integer>,
                    'BlockReferences' => [
                        [
                            'BeginOffset' => <integer>,
                            'BlockId' => '<string>',
                            'ChildBlocks' => [
                                [
                                    'BeginOffset' => <integer>,
                                    'ChildBlockId' => '<string>',
                                    'EndOffset' => <integer>,
                                ],
                                // ...
                            ],
                            'EndOffset' => <integer>,
                        ],
                        // ...
                    ],
                    'EndOffset' => <integer>,
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Type' => 'PERSON|LOCATION|ORGANIZATION|COMMERCIAL_ITEM|EVENT|DATE|QUANTITY|TITLE|OTHER',
                ],
                // ...
            ],
            'Index' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

BatchSizeLimitExceededException:

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

InternalServerException:

An internal server error occurred. Retry your request.

BatchDetectKeyPhrases

$result = $client->batchDetectKeyPhrases([/* ... */]);
$promise = $client->batchDetectKeyPhrasesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDetectKeyPhrases([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'TextList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorList' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Index' => <integer>,
        ],
        // ...
    ],
    'ResultList' => [
        [
            'Index' => <integer>,
            'KeyPhrases' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'Score' => <float>,
                    'Text' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

BatchSizeLimitExceededException:

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

InternalServerException:

An internal server error occurred. Retry your request.

BatchDetectSentiment

$result = $client->batchDetectSentiment([/* ... */]);
$promise = $client->batchDetectSentimentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDetectSentiment([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'TextList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorList' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Index' => <integer>,
        ],
        // ...
    ],
    'ResultList' => [
        [
            'Index' => <integer>,
            'Sentiment' => 'POSITIVE|NEGATIVE|NEUTRAL|MIXED',
            'SentimentScore' => [
                'Mixed' => <float>,
                'Negative' => <float>,
                'Neutral' => <float>,
                'Positive' => <float>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

BatchSizeLimitExceededException:

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

InternalServerException:

An internal server error occurred. Retry your request.

BatchDetectSyntax

$result = $client->batchDetectSyntax([/* ... */]);
$promise = $client->batchDetectSyntaxAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDetectSyntax([
    'LanguageCode' => 'en|es|fr|de|it|pt', // REQUIRED
    'TextList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorList' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Index' => <integer>,
        ],
        // ...
    ],
    'ResultList' => [
        [
            'Index' => <integer>,
            'SyntaxTokens' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'PartOfSpeech' => [
                        'Score' => <float>,
                        'Tag' => 'ADJ|ADP|ADV|AUX|CONJ|CCONJ|DET|INTJ|NOUN|NUM|O|PART|PRON|PROPN|PUNCT|SCONJ|SYM|VERB',
                    ],
                    'Text' => '<string>',
                    'TokenId' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

BatchSizeLimitExceededException:

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

InternalServerException:

An internal server error occurred. Retry your request.

BatchDetectTargetedSentiment

$result = $client->batchDetectTargetedSentiment([/* ... */]);
$promise = $client->batchDetectTargetedSentimentAsync([/* ... */]);

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

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

Parameter Syntax

$result = $client->batchDetectTargetedSentiment([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'TextList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorList' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Index' => <integer>,
        ],
        // ...
    ],
    'ResultList' => [
        [
            'Entities' => [
                [
                    'DescriptiveMentionIndex' => [<integer>, ...],
                    'Mentions' => [
                        [
                            'BeginOffset' => <integer>,
                            'EndOffset' => <integer>,
                            'GroupScore' => <float>,
                            'MentionSentiment' => [
                                'Sentiment' => 'POSITIVE|NEGATIVE|NEUTRAL|MIXED',
                                'SentimentScore' => [
                                    'Mixed' => <float>,
                                    'Negative' => <float>,
                                    'Neutral' => <float>,
                                    'Positive' => <float>,
                                ],
                            ],
                            'Score' => <float>,
                            'Text' => '<string>',
                            'Type' => 'PERSON|LOCATION|ORGANIZATION|FACILITY|BRAND|COMMERCIAL_ITEM|MOVIE|MUSIC|BOOK|SOFTWARE|GAME|PERSONAL_TITLE|EVENT|DATE|QUANTITY|ATTRIBUTE|OTHER',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Index' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

BatchSizeLimitExceededException:

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

InternalServerException:

An internal server error occurred. Retry your request.

ClassifyDocument

$result = $client->classifyDocument([/* ... */]);
$promise = $client->classifyDocumentAsync([/* ... */]);

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

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

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

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

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

Parameter Syntax

$result = $client->classifyDocument([
    'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
    'DocumentReaderConfig' => [
        'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
        'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
        'FeatureTypes' => ['<string>', ...],
    ],
    'EndpointArn' => '<string>', // REQUIRED
    'Text' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Classes' => [
        [
            'Name' => '<string>',
            'Page' => <integer>,
            'Score' => <float>,
        ],
        // ...
    ],
    'DocumentMetadata' => [
        'ExtractedCharacters' => [
            [
                'Count' => <integer>,
                'Page' => <integer>,
            ],
            // ...
        ],
        'Pages' => <integer>,
    ],
    'DocumentType' => [
        [
            'Page' => <integer>,
            'Type' => 'NATIVE_PDF|SCANNED_PDF|MS_WORD|IMAGE|PLAIN_TEXT|TEXTRACT_DETECT_DOCUMENT_TEXT_JSON|TEXTRACT_ANALYZE_DOCUMENT_JSON',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => 'TEXTRACT_BAD_PAGE|TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED|PAGE_CHARACTERS_EXCEEDED|PAGE_SIZE_EXCEEDED|INTERNAL_SERVER_ERROR',
            'ErrorMessage' => '<string>',
            'Page' => <integer>,
        ],
        // ...
    ],
    'Labels' => [
        [
            'Name' => '<string>',
            'Page' => <integer>,
            'Score' => <float>,
        ],
        // ...
    ],
    'Warnings' => [
        [
            'Page' => <integer>,
            'WarnCode' => 'INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL|INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL',
            'WarnMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

InternalServerException:

An internal server error occurred. Retry your request.

ContainsPiiEntities

$result = $client->containsPiiEntities([/* ... */]);
$promise = $client->containsPiiEntitiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->containsPiiEntities([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Labels' => [
        [
            'Name' => 'BANK_ACCOUNT_NUMBER|BANK_ROUTING|CREDIT_DEBIT_NUMBER|CREDIT_DEBIT_CVV|CREDIT_DEBIT_EXPIRY|PIN|EMAIL|ADDRESS|NAME|PHONE|SSN|DATE_TIME|PASSPORT_NUMBER|DRIVER_ID|URL|AGE|USERNAME|PASSWORD|AWS_ACCESS_KEY|AWS_SECRET_KEY|IP_ADDRESS|MAC_ADDRESS|ALL|LICENSE_PLATE|VEHICLE_IDENTIFICATION_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|IN_PERMANENT_ACCOUNT_NUMBER|IN_NREGA|INTERNATIONAL_BANK_ACCOUNT_NUMBER|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|CA_HEALTH_NUMBER|IN_AADHAAR|IN_VOTER_NUMBER',
            'Score' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createDataset([
    'ClientRequestToken' => '<string>',
    'DatasetName' => '<string>', // REQUIRED
    'DatasetType' => 'TRAIN|TEST',
    'Description' => '<string>',
    'FlywheelArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'AugmentedManifests' => [
            [
                'AnnotationDataS3Uri' => '<string>',
                'AttributeNames' => ['<string>', ...], // REQUIRED
                'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                'S3Uri' => '<string>', // REQUIRED
                'SourceDocumentsS3Uri' => '<string>',
            ],
            // ...
        ],
        'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
        'DocumentClassifierInputDataConfig' => [
            'LabelDelimiter' => '<string>',
            'S3Uri' => '<string>', // REQUIRED
        ],
        'EntityRecognizerInputDataConfig' => [
            'Annotations' => [
                'S3Uri' => '<string>', // REQUIRED
            ],
            'Documents' => [ // REQUIRED
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>', // REQUIRED
            ],
            'EntityList' => [
                'S3Uri' => '<string>', // REQUIRED
            ],
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DatasetArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceLimitExceededException:

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

CreateDocumentClassifier

$result = $client->createDocumentClassifier([/* ... */]);
$promise = $client->createDocumentClassifierAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createDocumentClassifier([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DocumentClassifierName' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'AugmentedManifests' => [
            [
                'AnnotationDataS3Uri' => '<string>',
                'AttributeNames' => ['<string>', ...], // REQUIRED
                'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                'S3Uri' => '<string>', // REQUIRED
                'SourceDocumentsS3Uri' => '<string>',
                'Split' => 'TRAIN|TEST',
            ],
            // ...
        ],
        'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
        'DocumentReaderConfig' => [
            'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
            'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
            'FeatureTypes' => ['<string>', ...],
        ],
        'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
        'Documents' => [
            'S3Uri' => '<string>', // REQUIRED
            'TestS3Uri' => '<string>',
        ],
        'LabelDelimiter' => '<string>',
        'S3Uri' => '<string>',
        'TestS3Uri' => '<string>',
    ],
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'Mode' => 'MULTI_CLASS|MULTI_LABEL',
    'ModelKmsKeyId' => '<string>',
    'ModelPolicy' => '<string>',
    'OutputDataConfig' => [
        'FlywheelStatsS3Prefix' => '<string>',
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionName' => '<string>',
    'VolumeKmsKeyId' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DocumentClassifierArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceLimitExceededException:

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

InternalServerException:

An internal server error occurred. Retry your request.

CreateEndpoint

$result = $client->createEndpoint([/* ... */]);
$promise = $client->createEndpointAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createEndpoint([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>',
    'DesiredInferenceUnits' => <integer>, // REQUIRED
    'EndpointName' => '<string>', // REQUIRED
    'FlywheelArn' => '<string>',
    'ModelArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'EndpointArn' => '<string>',
    'ModelArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

ResourceLimitExceededException:

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

InternalServerException:

An internal server error occurred. Retry your request.

CreateEntityRecognizer

$result = $client->createEntityRecognizer([/* ... */]);
$promise = $client->createEntityRecognizerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createEntityRecognizer([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'Annotations' => [
            'S3Uri' => '<string>', // REQUIRED
            'TestS3Uri' => '<string>',
        ],
        'AugmentedManifests' => [
            [
                'AnnotationDataS3Uri' => '<string>',
                'AttributeNames' => ['<string>', ...], // REQUIRED
                'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                'S3Uri' => '<string>', // REQUIRED
                'SourceDocumentsS3Uri' => '<string>',
                'Split' => 'TRAIN|TEST',
            ],
            // ...
        ],
        'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
        'Documents' => [
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>', // REQUIRED
            'TestS3Uri' => '<string>',
        ],
        'EntityList' => [
            'S3Uri' => '<string>', // REQUIRED
        ],
        'EntityTypes' => [ // REQUIRED
            [
                'Type' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'ModelKmsKeyId' => '<string>',
    'ModelPolicy' => '<string>',
    'RecognizerName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionName' => '<string>',
    'VolumeKmsKeyId' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'EntityRecognizerArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceLimitExceededException:

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

InternalServerException:

An internal server error occurred. Retry your request.

CreateFlywheel

$result = $client->createFlywheel([/* ... */]);
$promise = $client->createFlywheelAsync([/* ... */]);

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

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

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

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

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

Parameter Syntax

$result = $client->createFlywheel([
    'ActiveModelArn' => '<string>',
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DataLakeS3Uri' => '<string>', // REQUIRED
    'DataSecurityConfig' => [
        'DataLakeKmsKeyId' => '<string>',
        'ModelKmsKeyId' => '<string>',
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'FlywheelName' => '<string>', // REQUIRED
    'ModelType' => 'DOCUMENT_CLASSIFIER|ENTITY_RECOGNIZER',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TaskConfig' => [
        'DocumentClassificationConfig' => [
            'Labels' => ['<string>', ...],
            'Mode' => 'MULTI_CLASS|MULTI_LABEL', // REQUIRED
        ],
        'EntityRecognitionConfig' => [
            'EntityTypes' => [ // REQUIRED
                [
                    'Type' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ActiveModelArn' => '<string>',
    'FlywheelArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceLimitExceededException:

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DeleteDocumentClassifier

$result = $client->deleteDocumentClassifier([/* ... */]);
$promise = $client->deleteDocumentClassifierAsync([/* ... */]);

Deletes a previously created document classifier

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

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

Parameter Syntax

$result = $client->deleteDocumentClassifier([
    'DocumentClassifierArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DeleteEndpoint

$result = $client->deleteEndpoint([/* ... */]);
$promise = $client->deleteEndpointAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteEndpoint([
    'EndpointArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DeleteEntityRecognizer

$result = $client->deleteEntityRecognizer([/* ... */]);
$promise = $client->deleteEntityRecognizerAsync([/* ... */]);

Deletes an entity recognizer.

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

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

Parameter Syntax

$result = $client->deleteEntityRecognizer([
    'EntityRecognizerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DeleteFlywheel

$result = $client->deleteFlywheel([/* ... */]);
$promise = $client->deleteFlywheelAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteFlywheel([
    'FlywheelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'PolicyRevisionId' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDataset([
    'DatasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DatasetProperties' => [
        'CreationTime' => <DateTime>,
        'DatasetArn' => '<string>',
        'DatasetName' => '<string>',
        'DatasetS3Uri' => '<string>',
        'DatasetType' => 'TRAIN|TEST',
        'Description' => '<string>',
        'EndTime' => <DateTime>,
        'Message' => '<string>',
        'NumberOfDocuments' => <integer>,
        'Status' => 'CREATING|COMPLETED|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeDocumentClassificationJob

$result = $client->describeDocumentClassificationJob([/* ... */]);
$promise = $client->describeDocumentClassificationJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDocumentClassificationJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DocumentClassificationJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'DocumentClassifierArn' => '<string>',
        'EndTime' => <DateTime>,
        'FlywheelArn' => '<string>',
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeDocumentClassifier

$result = $client->describeDocumentClassifier([/* ... */]);
$promise = $client->describeDocumentClassifierAsync([/* ... */]);

Gets the properties associated with a document classifier.

Parameter Syntax

$result = $client->describeDocumentClassifier([
    'DocumentClassifierArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DocumentClassifierProperties' => [
        'ClassifierMetadata' => [
            'EvaluationMetrics' => [
                'Accuracy' => <float>,
                'F1Score' => <float>,
                'HammingLoss' => <float>,
                'MicroF1Score' => <float>,
                'MicroPrecision' => <float>,
                'MicroRecall' => <float>,
                'Precision' => <float>,
                'Recall' => <float>,
            ],
            'NumberOfLabels' => <integer>,
            'NumberOfTestDocuments' => <integer>,
            'NumberOfTrainedDocuments' => <integer>,
        ],
        'DataAccessRoleArn' => '<string>',
        'DocumentClassifierArn' => '<string>',
        'EndTime' => <DateTime>,
        'FlywheelArn' => '<string>',
        'InputDataConfig' => [
            'AugmentedManifests' => [
                [
                    'AnnotationDataS3Uri' => '<string>',
                    'AttributeNames' => ['<string>', ...],
                    'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                    'S3Uri' => '<string>',
                    'SourceDocumentsS3Uri' => '<string>',
                    'Split' => 'TRAIN|TEST',
                ],
                // ...
            ],
            'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
            'Documents' => [
                'S3Uri' => '<string>',
                'TestS3Uri' => '<string>',
            ],
            'LabelDelimiter' => '<string>',
            'S3Uri' => '<string>',
            'TestS3Uri' => '<string>',
        ],
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'Mode' => 'MULTI_CLASS|MULTI_LABEL',
        'ModelKmsKeyId' => '<string>',
        'OutputDataConfig' => [
            'FlywheelStatsS3Prefix' => '<string>',
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SourceModelArn' => '<string>',
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
        'SubmitTime' => <DateTime>,
        'TrainingEndTime' => <DateTime>,
        'TrainingStartTime' => <DateTime>,
        'VersionName' => '<string>',
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeDominantLanguageDetectionJob

$result = $client->describeDominantLanguageDetectionJob([/* ... */]);
$promise = $client->describeDominantLanguageDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDominantLanguageDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DominantLanguageDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeEndpoint

$result = $client->describeEndpoint([/* ... */]);
$promise = $client->describeEndpointAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEndpoint([
    'EndpointArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndpointProperties' => [
        'CreationTime' => <DateTime>,
        'CurrentInferenceUnits' => <integer>,
        'DataAccessRoleArn' => '<string>',
        'DesiredDataAccessRoleArn' => '<string>',
        'DesiredInferenceUnits' => <integer>,
        'DesiredModelArn' => '<string>',
        'EndpointArn' => '<string>',
        'FlywheelArn' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Message' => '<string>',
        'ModelArn' => '<string>',
        'Status' => 'CREATING|DELETING|FAILED|IN_SERVICE|UPDATING',
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeEntitiesDetectionJob

$result = $client->describeEntitiesDetectionJob([/* ... */]);
$promise = $client->describeEntitiesDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEntitiesDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EntitiesDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'EntityRecognizerArn' => '<string>',
        'FlywheelArn' => '<string>',
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeEntityRecognizer

$result = $client->describeEntityRecognizer([/* ... */]);
$promise = $client->describeEntityRecognizerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEntityRecognizer([
    'EntityRecognizerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EntityRecognizerProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'EntityRecognizerArn' => '<string>',
        'FlywheelArn' => '<string>',
        'InputDataConfig' => [
            'Annotations' => [
                'S3Uri' => '<string>',
                'TestS3Uri' => '<string>',
            ],
            'AugmentedManifests' => [
                [
                    'AnnotationDataS3Uri' => '<string>',
                    'AttributeNames' => ['<string>', ...],
                    'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                    'S3Uri' => '<string>',
                    'SourceDocumentsS3Uri' => '<string>',
                    'Split' => 'TRAIN|TEST',
                ],
                // ...
            ],
            'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
            'Documents' => [
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
                'TestS3Uri' => '<string>',
            ],
            'EntityList' => [
                'S3Uri' => '<string>',
            ],
            'EntityTypes' => [
                [
                    'Type' => '<string>',
                ],
                // ...
            ],
        ],
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'ModelKmsKeyId' => '<string>',
        'OutputDataConfig' => [
            'FlywheelStatsS3Prefix' => '<string>',
        ],
        'RecognizerMetadata' => [
            'EntityTypes' => [
                [
                    'EvaluationMetrics' => [
                        'F1Score' => <float>,
                        'Precision' => <float>,
                        'Recall' => <float>,
                    ],
                    'NumberOfTrainMentions' => <integer>,
                    'Type' => '<string>',
                ],
                // ...
            ],
            'EvaluationMetrics' => [
                'F1Score' => <float>,
                'Precision' => <float>,
                'Recall' => <float>,
            ],
            'NumberOfTestDocuments' => <integer>,
            'NumberOfTrainedDocuments' => <integer>,
        ],
        'SourceModelArn' => '<string>',
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
        'SubmitTime' => <DateTime>,
        'TrainingEndTime' => <DateTime>,
        'TrainingStartTime' => <DateTime>,
        'VersionName' => '<string>',
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeEventsDetectionJob

$result = $client->describeEventsDetectionJob([/* ... */]);
$promise = $client->describeEventsDetectionJobAsync([/* ... */]);

Gets the status and details of an events detection job.

Parameter Syntax

$result = $client->describeEventsDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventsDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'TargetEventTypes' => ['<string>', ...],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeFlywheel

$result = $client->describeFlywheel([/* ... */]);
$promise = $client->describeFlywheelAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeFlywheel([
    'FlywheelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FlywheelProperties' => [
        'ActiveModelArn' => '<string>',
        'CreationTime' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'DataLakeS3Uri' => '<string>',
        'DataSecurityConfig' => [
            'DataLakeKmsKeyId' => '<string>',
            'ModelKmsKeyId' => '<string>',
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        'FlywheelArn' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'LatestFlywheelIteration' => '<string>',
        'Message' => '<string>',
        'ModelType' => 'DOCUMENT_CLASSIFIER|ENTITY_RECOGNIZER',
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
        'TaskConfig' => [
            'DocumentClassificationConfig' => [
                'Labels' => ['<string>', ...],
                'Mode' => 'MULTI_CLASS|MULTI_LABEL',
            ],
            'EntityRecognitionConfig' => [
                'EntityTypes' => [
                    [
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeFlywheelIteration

$result = $client->describeFlywheelIteration([/* ... */]);
$promise = $client->describeFlywheelIterationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeFlywheelIteration([
    'FlywheelArn' => '<string>', // REQUIRED
    'FlywheelIterationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FlywheelIterationProperties' => [
        'CreationTime' => <DateTime>,
        'EndTime' => <DateTime>,
        'EvaluatedModelArn' => '<string>',
        'EvaluatedModelMetrics' => [
            'AverageAccuracy' => <float>,
            'AverageF1Score' => <float>,
            'AveragePrecision' => <float>,
            'AverageRecall' => <float>,
        ],
        'EvaluationManifestS3Prefix' => '<string>',
        'FlywheelArn' => '<string>',
        'FlywheelIterationId' => '<string>',
        'Message' => '<string>',
        'Status' => 'TRAINING|EVALUATING|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'TrainedModelArn' => '<string>',
        'TrainedModelMetrics' => [
            'AverageAccuracy' => <float>,
            'AverageF1Score' => <float>,
            'AveragePrecision' => <float>,
            'AverageRecall' => <float>,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeKeyPhrasesDetectionJob

$result = $client->describeKeyPhrasesDetectionJob([/* ... */]);
$promise = $client->describeKeyPhrasesDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeKeyPhrasesDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'KeyPhrasesDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribePiiEntitiesDetectionJob

$result = $client->describePiiEntitiesDetectionJob([/* ... */]);
$promise = $client->describePiiEntitiesDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describePiiEntitiesDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PiiEntitiesDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'Mode' => 'ONLY_REDACTION|ONLY_OFFSETS',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'RedactionConfig' => [
            'MaskCharacter' => '<string>',
            'MaskMode' => 'MASK|REPLACE_WITH_PII_ENTITY_TYPE',
            'PiiEntityTypes' => ['<string>', ...],
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeResourcePolicy

$result = $client->describeResourcePolicy([/* ... */]);
$promise = $client->describeResourcePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
    'PolicyRevisionId' => '<string>',
    'ResourcePolicy' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeSentimentDetectionJob

$result = $client->describeSentimentDetectionJob([/* ... */]);
$promise = $client->describeSentimentDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeSentimentDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SentimentDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeTargetedSentimentDetectionJob

$result = $client->describeTargetedSentimentDetectionJob([/* ... */]);
$promise = $client->describeTargetedSentimentDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeTargetedSentimentDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TargetedSentimentDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DescribeTopicsDetectionJob

$result = $client->describeTopicsDetectionJob([/* ... */]);
$promise = $client->describeTopicsDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeTopicsDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TopicsDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'DocumentReaderConfig' => [
                'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                'FeatureTypes' => ['<string>', ...],
            ],
            'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
            'S3Uri' => '<string>',
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'Message' => '<string>',
        'NumberOfTopics' => <integer>,
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

JobNotFoundException:

The specified job was not found. Check the job ID and try again.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

DetectDominantLanguage

$result = $client->detectDominantLanguage([/* ... */]);
$promise = $client->detectDominantLanguageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detectDominantLanguage([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Languages' => [
        [
            'LanguageCode' => '<string>',
            'Score' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

InternalServerException:

An internal server error occurred. Retry your request.

DetectEntities

$result = $client->detectEntities([/* ... */]);
$promise = $client->detectEntitiesAsync([/* ... */]);

Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.

When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

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

Parameter Syntax

$result = $client->detectEntities([
    'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
    'DocumentReaderConfig' => [
        'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
        'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
        'FeatureTypes' => ['<string>', ...],
    ],
    'EndpointArn' => '<string>',
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
    'Text' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Blocks' => [
        [
            'BlockType' => 'LINE|WORD',
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Id' => '<string>',
            'Page' => <integer>,
            'Relationships' => [
                [
                    'Ids' => ['<string>', ...],
                    'Type' => 'CHILD',
                ],
                // ...
            ],
            'Text' => '<string>',
        ],
        // ...
    ],
    'DocumentMetadata' => [
        'ExtractedCharacters' => [
            [
                'Count' => <integer>,
                'Page' => <integer>,
            ],
            // ...
        ],
        'Pages' => <integer>,
    ],
    'DocumentType' => [
        [
            'Page' => <integer>,
            'Type' => 'NATIVE_PDF|SCANNED_PDF|MS_WORD|IMAGE|PLAIN_TEXT|TEXTRACT_DETECT_DOCUMENT_TEXT_JSON|TEXTRACT_ANALYZE_DOCUMENT_JSON',
        ],
        // ...
    ],
    'Entities' => [
        [
            'BeginOffset' => <integer>,
            'BlockReferences' => [
                [
                    'BeginOffset' => <integer>,
                    'BlockId' => '<string>',
                    'ChildBlocks' => [
                        [
                            'BeginOffset' => <integer>,
                            'ChildBlockId' => '<string>',
                            'EndOffset' => <integer>,
                        ],
                        // ...
                    ],
                    'EndOffset' => <integer>,
                ],
                // ...
            ],
            'EndOffset' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Type' => 'PERSON|LOCATION|ORGANIZATION|COMMERCIAL_ITEM|EVENT|DATE|QUANTITY|TITLE|OTHER',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => 'TEXTRACT_BAD_PAGE|TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED|PAGE_CHARACTERS_EXCEEDED|PAGE_SIZE_EXCEEDED|INTERNAL_SERVER_ERROR',
            'ErrorMessage' => '<string>',
            'Page' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

DetectKeyPhrases

$result = $client->detectKeyPhrases([/* ... */]);
$promise = $client->detectKeyPhrasesAsync([/* ... */]);

Detects the key noun phrases found in the text.

Parameter Syntax

$result = $client->detectKeyPhrases([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'KeyPhrases' => [
        [
            'BeginOffset' => <integer>,
            'EndOffset' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

DetectPiiEntities

$result = $client->detectPiiEntities([/* ... */]);
$promise = $client->detectPiiEntitiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detectPiiEntities([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Entities' => [
        [
            'BeginOffset' => <integer>,
            'EndOffset' => <integer>,
            'Score' => <float>,
            'Type' => 'BANK_ACCOUNT_NUMBER|BANK_ROUTING|CREDIT_DEBIT_NUMBER|CREDIT_DEBIT_CVV|CREDIT_DEBIT_EXPIRY|PIN|EMAIL|ADDRESS|NAME|PHONE|SSN|DATE_TIME|PASSPORT_NUMBER|DRIVER_ID|URL|AGE|USERNAME|PASSWORD|AWS_ACCESS_KEY|AWS_SECRET_KEY|IP_ADDRESS|MAC_ADDRESS|ALL|LICENSE_PLATE|VEHICLE_IDENTIFICATION_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|IN_PERMANENT_ACCOUNT_NUMBER|IN_NREGA|INTERNATIONAL_BANK_ACCOUNT_NUMBER|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|CA_HEALTH_NUMBER|IN_AADHAAR|IN_VOTER_NUMBER',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

DetectSentiment

$result = $client->detectSentiment([/* ... */]);
$promise = $client->detectSentimentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detectSentiment([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Sentiment' => 'POSITIVE|NEGATIVE|NEUTRAL|MIXED',
    'SentimentScore' => [
        'Mixed' => <float>,
        'Negative' => <float>,
        'Neutral' => <float>,
        'Positive' => <float>,
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

DetectSyntax

$result = $client->detectSyntax([/* ... */]);
$promise = $client->detectSyntaxAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detectSyntax([
    'LanguageCode' => 'en|es|fr|de|it|pt', // REQUIRED
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SyntaxTokens' => [
        [
            'BeginOffset' => <integer>,
            'EndOffset' => <integer>,
            'PartOfSpeech' => [
                'Score' => <float>,
                'Tag' => 'ADJ|ADP|ADV|AUX|CONJ|CCONJ|DET|INTJ|NOUN|NUM|O|PART|PRON|PROPN|PUNCT|SCONJ|SYM|VERB',
            ],
            'Text' => '<string>',
            'TokenId' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

DetectTargetedSentiment

$result = $client->detectTargetedSentiment([/* ... */]);
$promise = $client->detectTargetedSentimentAsync([/* ... */]);

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

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

Parameter Syntax

$result = $client->detectTargetedSentiment([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Entities' => [
        [
            'DescriptiveMentionIndex' => [<integer>, ...],
            'Mentions' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'GroupScore' => <float>,
                    'MentionSentiment' => [
                        'Sentiment' => 'POSITIVE|NEGATIVE|NEUTRAL|MIXED',
                        'SentimentScore' => [
                            'Mixed' => <float>,
                            'Negative' => <float>,
                            'Neutral' => <float>,
                            'Positive' => <float>,
                        ],
                    ],
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Type' => 'PERSON|LOCATION|ORGANIZATION|FACILITY|BRAND|COMMERCIAL_ITEM|MOVIE|MUSIC|BOOK|SOFTWARE|GAME|PERSONAL_TITLE|EVENT|DATE|QUANTITY|ATTRIBUTE|OTHER',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

DetectToxicContent

$result = $client->detectToxicContent([/* ... */]);
$promise = $client->detectToxicContentAsync([/* ... */]);

Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

Parameter Syntax

$result = $client->detectToxicContent([
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'TextSegments' => [ // REQUIRED
        [
            'Text' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ResultList' => [
        [
            'Labels' => [
                [
                    'Name' => 'GRAPHIC|HARASSMENT_OR_ABUSE|HATE_SPEECH|INSULT|PROFANITY|SEXUAL|VIOLENCE_OR_THREAT',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Toxicity' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TextSizeLimitExceededException:

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException:

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

InternalServerException:

An internal server error occurred. Retry your request.

ImportModel

$result = $client->importModel([/* ... */]);
$promise = $client->importModelAsync([/* ... */]);

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

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

The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

Parameter Syntax

$result = $client->importModel([
    'DataAccessRoleArn' => '<string>',
    'ModelKmsKeyId' => '<string>',
    'ModelName' => '<string>',
    'SourceModelArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceLimitExceededException:

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

InternalServerException:

An internal server error occurred. Retry your request.

ListDatasets

$result = $client->listDatasets([/* ... */]);
$promise = $client->listDatasetsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDatasets([
    'Filter' => [
        'CreationTimeAfter' => <integer || string || DateTime>,
        'CreationTimeBefore' => <integer || string || DateTime>,
        'DatasetType' => 'TRAIN|TEST',
        'Status' => 'CREATING|COMPLETED|FAILED',
    ],
    'FlywheelArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DatasetPropertiesList' => [
        [
            'CreationTime' => <DateTime>,
            'DatasetArn' => '<string>',
            'DatasetName' => '<string>',
            'DatasetS3Uri' => '<string>',
            'DatasetType' => 'TRAIN|TEST',
            'Description' => '<string>',
            'EndTime' => <DateTime>,
            'Message' => '<string>',
            'NumberOfDocuments' => <integer>,
            'Status' => 'CREATING|COMPLETED|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

ListDocumentClassificationJobs

$result = $client->listDocumentClassificationJobs([/* ... */]);
$promise = $client->listDocumentClassificationJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDocumentClassificationJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DocumentClassificationJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'DocumentClassifierArn' => '<string>',
            'EndTime' => <DateTime>,
            'FlywheelArn' => '<string>',
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListDocumentClassifierSummaries

$result = $client->listDocumentClassifierSummaries([/* ... */]);
$promise = $client->listDocumentClassifierSummariesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDocumentClassifierSummaries([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DocumentClassifierSummariesList' => [
        [
            'DocumentClassifierName' => '<string>',
            'LatestVersionCreatedAt' => <DateTime>,
            'LatestVersionName' => '<string>',
            'LatestVersionStatus' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
            'NumberOfVersions' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

ListDocumentClassifiers

$result = $client->listDocumentClassifiers([/* ... */]);
$promise = $client->listDocumentClassifiersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDocumentClassifiers([
    'Filter' => [
        'DocumentClassifierName' => '<string>',
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DocumentClassifierPropertiesList' => [
        [
            'ClassifierMetadata' => [
                'EvaluationMetrics' => [
                    'Accuracy' => <float>,
                    'F1Score' => <float>,
                    'HammingLoss' => <float>,
                    'MicroF1Score' => <float>,
                    'MicroPrecision' => <float>,
                    'MicroRecall' => <float>,
                    'Precision' => <float>,
                    'Recall' => <float>,
                ],
                'NumberOfLabels' => <integer>,
                'NumberOfTestDocuments' => <integer>,
                'NumberOfTrainedDocuments' => <integer>,
            ],
            'DataAccessRoleArn' => '<string>',
            'DocumentClassifierArn' => '<string>',
            'EndTime' => <DateTime>,
            'FlywheelArn' => '<string>',
            'InputDataConfig' => [
                'AugmentedManifests' => [
                    [
                        'AnnotationDataS3Uri' => '<string>',
                        'AttributeNames' => ['<string>', ...],
                        'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                        'S3Uri' => '<string>',
                        'SourceDocumentsS3Uri' => '<string>',
                        'Split' => 'TRAIN|TEST',
                    ],
                    // ...
                ],
                'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                'Documents' => [
                    'S3Uri' => '<string>',
                    'TestS3Uri' => '<string>',
                ],
                'LabelDelimiter' => '<string>',
                'S3Uri' => '<string>',
                'TestS3Uri' => '<string>',
            ],
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'Mode' => 'MULTI_CLASS|MULTI_LABEL',
            'ModelKmsKeyId' => '<string>',
            'OutputDataConfig' => [
                'FlywheelStatsS3Prefix' => '<string>',
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SourceModelArn' => '<string>',
            'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
            'SubmitTime' => <DateTime>,
            'TrainingEndTime' => <DateTime>,
            'TrainingStartTime' => <DateTime>,
            'VersionName' => '<string>',
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListDominantLanguageDetectionJobs

$result = $client->listDominantLanguageDetectionJobs([/* ... */]);
$promise = $client->listDominantLanguageDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDominantLanguageDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DominantLanguageDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListEndpoints

$result = $client->listEndpoints([/* ... */]);
$promise = $client->listEndpointsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEndpoints([
    'Filter' => [
        'CreationTimeAfter' => <integer || string || DateTime>,
        'CreationTimeBefore' => <integer || string || DateTime>,
        'ModelArn' => '<string>',
        'Status' => 'CREATING|DELETING|FAILED|IN_SERVICE|UPDATING',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EndpointPropertiesList' => [
        [
            'CreationTime' => <DateTime>,
            'CurrentInferenceUnits' => <integer>,
            'DataAccessRoleArn' => '<string>',
            'DesiredDataAccessRoleArn' => '<string>',
            'DesiredInferenceUnits' => <integer>,
            'DesiredModelArn' => '<string>',
            'EndpointArn' => '<string>',
            'FlywheelArn' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Message' => '<string>',
            'ModelArn' => '<string>',
            'Status' => 'CREATING|DELETING|FAILED|IN_SERVICE|UPDATING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

ListEntitiesDetectionJobs

$result = $client->listEntitiesDetectionJobs([/* ... */]);
$promise = $client->listEntitiesDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEntitiesDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EntitiesDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'EntityRecognizerArn' => '<string>',
            'FlywheelArn' => '<string>',
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListEntityRecognizerSummaries

$result = $client->listEntityRecognizerSummaries([/* ... */]);
$promise = $client->listEntityRecognizerSummariesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEntityRecognizerSummaries([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EntityRecognizerSummariesList' => [
        [
            'LatestVersionCreatedAt' => <DateTime>,
            'LatestVersionName' => '<string>',
            'LatestVersionStatus' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
            'NumberOfVersions' => <integer>,
            'RecognizerName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InternalServerException:

An internal server error occurred. Retry your request.

ListEntityRecognizers

$result = $client->listEntityRecognizers([/* ... */]);
$promise = $client->listEntityRecognizersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listEntityRecognizers([
    'Filter' => [
        'RecognizerName' => '<string>',
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EntityRecognizerPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'EntityRecognizerArn' => '<string>',
            'FlywheelArn' => '<string>',
            'InputDataConfig' => [
                'Annotations' => [
                    'S3Uri' => '<string>',
                    'TestS3Uri' => '<string>',
                ],
                'AugmentedManifests' => [
                    [
                        'AnnotationDataS3Uri' => '<string>',
                        'AttributeNames' => ['<string>', ...],
                        'DocumentType' => 'PLAIN_TEXT_DOCUMENT|SEMI_STRUCTURED_DOCUMENT',
                        'S3Uri' => '<string>',
                        'SourceDocumentsS3Uri' => '<string>',
                        'Split' => 'TRAIN|TEST',
                    ],
                    // ...
                ],
                'DataFormat' => 'COMPREHEND_CSV|AUGMENTED_MANIFEST',
                'Documents' => [
                    'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                    'S3Uri' => '<string>',
                    'TestS3Uri' => '<string>',
                ],
                'EntityList' => [
                    'S3Uri' => '<string>',
                ],
                'EntityTypes' => [
                    [
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'ModelKmsKeyId' => '<string>',
            'OutputDataConfig' => [
                'FlywheelStatsS3Prefix' => '<string>',
            ],
            'RecognizerMetadata' => [
                'EntityTypes' => [
                    [
                        'EvaluationMetrics' => [
                            'F1Score' => <float>,
                            'Precision' => <float>,
                            'Recall' => <float>,
                        ],
                        'NumberOfTrainMentions' => <integer>,
                        'Type' => '<string>',
                    ],
                    // ...
                ],
                'EvaluationMetrics' => [
                    'F1Score' => <float>,
                    'Precision' => <float>,
                    'Recall' => <float>,
                ],
                'NumberOfTestDocuments' => <integer>,
                'NumberOfTrainedDocuments' => <integer>,
            ],
            'SourceModelArn' => '<string>',
            'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED|TRAINED_WITH_WARNING',
            'SubmitTime' => <DateTime>,
            'TrainingEndTime' => <DateTime>,
            'TrainingStartTime' => <DateTime>,
            'VersionName' => '<string>',
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListEventsDetectionJobs

$result = $client->listEventsDetectionJobs([/* ... */]);
$promise = $client->listEventsDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEventsDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventsDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'TargetEventTypes' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListFlywheelIterationHistory

$result = $client->listFlywheelIterationHistory([/* ... */]);
$promise = $client->listFlywheelIterationHistoryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listFlywheelIterationHistory([
    'Filter' => [
        'CreationTimeAfter' => <integer || string || DateTime>,
        'CreationTimeBefore' => <integer || string || DateTime>,
    ],
    'FlywheelArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FlywheelIterationPropertiesList' => [
        [
            'CreationTime' => <DateTime>,
            'EndTime' => <DateTime>,
            'EvaluatedModelArn' => '<string>',
            'EvaluatedModelMetrics' => [
                'AverageAccuracy' => <float>,
                'AverageF1Score' => <float>,
                'AveragePrecision' => <float>,
                'AverageRecall' => <float>,
            ],
            'EvaluationManifestS3Prefix' => '<string>',
            'FlywheelArn' => '<string>',
            'FlywheelIterationId' => '<string>',
            'Message' => '<string>',
            'Status' => 'TRAINING|EVALUATING|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'TrainedModelArn' => '<string>',
            'TrainedModelMetrics' => [
                'AverageAccuracy' => <float>,
                'AverageF1Score' => <float>,
                'AveragePrecision' => <float>,
                'AverageRecall' => <float>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

ListFlywheels

$result = $client->listFlywheels([/* ... */]);
$promise = $client->listFlywheelsAsync([/* ... */]);

Gets a list of the flywheels that you have created.

Parameter Syntax

$result = $client->listFlywheels([
    'Filter' => [
        'CreationTimeAfter' => <integer || string || DateTime>,
        'CreationTimeBefore' => <integer || string || DateTime>,
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FlywheelSummaryList' => [
        [
            'ActiveModelArn' => '<string>',
            'CreationTime' => <DateTime>,
            'DataLakeS3Uri' => '<string>',
            'FlywheelArn' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'LatestFlywheelIteration' => '<string>',
            'Message' => '<string>',
            'ModelType' => 'DOCUMENT_CLASSIFIER|ENTITY_RECOGNIZER',
            'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListKeyPhrasesDetectionJobs

$result = $client->listKeyPhrasesDetectionJobs([/* ... */]);
$promise = $client->listKeyPhrasesDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listKeyPhrasesDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'KeyPhrasesDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListPiiEntitiesDetectionJobs

$result = $client->listPiiEntitiesDetectionJobs([/* ... */]);
$promise = $client->listPiiEntitiesDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPiiEntitiesDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PiiEntitiesDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'Mode' => 'ONLY_REDACTION|ONLY_OFFSETS',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'RedactionConfig' => [
                'MaskCharacter' => '<string>',
                'MaskMode' => 'MASK|REPLACE_WITH_PII_ENTITY_TYPE',
                'PiiEntityTypes' => ['<string>', ...],
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListSentimentDetectionJobs

$result = $client->listSentimentDetectionJobs([/* ... */]);
$promise = $client->listSentimentDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listSentimentDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SentimentDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags associated with a given Amazon Comprehend resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourceArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

ListTargetedSentimentDetectionJobs

$result = $client->listTargetedSentimentDetectionJobs([/* ... */]);
$promise = $client->listTargetedSentimentDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTargetedSentimentDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TargetedSentimentDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

ListTopicsDetectionJobs

$result = $client->listTopicsDetectionJobs([/* ... */]);
$promise = $client->listTopicsDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTopicsDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TopicsDetectionJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'DocumentReaderConfig' => [
                    'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT',
                    'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
                    'FeatureTypes' => ['<string>', ...],
                ],
                'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
                'S3Uri' => '<string>',
            ],
            'JobArn' => '<string>',
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
            'Message' => '<string>',
            'NumberOfTopics' => <integer>,
            'OutputDataConfig' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException:

The filter specified for the operation is invalid. Specify a different filter.

InternalServerException:

An internal server error occurred. Retry your request.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putResourcePolicy([
    'PolicyRevisionId' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
    'ResourcePolicy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PolicyRevisionId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

StartDocumentClassificationJob

$result = $client->startDocumentClassificationJob([/* ... */]);
$promise = $client->startDocumentClassificationJobAsync([/* ... */]);

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

Parameter Syntax

$result = $client->startDocumentClassificationJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DocumentClassifierArn' => '<string>',
    'FlywheelArn' => '<string>',
    'InputDataConfig' => [ // REQUIRED
        'DocumentReaderConfig' => [
            'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
            'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
            'FeatureTypes' => ['<string>', ...],
        ],
        'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VolumeKmsKeyId' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DocumentClassifierArn' => '<string>',
    'JobArn' => '<string>',
    'JobId' => '<string>',
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

StartDominantLanguageDetectionJob

$result = $client->startDominantLanguageDetectionJob([/* ... */]);
$promise = $client->startDominantLanguageDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startDominantLanguageDetectionJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'DocumentReaderConfig' => [
            'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
            'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
            'FeatureTypes' => ['<string>', ...],
        ],
        'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VolumeKmsKeyId' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'JobArn' => '<string>',
    'JobId' => '<string>',
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

StartEntitiesDetectionJob

$result = $client->startEntitiesDetectionJob([/* ... */]);
$promise = $client->startEntitiesDetectionJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startEntitiesDetectionJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'EntityRecognizerArn' => '<string>',
    'FlywheelArn' => '<string>',
    'InputDataConfig' => [ // REQUIRED
        'DocumentReaderConfig' => [
            'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
            'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
            'FeatureTypes' => ['<string>', ...],
        ],
        'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VolumeKmsKeyId' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'EntityRecognizerArn' => '<string>',
    'JobArn' => '<string>',
    'JobId' => '<string>',
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

ResourceUnavailableException:

The specified resource is not available. Check the resource and try your request again.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

StartEventsDetectionJob

$result = $client->startEventsDetectionJob([/* ... */]);
$promise = $client->startEventsDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startEventsDetectionJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'DocumentReaderConfig' => [
            'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
            'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
            'FeatureTypes' => ['<string>', ...],
        ],
        'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetEventTypes' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'JobArn' => '<string>',
    'JobId' => '<string>',
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED|STOP_REQUESTED|STOPPED',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

KmsKeyValidationException:

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

StartFlywheelIteration

$result = $client->startFlywheelIteration([/* ... */]);
$promise = $client->startFlywheelIterationAsync([/* ... */]);

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Parameter Syntax

$result = $client->startFlywheelIteration([
    'ClientRequestToken' => '<string>',
    'FlywheelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FlywheelArn' => '<string>',
    'FlywheelIterationId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is invalid.

TooManyRequestsException:

The number of requests exceeds the limit. Resubmit your request later.

ResourceInUseException:

The specified resource name is already in use. Use a different name and try your request again.

ResourceNotFoundException:

The specified resource ARN was not found. Check the ARN and try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

StartKeyPhrasesDetectionJob

$result = $client->startKeyPhrasesDetectionJob([/* ... */]);
$promise = $client->startKeyPhrasesDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startKeyPhrasesDetectionJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'DocumentReaderConfig' => [
            'DocumentReadAction' => 'TEXTRACT_DETECT_DOCUMENT_TEXT|TEXTRACT_ANALYZE_DOCUMENT', // REQUIRED
            'DocumentReadMode' => 'SERVICE_DEFAULT|FORCE_DOCUMENT_READ_ACTION',
            'FeatureTypes' => ['<string>', ...],
        ],
        'InputFormat' => 'ONE_DOC_PER_FILE|ONE_DOC_PER_LINE',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'LanguageCode' => 'en|es|fr|de|it|pt|ar|hi|ja|ko|zh|zh-TW', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VolumeKmsKeyId' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details