AnalyzeDocument

$result = $client->analyzeDocument([/* ... */]);
$promise = $client->analyzeDocumentAsync([/* ... */]);

Analyzes an input document for relationships between detected items.

The types of information returned are as follows:

• Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).

• Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of Block objects.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

For more information, see Document Text Analysis.

Parameter Syntax

$result = $client->analyzeDocument([
    'AdaptersConfig' => [
        'Adapters' => [ // REQUIRED
            [
                'AdapterId' => '<string>', // REQUIRED
                'Pages' => ['<string>', ...],
                'Version' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'Document' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'FeatureTypes' => ['<string>', ...], // REQUIRED
    'HumanLoopConfig' => [
        'DataAttributes' => [
            'ContentClassifiers' => ['<string>', ...],
        ],
        'FlowDefinitionArn' => '<string>', // REQUIRED
        'HumanLoopName' => '<string>', // REQUIRED
    ],
    'QueriesConfig' => [
        'Queries' => [ // REQUIRED
            [
                'Alias' => '<string>',
                'Pages' => ['<string>', ...],
                'Text' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'AnalyzeDocumentModelVersion' => '<string>',
    'Blocks' => [
        [
            'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
            'ColumnIndex' => <integer>,
            'ColumnSpan' => <integer>,
            'Confidence' => <float>,
            'EntityTypes' => ['<string>', ...],
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Id' => '<string>',
            'Page' => <integer>,
            'Query' => [
                'Alias' => '<string>',
                'Pages' => ['<string>', ...],
                'Text' => '<string>',
            ],
            'Relationships' => [
                [
                    'Ids' => ['<string>', ...],
                    'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                ],
                // ...
            ],
            'RowIndex' => <integer>,
            'RowSpan' => <integer>,
            'SelectionStatus' => 'SELECTED|NOT_SELECTED',
            'Text' => '<string>',
            'TextType' => 'HANDWRITING|PRINTED',
        ],
        // ...
    ],
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'HumanLoopActivationOutput' => [
        'HumanLoopActivationConditionsEvaluationResults' => '<string>',
        'HumanLoopActivationReasons' => ['<string>', ...],
        'HumanLoopArn' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

HumanLoopQuotaExceededException:

Indicates you have exceeded the maximum number of active human in the loop workflows available

AnalyzeExpense

$result = $client->analyzeExpense([/* ... */]);
$promise = $client->analyzeExpenseAsync([/* ... */]);

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Information is returned as ExpenseDocuments and seperated as follows:

• LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

• SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

Parameter Syntax

$result = $client->analyzeExpense([
    'Document' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'ExpenseDocuments' => [
        [
            'Blocks' => [
                [
                    'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
                    'ColumnIndex' => <integer>,
                    'ColumnSpan' => <integer>,
                    'Confidence' => <float>,
                    'EntityTypes' => ['<string>', ...],
                    'Geometry' => [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Polygon' => [
                            [
                                'X' => <float>,
                                'Y' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'Id' => '<string>',
                    'Page' => <integer>,
                    'Query' => [
                        'Alias' => '<string>',
                        'Pages' => ['<string>', ...],
                        'Text' => '<string>',
                    ],
                    'Relationships' => [
                        [
                            'Ids' => ['<string>', ...],
                            'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                        ],
                        // ...
                    ],
                    'RowIndex' => <integer>,
                    'RowSpan' => <integer>,
                    'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                    'Text' => '<string>',
                    'TextType' => 'HANDWRITING|PRINTED',
                ],
                // ...
            ],
            'ExpenseIndex' => <integer>,
            'LineItemGroups' => [
                [
                    'LineItemGroupIndex' => <integer>,
                    'LineItems' => [
                        [
                            'LineItemExpenseFields' => [
                                [
                                    'Currency' => [
                                        'Code' => '<string>',
                                        'Confidence' => <float>,
                                    ],
                                    'GroupProperties' => [
                                        [
                                            'Id' => '<string>',
                                            'Types' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                    'LabelDetection' => [
                                        'Confidence' => <float>,
                                        'Geometry' => [
                                            'BoundingBox' => [
                                                'Height' => <float>,
                                                'Left' => <float>,
                                                'Top' => <float>,
                                                'Width' => <float>,
                                            ],
                                            'Polygon' => [
                                                [
                                                    'X' => <float>,
                                                    'Y' => <float>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                        'Text' => '<string>',
                                    ],
                                    'PageNumber' => <integer>,
                                    'Type' => [
                                        'Confidence' => <float>,
                                        'Text' => '<string>',
                                    ],
                                    'ValueDetection' => [
                                        'Confidence' => <float>,
                                        'Geometry' => [
                                            'BoundingBox' => [
                                                'Height' => <float>,
                                                'Left' => <float>,
                                                'Top' => <float>,
                                                'Width' => <float>,
                                            ],
                                            'Polygon' => [
                                                [
                                                    'X' => <float>,
                                                    'Y' => <float>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                        'Text' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'SummaryFields' => [
                [
                    'Currency' => [
                        'Code' => '<string>',
                        'Confidence' => <float>,
                    ],
                    'GroupProperties' => [
                        [
                            'Id' => '<string>',
                            'Types' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'LabelDetection' => [
                        'Confidence' => <float>,
                        'Geometry' => [
                            'BoundingBox' => [
                                'Height' => <float>,
                                'Left' => <float>,
                                'Top' => <float>,
                                'Width' => <float>,
                            ],
                            'Polygon' => [
                                [
                                    'X' => <float>,
                                    'Y' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        'Text' => '<string>',
                    ],
                    'PageNumber' => <integer>,
                    'Type' => [
                        'Confidence' => <float>,
                        'Text' => '<string>',
                    ],
                    'ValueDetection' => [
                        'Confidence' => <float>,
                        'Geometry' => [
                            'BoundingBox' => [
                                'Height' => <float>,
                                'Left' => <float>,
                                'Top' => <float>,
                                'Width' => <float>,
                            ],
                            'Polygon' => [
                                [
                                    'X' => <float>,
                                    'Y' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        'Text' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

AnalyzeID

$result = $client->analyzeID([/* ... */]);
$promise = $client->analyzeIDAsync([/* ... */]);

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.

Parameter Syntax

$result = $client->analyzeID([
    'DocumentPages' => [ // REQUIRED
        [
            'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
            'S3Object' => [
                'Bucket' => '<string>',
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AnalyzeIDModelVersion' => '<string>',
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'IdentityDocuments' => [
        [
            'Blocks' => [
                [
                    'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
                    'ColumnIndex' => <integer>,
                    'ColumnSpan' => <integer>,
                    'Confidence' => <float>,
                    'EntityTypes' => ['<string>', ...],
                    'Geometry' => [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Polygon' => [
                            [
                                'X' => <float>,
                                'Y' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'Id' => '<string>',
                    'Page' => <integer>,
                    'Query' => [
                        'Alias' => '<string>',
                        'Pages' => ['<string>', ...],
                        'Text' => '<string>',
                    ],
                    'Relationships' => [
                        [
                            'Ids' => ['<string>', ...],
                            'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                        ],
                        // ...
                    ],
                    'RowIndex' => <integer>,
                    'RowSpan' => <integer>,
                    'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                    'Text' => '<string>',
                    'TextType' => 'HANDWRITING|PRINTED',
                ],
                // ...
            ],
            'DocumentIndex' => <integer>,
            'IdentityDocumentFields' => [
                [
                    'Type' => [
                        'Confidence' => <float>,
                        'NormalizedValue' => [
                            'Value' => '<string>',
                            'ValueType' => 'DATE',
                        ],
                        'Text' => '<string>',
                    ],
                    'ValueDetection' => [
                        'Confidence' => <float>,
                        'NormalizedValue' => [
                            'Value' => '<string>',
                            'ValueType' => 'DATE',
                        ],
                        'Text' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

CreateAdapter

$result = $client->createAdapter([/* ... */]);
$promise = $client->createAdapterAsync([/* ... */]);

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

Parameter Syntax

$result = $client->createAdapter([
    'AdapterName' => '<string>', // REQUIRED
    'AutoUpdate' => 'ENABLED|DISABLED',
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'FeatureTypes' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException:

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ServiceQuotaExceededException:

Returned when a request cannot be completed as it would exceed a maximum service quota.

CreateAdapterVersion

$result = $client->createAdapterVersion([/* ... */]);
$promise = $client->createAdapterVersionAsync([/* ... */]);

Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

Parameter Syntax

$result = $client->createAdapterVersion([
    'AdapterId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'DatasetConfig' => [ // REQUIRED
        'ManifestS3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'KMSKeyId' => '<string>',
    'OutputConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Prefix' => '<string>',
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AdapterId' => '<string>',
    'AdapterVersion' => '<string>',
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException:

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ServiceQuotaExceededException:

Returned when a request cannot be completed as it would exceed a maximum service quota.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

DeleteAdapter

$result = $client->deleteAdapter([/* ... */]);
$promise = $client->deleteAdapterAsync([/* ... */]);

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

DeleteAdapterVersion

$result = $client->deleteAdapterVersion([/* ... */]);
$promise = $client->deleteAdapterVersionAsync([/* ... */]);

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

Parameter Syntax

$result = $client->deleteAdapterVersion([
    'AdapterId' => '<string>', // REQUIRED
    'AdapterVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

DetectDocumentText

$result = $client->detectDocumentText([/* ... */]);
$promise = $client->detectDocumentTextAsync([/* ... */]);

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

For more information, see Document Text Detection.

Parameter Syntax

$result = $client->detectDocumentText([
    'Document' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Blocks' => [
        [
            'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
            'ColumnIndex' => <integer>,
            'ColumnSpan' => <integer>,
            'Confidence' => <float>,
            'EntityTypes' => ['<string>', ...],
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Id' => '<string>',
            'Page' => <integer>,
            'Query' => [
                'Alias' => '<string>',
                'Pages' => ['<string>', ...],
                'Text' => '<string>',
            ],
            'Relationships' => [
                [
                    'Ids' => ['<string>', ...],
                    'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                ],
                // ...
            ],
            'RowIndex' => <integer>,
            'RowSpan' => <integer>,
            'SelectionStatus' => 'SELECTED|NOT_SELECTED',
            'Text' => '<string>',
            'TextType' => 'HANDWRITING|PRINTED',
        ],
        // ...
    ],
    'DetectDocumentTextModelVersion' => '<string>',
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

GetAdapter

$result = $client->getAdapter([/* ... */]);
$promise = $client->getAdapterAsync([/* ... */]);

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdapterId' => '<string>',
    'AdapterName' => '<string>',
    'AutoUpdate' => 'ENABLED|DISABLED',
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'FeatureTypes' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

GetAdapterVersion

$result = $client->getAdapterVersion([/* ... */]);
$promise = $client->getAdapterVersionAsync([/* ... */]);

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Parameter Syntax

$result = $client->getAdapterVersion([
    'AdapterId' => '<string>', // REQUIRED
    'AdapterVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AdapterId' => '<string>',
    'AdapterVersion' => '<string>',
    'CreationTime' => <DateTime>,
    'DatasetConfig' => [
        'ManifestS3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'EvaluationMetrics' => [
        [
            'AdapterVersion' => [
                'F1Score' => <float>,
                'Precision' => <float>,
                'Recall' => <float>,
            ],
            'Baseline' => [
                'F1Score' => <float>,
                'Precision' => <float>,
                'Recall' => <float>,
            ],
            'FeatureType' => 'TABLES|FORMS|QUERIES|SIGNATURES|LAYOUT',
        ],
        // ...
    ],
    'FeatureTypes' => ['<string>', ...],
    'KMSKeyId' => '<string>',
    'OutputConfig' => [
        'S3Bucket' => '<string>',
        'S3Prefix' => '<string>',
    ],
    'Status' => 'ACTIVE|AT_RISK|DEPRECATED|CREATION_ERROR|CREATION_IN_PROGRESS',
    'StatusMessage' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

GetDocumentAnalysis

$result = $client->getDocumentAnalysis([/* ... */]);
$promise = $client->getDocumentAnalysisAsync([/* ... */]);

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

• Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.

For more information, see Document Text Analysis.

Parameter Syntax

$result = $client->getDocumentAnalysis([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AnalyzeDocumentModelVersion' => '<string>',
    'Blocks' => [
        [
            'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
            'ColumnIndex' => <integer>,
            'ColumnSpan' => <integer>,
            'Confidence' => <float>,
            'EntityTypes' => ['<string>', ...],
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Id' => '<string>',
            'Page' => <integer>,
            'Query' => [
                'Alias' => '<string>',
                'Pages' => ['<string>', ...],
                'Text' => '<string>',
            ],
            'Relationships' => [
                [
                    'Ids' => ['<string>', ...],
                    'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                ],
                // ...
            ],
            'RowIndex' => <integer>,
            'RowSpan' => <integer>,
            'SelectionStatus' => 'SELECTED|NOT_SELECTED',
            'Text' => '<string>',
            'TextType' => 'HANDWRITING|PRINTED',
        ],
        // ...
    ],
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Warnings' => [
        [
            'ErrorCode' => '<string>',
            'Pages' => [<integer>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException:

An invalid job identifier was passed to an asynchronous analysis operation.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

GetDocumentTextDetection

$result = $client->getDocumentTextDetection([/* ... */]);
$promise = $client->getDocumentTextDetectionAsync([/* ... */]);

Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

GetDocumentTextDetection returns an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection.

For more information, see Document Text Detection.

Parameter Syntax

$result = $client->getDocumentTextDetection([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Blocks' => [
        [
            'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
            'ColumnIndex' => <integer>,
            'ColumnSpan' => <integer>,
            'Confidence' => <float>,
            'EntityTypes' => ['<string>', ...],
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Id' => '<string>',
            'Page' => <integer>,
            'Query' => [
                'Alias' => '<string>',
                'Pages' => ['<string>', ...],
                'Text' => '<string>',
            ],
            'Relationships' => [
                [
                    'Ids' => ['<string>', ...],
                    'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                ],
                // ...
            ],
            'RowIndex' => <integer>,
            'RowSpan' => <integer>,
            'SelectionStatus' => 'SELECTED|NOT_SELECTED',
            'Text' => '<string>',
            'TextType' => 'HANDWRITING|PRINTED',
        ],
        // ...
    ],
    'DetectDocumentTextModelVersion' => '<string>',
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Warnings' => [
        [
            'ErrorCode' => '<string>',
            'Pages' => [<integer>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException:

An invalid job identifier was passed to an asynchronous analysis operation.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

GetExpenseAnalysis

$result = $client->getExpenseAnalysis([/* ... */]);
$promise = $client->getExpenseAnalysisAsync([/* ... */]);

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Parameter Syntax

$result = $client->getExpenseAnalysis([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AnalyzeExpenseModelVersion' => '<string>',
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'ExpenseDocuments' => [
        [
            'Blocks' => [
                [
                    'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
                    'ColumnIndex' => <integer>,
                    'ColumnSpan' => <integer>,
                    'Confidence' => <float>,
                    'EntityTypes' => ['<string>', ...],
                    'Geometry' => [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Polygon' => [
                            [
                                'X' => <float>,
                                'Y' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'Id' => '<string>',
                    'Page' => <integer>,
                    'Query' => [
                        'Alias' => '<string>',
                        'Pages' => ['<string>', ...],
                        'Text' => '<string>',
                    ],
                    'Relationships' => [
                        [
                            'Ids' => ['<string>', ...],
                            'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                        ],
                        // ...
                    ],
                    'RowIndex' => <integer>,
                    'RowSpan' => <integer>,
                    'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                    'Text' => '<string>',
                    'TextType' => 'HANDWRITING|PRINTED',
                ],
                // ...
            ],
            'ExpenseIndex' => <integer>,
            'LineItemGroups' => [
                [
                    'LineItemGroupIndex' => <integer>,
                    'LineItems' => [
                        [
                            'LineItemExpenseFields' => [
                                [
                                    'Currency' => [
                                        'Code' => '<string>',
                                        'Confidence' => <float>,
                                    ],
                                    'GroupProperties' => [
                                        [
                                            'Id' => '<string>',
                                            'Types' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                    'LabelDetection' => [
                                        'Confidence' => <float>,
                                        'Geometry' => [
                                            'BoundingBox' => [
                                                'Height' => <float>,
                                                'Left' => <float>,
                                                'Top' => <float>,
                                                'Width' => <float>,
                                            ],
                                            'Polygon' => [
                                                [
                                                    'X' => <float>,
                                                    'Y' => <float>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                        'Text' => '<string>',
                                    ],
                                    'PageNumber' => <integer>,
                                    'Type' => [
                                        'Confidence' => <float>,
                                        'Text' => '<string>',
                                    ],
                                    'ValueDetection' => [
                                        'Confidence' => <float>,
                                        'Geometry' => [
                                            'BoundingBox' => [
                                                'Height' => <float>,
                                                'Left' => <float>,
                                                'Top' => <float>,
                                                'Width' => <float>,
                                            ],
                                            'Polygon' => [
                                                [
                                                    'X' => <float>,
                                                    'Y' => <float>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                        'Text' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'SummaryFields' => [
                [
                    'Currency' => [
                        'Code' => '<string>',
                        'Confidence' => <float>,
                    ],
                    'GroupProperties' => [
                        [
                            'Id' => '<string>',
                            'Types' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'LabelDetection' => [
                        'Confidence' => <float>,
                        'Geometry' => [
                            'BoundingBox' => [
                                'Height' => <float>,
                                'Left' => <float>,
                                'Top' => <float>,
                                'Width' => <float>,
                            ],
                            'Polygon' => [
                                [
                                    'X' => <float>,
                                    'Y' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        'Text' => '<string>',
                    ],
                    'PageNumber' => <integer>,
                    'Type' => [
                        'Confidence' => <float>,
                        'Text' => '<string>',
                    ],
                    'ValueDetection' => [
                        'Confidence' => <float>,
                        'Geometry' => [
                            'BoundingBox' => [
                                'Height' => <float>,
                                'Left' => <float>,
                                'Top' => <float>,
                                'Width' => <float>,
                            ],
                            'Polygon' => [
                                [
                                    'X' => <float>,
                                    'Y' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        'Text' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Warnings' => [
        [
            'ErrorCode' => '<string>',
            'Pages' => [<integer>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException:

An invalid job identifier was passed to an asynchronous analysis operation.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

GetLendingAnalysis

$result = $client->getLendingAnalysis([/* ... */]);
$promise = $client->getLendingAnalysisAsync([/* ... */]);

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

Parameter Syntax

$result = $client->getLendingAnalysis([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AnalyzeLendingModelVersion' => '<string>',
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
    'NextToken' => '<string>',
    'Results' => [
        [
            'Extractions' => [
                [
                    'ExpenseDocument' => [
                        'Blocks' => [
                            [
                                'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
                                'ColumnIndex' => <integer>,
                                'ColumnSpan' => <integer>,
                                'Confidence' => <float>,
                                'EntityTypes' => ['<string>', ...],
                                'Geometry' => [
                                    'BoundingBox' => [
                                        'Height' => <float>,
                                        'Left' => <float>,
                                        'Top' => <float>,
                                        'Width' => <float>,
                                    ],
                                    'Polygon' => [
                                        [
                                            'X' => <float>,
                                            'Y' => <float>,
                                        ],
                                        // ...
                                    ],
                                ],
                                'Id' => '<string>',
                                'Page' => <integer>,
                                'Query' => [
                                    'Alias' => '<string>',
                                    'Pages' => ['<string>', ...],
                                    'Text' => '<string>',
                                ],
                                'Relationships' => [
                                    [
                                        'Ids' => ['<string>', ...],
                                        'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                                    ],
                                    // ...
                                ],
                                'RowIndex' => <integer>,
                                'RowSpan' => <integer>,
                                'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                                'Text' => '<string>',
                                'TextType' => 'HANDWRITING|PRINTED',
                            ],
                            // ...
                        ],
                        'ExpenseIndex' => <integer>,
                        'LineItemGroups' => [
                            [
                                'LineItemGroupIndex' => <integer>,
                                'LineItems' => [
                                    [
                                        'LineItemExpenseFields' => [
                                            [
                                                'Currency' => [
                                                    'Code' => '<string>',
                                                    'Confidence' => <float>,
                                                ],
                                                'GroupProperties' => [
                                                    [
                                                        'Id' => '<string>',
                                                        'Types' => ['<string>', ...],
                                                    ],
                                                    // ...
                                                ],
                                                'LabelDetection' => [
                                                    'Confidence' => <float>,
                                                    'Geometry' => [
                                                        'BoundingBox' => [
                                                            'Height' => <float>,
                                                            'Left' => <float>,
                                                            'Top' => <float>,
                                                            'Width' => <float>,
                                                        ],
                                                        'Polygon' => [
                                                            [
                                                                'X' => <float>,
                                                                'Y' => <float>,
                                                            ],
                                                            // ...
                                                        ],
                                                    ],
                                                    'Text' => '<string>',
                                                ],
                                                'PageNumber' => <integer>,
                                                'Type' => [
                                                    'Confidence' => <float>,
                                                    'Text' => '<string>',
                                                ],
                                                'ValueDetection' => [
                                                    'Confidence' => <float>,
                                                    'Geometry' => [
                                                        'BoundingBox' => [
                                                            'Height' => <float>,
                                                            'Left' => <float>,
                                                            'Top' => <float>,
                                                            'Width' => <float>,
                                                        ],
                                                        'Polygon' => [
                                                            [
                                                                'X' => <float>,
                                                                'Y' => <float>,
                                                            ],
                                                            // ...
                                                        ],
                                                    ],
                                                    'Text' => '<string>',
                                                ],
                                            ],
                                            // ...
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'SummaryFields' => [
                            [
                                'Currency' => [
                                    'Code' => '<string>',
                                    'Confidence' => <float>,
                                ],
                                'GroupProperties' => [
                                    [
                                        'Id' => '<string>',
                                        'Types' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                                'LabelDetection' => [
                                    'Confidence' => <float>,
                                    'Geometry' => [
                                        'BoundingBox' => [
                                            'Height' => <float>,
                                            'Left' => <float>,
                                            'Top' => <float>,
                                            'Width' => <float>,
                                        ],
                                        'Polygon' => [
                                            [
                                                'X' => <float>,
                                                'Y' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'Text' => '<string>',
                                ],
                                'PageNumber' => <integer>,
                                'Type' => [
                                    'Confidence' => <float>,
                                    'Text' => '<string>',
                                ],
                                'ValueDetection' => [
                                    'Confidence' => <float>,
                                    'Geometry' => [
                                        'BoundingBox' => [
                                            'Height' => <float>,
                                            'Left' => <float>,
                                            'Top' => <float>,
                                            'Width' => <float>,
                                        ],
                                        'Polygon' => [
                                            [
                                                'X' => <float>,
                                                'Y' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'Text' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'IdentityDocument' => [
                        'Blocks' => [
                            [
                                'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE',
                                'ColumnIndex' => <integer>,
                                'ColumnSpan' => <integer>,
                                'Confidence' => <float>,
                                'EntityTypes' => ['<string>', ...],
                                'Geometry' => [
                                    'BoundingBox' => [
                                        'Height' => <float>,
                                        'Left' => <float>,
                                        'Top' => <float>,
                                        'Width' => <float>,
                                    ],
                                    'Polygon' => [
                                        [
                                            'X' => <float>,
                                            'Y' => <float>,
                                        ],
                                        // ...
                                    ],
                                ],
                                'Id' => '<string>',
                                'Page' => <integer>,
                                'Query' => [
                                    'Alias' => '<string>',
                                    'Pages' => ['<string>', ...],
                                    'Text' => '<string>',
                                ],
                                'Relationships' => [
                                    [
                                        'Ids' => ['<string>', ...],
                                        'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER|TABLE|TABLE_TITLE|TABLE_FOOTER',
                                    ],
                                    // ...
                                ],
                                'RowIndex' => <integer>,
                                'RowSpan' => <integer>,
                                'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                                'Text' => '<string>',
                                'TextType' => 'HANDWRITING|PRINTED',
                            ],
                            // ...
                        ],
                        'DocumentIndex' => <integer>,
                        'IdentityDocumentFields' => [
                            [
                                'Type' => [
                                    'Confidence' => <float>,
                                    'NormalizedValue' => [
                                        'Value' => '<string>',
                                        'ValueType' => 'DATE',
                                    ],
                                    'Text' => '<string>',
                                ],
                                'ValueDetection' => [
                                    'Confidence' => <float>,
                                    'NormalizedValue' => [
                                        'Value' => '<string>',
                                        'ValueType' => 'DATE',
                                    ],
                                    'Text' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'LendingDocument' => [
                        'LendingFields' => [
                            [
                                'KeyDetection' => [
                                    'Confidence' => <float>,
                                    'Geometry' => [
                                        'BoundingBox' => [
                                            'Height' => <float>,
                                            'Left' => <float>,
                                            'Top' => <float>,
                                            'Width' => <float>,
                                        ],
                                        'Polygon' => [
                                            [
                                                'X' => <float>,
                                                'Y' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                                    'Text' => '<string>',
                                ],
                                'Type' => '<string>',
                                'ValueDetections' => [
                                    [
                                        'Confidence' => <float>,
                                        'Geometry' => [
                                            'BoundingBox' => [
                                                'Height' => <float>,
                                                'Left' => <float>,
                                                'Top' => <float>,
                                                'Width' => <float>,
                                            ],
                                            'Polygon' => [
                                                [
                                                    'X' => <float>,
                                                    'Y' => <float>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                        'SelectionStatus' => 'SELECTED|NOT_SELECTED',
                                        'Text' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'SignatureDetections' => [
                            [
                                'Confidence' => <float>,
                                'Geometry' => [
                                    'BoundingBox' => [
                                        'Height' => <float>,
                                        'Left' => <float>,
                                        'Top' => <float>,
                                        'Width' => <float>,
                                    ],
                                    'Polygon' => [
                                        [
                                            'X' => <float>,
                                            'Y' => <float>,
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
            'Page' => <integer>,
            'PageClassification' => [
                'PageNumber' => [
                    [
                        'Confidence' => <float>,
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'PageType' => [
                    [
                        'Confidence' => <float>,
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'StatusMessage' => '<string>',
    'Warnings' => [
        [
            'ErrorCode' => '<string>',
            'Pages' => [<integer>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException:

An invalid job identifier was passed to an asynchronous analysis operation.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

GetLendingAnalysisSummary

$result = $client->getLendingAnalysisSummary([/* ... */]);
$promise = $client->getLendingAnalysisSummaryAsync([/* ... */]);

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AnalyzeLendingModelVersion' => '<string>',
    'DocumentMetadata' => [
        'Pages' => <integer>,
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
    'StatusMessage' => '<string>',
    'Summary' => [
        'DocumentGroups' => [
            [
                'DetectedSignatures' => [
                    [
                        'Page' => <integer>,
                    ],
                    // ...
                ],
                'SplitDocuments' => [
                    [
                        'Index' => <integer>,
                        'Pages' => [<integer>, ...],
                    ],
                    // ...
                ],
                'Type' => '<string>',
                'UndetectedSignatures' => [
                    [
                        'Page' => <integer>,
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'UndetectedDocumentTypes' => ['<string>', ...],
    ],
    'Warnings' => [
        [
            'ErrorCode' => '<string>',
            'Pages' => [<integer>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException:

An invalid job identifier was passed to an asynchronous analysis operation.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

ListAdapterVersions

$result = $client->listAdapterVersions([/* ... */]);
$promise = $client->listAdapterVersionsAsync([/* ... */]);

List all version of an adapter that meet the specified filtration criteria.

Parameter Syntax

$result = $client->listAdapterVersions([
    'AdapterId' => '<string>',
    'AfterCreationTime' => <integer || string || DateTime>,
    'BeforeCreationTime' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AdapterVersions' => [
        [
            'AdapterId' => '<string>',
            'AdapterVersion' => '<string>',
            'CreationTime' => <DateTime>,
            'FeatureTypes' => ['<string>', ...],
            'Status' => 'ACTIVE|AT_RISK|DEPRECATED|CREATION_ERROR|CREATION_IN_PROGRESS',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

ListAdapters

$result = $client->listAdapters([/* ... */]);
$promise = $client->listAdaptersAsync([/* ... */]);

Lists all adapters that match the specified filtration criteria.

Parameter Syntax

$result = $client->listAdapters([
    'AfterCreationTime' => <integer || string || DateTime>,
    'BeforeCreationTime' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Adapters' => [
        [
            'AdapterId' => '<string>',
            'AdapterName' => '<string>',
            'CreationTime' => <DateTime>,
            'FeatureTypes' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ListTagsForResource

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

Lists all tags for an Amazon Textract resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

StartDocumentAnalysis

$result = $client->startDocumentAnalysis([/* ... */]);
$promise = $client->startDocumentAnalysisAsync([/* ... */]);

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

For more information, see Document Text Analysis.

Parameter Syntax

$result = $client->startDocumentAnalysis([
    'AdaptersConfig' => [
        'Adapters' => [ // REQUIRED
            [
                'AdapterId' => '<string>', // REQUIRED
                'Pages' => ['<string>', ...],
                'Version' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'ClientRequestToken' => '<string>',
    'DocumentLocation' => [ // REQUIRED
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'FeatureTypes' => ['<string>', ...], // REQUIRED
    'JobTag' => '<string>',
    'KMSKeyId' => '<string>',
    'NotificationChannel' => [
        'RoleArn' => '<string>', // REQUIRED
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [
        'S3Bucket' => '<string>', // REQUIRED
        'S3Prefix' => '<string>',
    ],
    'QueriesConfig' => [
        'Queries' => [ // REQUIRED
            [
                'Alias' => '<string>',
                'Pages' => ['<string>', ...],
                'Text' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException:

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

StartDocumentTextDetection

$result = $client->startDocumentTextDetection([/* ... */]);
$promise = $client->startDocumentTextDetectionAsync([/* ... */]);

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection.

Parameter Syntax

$result = $client->startDocumentTextDetection([
    'ClientRequestToken' => '<string>',
    'DocumentLocation' => [ // REQUIRED
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'JobTag' => '<string>',
    'KMSKeyId' => '<string>',
    'NotificationChannel' => [
        'RoleArn' => '<string>', // REQUIRED
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [
        'S3Bucket' => '<string>', // REQUIRED
        'S3Prefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException:

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

StartExpenseAnalysis

$result = $client->startExpenseAnalysis([/* ... */]);
$promise = $client->startExpenseAnalysisAsync([/* ... */]);

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Parameter Syntax

$result = $client->startExpenseAnalysis([
    'ClientRequestToken' => '<string>',
    'DocumentLocation' => [ // REQUIRED
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'JobTag' => '<string>',
    'KMSKeyId' => '<string>',
    'NotificationChannel' => [
        'RoleArn' => '<string>', // REQUIRED
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [
        'S3Bucket' => '<string>', // REQUIRED
        'S3Prefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException:

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

StartLendingAnalysis

$result = $client->startLendingAnalysis([/* ... */]);
$promise = $client->startLendingAnalysisAsync([/* ... */]);

Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.

StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.

StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.

If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:

• detailedResponse (contains the GetLendingAnalysis response)

• summaryResponse (for the GetLendingAnalysisSummary response)

• splitDocuments (documents split across logical boundaries)

Parameter Syntax

$result = $client->startLendingAnalysis([
    'ClientRequestToken' => '<string>',
    'DocumentLocation' => [ // REQUIRED
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'JobTag' => '<string>',
    'KMSKeyId' => '<string>',
    'NotificationChannel' => [
        'RoleArn' => '<string>', // REQUIRED
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [
        'S3Bucket' => '<string>', // REQUIRED
        'S3Prefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

InvalidKMSKeyException:

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

UnsupportedDocumentException:

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

DocumentTooLargeException:

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

BadDocumentException:

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException:

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

ServiceQuotaExceededException:

Returned when a request cannot be completed as it would exceed a maximum service quota.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes any tags with the specified keys from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

UpdateAdapter

$result = $client->updateAdapter([/* ... */]);
$promise = $client->updateAdapterAsync([/* ... */]);

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

Parameter Syntax

$result = $client->updateAdapter([
    'AdapterId' => '<string>', // REQUIRED
    'AdapterName' => '<string>',
    'AutoUpdate' => 'ENABLED|DISABLED',
    'Description' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AdapterId' => '<string>',
    'AdapterName' => '<string>',
    'AutoUpdate' => 'ENABLED|DISABLED',
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'FeatureTypes' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException:

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerError:

Amazon Textract experienced a service issue. Try your call again.

ThrottlingException:

Amazon Textract is temporarily unable to process the request. Try your call again.

ValidationException:

Indicates that a request was not valid. Check request for proper formatting.

ResourceNotFoundException:

Returned when an operation tried to access a nonexistent resource.