Amazon Comprehend 2017-11-27

BatchDetectDominantLanguage

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

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([/* ... */]);

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>,
                    '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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• 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([/* ... */]);

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• 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([/* ... */]);

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• 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([/* ... */]);

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Classes' => [
        [
            'Name' => '<string>',
            'Score' => <float>,
        ],
        // ...
    ],
    'Labels' => [
        [
            'Name' => '<string>',
            'Score' => <float>,
        ],
        // ...
    ],
]

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([/* ... */]);

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',
            '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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• InternalServerException:

  An internal server error occurred. Retry your request.

CreateDocumentClassifier

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

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',
        '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>',
    'OutputDataConfig' => [
        '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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EndpointArn' => '<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([/* ... */]);

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>',
    '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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

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

DeleteDocumentClassifier

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

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([/* ... */]);

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([/* ... */]);

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.

DescribeDocumentClassificationJob

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DocumentClassificationJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'DocumentClassifierArn' => '<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.

• 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([/* ... */]);

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>,
        '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',
            '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' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED',
        '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([/* ... */]);

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([/* ... */]);

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>',
        '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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EntitiesDetectionJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'EntityRecognizerArn' => '<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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EntityRecognizerProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'EntityRecognizerArn' => '<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>',
        'RecognizerMetadata' => [
            'EntityTypes' => [
                [
                    'EvaluationMetrics' => [
                        'F1Score' => <float>,
                        'Precision' => <float>,
                        'Recall' => <float>,
                    ],
                    'NumberOfTrainMentions' => <integer>,
                    'Type' => '<string>',
                ],
                // ...
            ],
            'EvaluationMetrics' => [
                'F1Score' => <float>,
                'Precision' => <float>,
                'Recall' => <float>,
            ],
            'NumberOfTestDocuments' => <integer>,
            'NumberOfTrainedDocuments' => <integer>,
        ],
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED',
        '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([/* ... */]);

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.

DescribeKeyPhrasesDetectionJob

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

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([/* ... */]);

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.

DescribeSentimentDetectionJob

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

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.

DescribeTopicsDetectionJob

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

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Entities' => [
        [
            'BeginOffset' => <integer>,
            'EndOffset' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Type' => 'PERSON|LOCATION|ORGANIZATION|COMMERCIAL_ITEM|EVENT|DATE|QUANTITY|TITLE|OTHER',
        ],
        // ...
    ],
]

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• InternalServerException:

  An internal server error occurred. Retry your request.

DetectKeyPhrases

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

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• InternalServerException:

  An internal server error occurred. Retry your request.

DetectPiiEntities

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

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',
        ],
        // ...
    ],
]

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• InternalServerException:

  An internal server error occurred. Retry your request.

DetectSentiment

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

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• InternalServerException:

  An internal server error occurred. Retry your request.

DetectSyntax

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

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 custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

• InternalServerException:

  An internal server error occurred. Retry your request.

ListDocumentClassificationJobs

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

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>,
            '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([/* ... */]);

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',
            '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([/* ... */]);

Parameter Syntax

$result = $client->listDocumentClassifiers([
    'Filter' => [
        'DocumentClassifierName' => '<string>',
        'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED',
        '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>,
            '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',
                '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' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
            'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED',
            '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([/* ... */]);

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([/* ... */]);

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>',
            '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([/* ... */]);

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>',
            '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([/* ... */]);

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',
            '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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EntityRecognizerPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'EntityRecognizerArn' => '<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>',
            'RecognizerMetadata' => [
                'EntityTypes' => [
                    [
                        'EvaluationMetrics' => [
                            'F1Score' => <float>,
                            'Precision' => <float>,
                            'Recall' => <float>,
                        ],
                        'NumberOfTrainMentions' => <integer>,
                        'Type' => '<string>',
                    ],
                    // ...
                ],
                'EvaluationMetrics' => [
                    'F1Score' => <float>,
                    'Precision' => <float>,
                    'Recall' => <float>,
                ],
                'NumberOfTestDocuments' => <integer>,
                'NumberOfTrainedDocuments' => <integer>,
            ],
            'Status' => 'SUBMITTED|TRAINING|DELETING|STOP_REQUESTED|STOPPED|IN_ERROR|TRAINED',
            '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([/* ... */]);

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.

ListKeyPhrasesDetectionJobs

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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.

ListTopicsDetectionJobs