libZSservicesZSamazonka-textractZSamazonka-textract
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Textract

Description

Derived from API version 2018-06-27 of the AWS service descriptions, licensed under Apache 2.0.

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2018-06-27 of the Amazon Textract SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Textract.

InvalidJobIdException

_InvalidJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

AccessDeniedException

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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.

BadDocumentException

_BadDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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.

UnsupportedDocumentException

_UnsupportedDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

InvalidS3ObjectException

_InvalidS3ObjectException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

ProvisionedThroughputExceededException

_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

InvalidKMSKeyException

_InvalidKMSKeyException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

ThrottlingException

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

InternalServerError

_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

IdempotentParameterMismatchException

_IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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.

HumanLoopQuotaExceededException

_HumanLoopQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

DocumentTooLargeException

_DocumentTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DetectDocumentText

data DetectDocumentText Source #

See: newDetectDocumentText smart constructor.

Instances

Instances details
Eq DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Read DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Show DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Generic DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Associated Types

type Rep DetectDocumentText :: Type -> Type #

NFData DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Methods

rnf :: DetectDocumentText -> () #

Hashable DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

ToJSON DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

AWSRequest DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Associated Types

type AWSResponse DetectDocumentText #

ToHeaders DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

ToPath DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

ToQuery DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

type Rep DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

type Rep DetectDocumentText = D1 ('MetaData "DetectDocumentText" "Amazonka.Textract.DetectDocumentText" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "DetectDocumentText'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Document)))
type AWSResponse DetectDocumentText Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

newDetectDocumentText Source #

Create a value of DetectDocumentText with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:document:DetectDocumentText', detectDocumentText_document - The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

data DetectDocumentTextResponse Source #

See: newDetectDocumentTextResponse smart constructor.

Instances

Instances details
Eq DetectDocumentTextResponse Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Read DetectDocumentTextResponse Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Show DetectDocumentTextResponse Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Generic DetectDocumentTextResponse Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

Associated Types

type Rep DetectDocumentTextResponse :: Type -> Type #

NFData DetectDocumentTextResponse Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

type Rep DetectDocumentTextResponse Source # 
Instance details

Defined in Amazonka.Textract.DetectDocumentText

type Rep DetectDocumentTextResponse = D1 ('MetaData "DetectDocumentTextResponse" "Amazonka.Textract.DetectDocumentText" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "DetectDocumentTextResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block]))) :*: (S1 ('MetaSel ('Just "detectDocumentTextModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDetectDocumentTextResponse Source #

Create a value of DetectDocumentTextResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:DetectDocumentTextResponse', detectDocumentTextResponse_documentMetadata - Metadata about the document. It contains the number of pages that are detected in the document.

$sel:blocks:DetectDocumentTextResponse', detectDocumentTextResponse_blocks - An array of Block objects that contain the text that's detected in the document.

$sel:detectDocumentTextModelVersion:DetectDocumentTextResponse', detectDocumentTextResponse_detectDocumentTextModelVersion -

$sel:httpStatus:DetectDocumentTextResponse', detectDocumentTextResponse_httpStatus - The response's http status code.

StartDocumentAnalysis

data StartDocumentAnalysis Source #

See: newStartDocumentAnalysis smart constructor.

Instances

Instances details
Eq StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Read StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Show StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Generic StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Associated Types

type Rep StartDocumentAnalysis :: Type -> Type #

NFData StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Methods

rnf :: StartDocumentAnalysis -> () #

Hashable StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

ToJSON StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

AWSRequest StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Associated Types

type AWSResponse StartDocumentAnalysis #

ToHeaders StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

ToPath StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

ToQuery StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

type Rep StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

type Rep StartDocumentAnalysis = D1 ('MetaData "StartDocumentAnalysis" "Amazonka.Textract.StartDocumentAnalysis" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "StartDocumentAnalysis'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputConfig)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "documentLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentLocation) :*: S1 ('MetaSel ('Just "featureTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FeatureType])))))
type AWSResponse StartDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

newStartDocumentAnalysis Source #

Create a value of StartDocumentAnalysis with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobTag:StartDocumentAnalysis', startDocumentAnalysis_jobTag - An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

$sel:notificationChannel:StartDocumentAnalysis', startDocumentAnalysis_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

$sel:kmsKeyId:StartDocumentAnalysis', startDocumentAnalysis_kmsKeyId - The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

$sel:outputConfig:StartDocumentAnalysis', startDocumentAnalysis_outputConfig - Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

$sel:clientRequestToken:StartDocumentAnalysis', startDocumentAnalysis_clientRequestToken - The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

$sel:documentLocation:StartDocumentAnalysis', startDocumentAnalysis_documentLocation - The location of the document to be processed.

$sel:featureTypes:StartDocumentAnalysis', startDocumentAnalysis_featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

data StartDocumentAnalysisResponse Source #

See: newStartDocumentAnalysisResponse smart constructor.

Instances

Instances details
Eq StartDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Read StartDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Show StartDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Generic StartDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

Associated Types

type Rep StartDocumentAnalysisResponse :: Type -> Type #

NFData StartDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

type Rep StartDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentAnalysis

type Rep StartDocumentAnalysisResponse = D1 ('MetaData "StartDocumentAnalysisResponse" "Amazonka.Textract.StartDocumentAnalysis" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "StartDocumentAnalysisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDocumentAnalysisResponse Source #

Create a value of StartDocumentAnalysisResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartDocumentAnalysisResponse', startDocumentAnalysisResponse_jobId - The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for 7 days.

$sel:httpStatus:StartDocumentAnalysisResponse', startDocumentAnalysisResponse_httpStatus - The response's http status code.

AnalyzeDocument

data AnalyzeDocument Source #

See: newAnalyzeDocument smart constructor.

Instances

Instances details
Eq AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Read AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Show AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Generic AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Associated Types

type Rep AnalyzeDocument :: Type -> Type #

NFData AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Methods

rnf :: AnalyzeDocument -> () #

Hashable AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

ToJSON AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

AWSRequest AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Associated Types

type AWSResponse AnalyzeDocument #

ToHeaders AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

ToPath AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

ToQuery AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

type Rep AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

type Rep AnalyzeDocument = D1 ('MetaData "AnalyzeDocument" "Amazonka.Textract.AnalyzeDocument" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "AnalyzeDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "humanLoopConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopConfig)) :*: (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Document) :*: S1 ('MetaSel ('Just "featureTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FeatureType]))))
type AWSResponse AnalyzeDocument Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

newAnalyzeDocument Source #

Create a value of AnalyzeDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:humanLoopConfig:AnalyzeDocument', analyzeDocument_humanLoopConfig - Sets the configuration for the human in the loop workflow for analyzing documents.

$sel:document:AnalyzeDocument', analyzeDocument_document - The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

$sel:featureTypes:AnalyzeDocument', analyzeDocument_featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

data AnalyzeDocumentResponse Source #

See: newAnalyzeDocumentResponse smart constructor.

Instances

Instances details
Eq AnalyzeDocumentResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Read AnalyzeDocumentResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Show AnalyzeDocumentResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Generic AnalyzeDocumentResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Associated Types

type Rep AnalyzeDocumentResponse :: Type -> Type #

NFData AnalyzeDocumentResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

Methods

rnf :: AnalyzeDocumentResponse -> () #

type Rep AnalyzeDocumentResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeDocument

type Rep AnalyzeDocumentResponse = D1 ('MetaData "AnalyzeDocumentResponse" "Amazonka.Textract.AnalyzeDocument" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "AnalyzeDocumentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block]))) :*: (S1 ('MetaSel ('Just "humanLoopActivationOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopActivationOutput)) :*: (S1 ('MetaSel ('Just "analyzeDocumentModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newAnalyzeDocumentResponse Source #

Create a value of AnalyzeDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:AnalyzeDocumentResponse', analyzeDocumentResponse_documentMetadata - Metadata about the analyzed document. An example is the number of pages.

$sel:blocks:AnalyzeDocumentResponse', analyzeDocumentResponse_blocks - The items that are detected and analyzed by AnalyzeDocument.

$sel:humanLoopActivationOutput:AnalyzeDocumentResponse', analyzeDocumentResponse_humanLoopActivationOutput - Shows the results of the human in the loop evaluation.

$sel:analyzeDocumentModelVersion:AnalyzeDocumentResponse', analyzeDocumentResponse_analyzeDocumentModelVersion - The version of the model used to analyze the document.

$sel:httpStatus:AnalyzeDocumentResponse', analyzeDocumentResponse_httpStatus - The response's http status code.

GetDocumentTextDetection

data GetDocumentTextDetection Source #

See: newGetDocumentTextDetection smart constructor.

Instances

Instances details
Eq GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Read GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Show GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Generic GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Associated Types

type Rep GetDocumentTextDetection :: Type -> Type #

NFData GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Hashable GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

ToJSON GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

AWSRequest GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

ToHeaders GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

ToPath GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

ToQuery GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

type Rep GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

type Rep GetDocumentTextDetection = D1 ('MetaData "GetDocumentTextDetection" "Amazonka.Textract.GetDocumentTextDetection" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "GetDocumentTextDetection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

newGetDocumentTextDetection Source #

Create a value of GetDocumentTextDetection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:GetDocumentTextDetection', getDocumentTextDetection_nextToken - If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

$sel:maxResults:GetDocumentTextDetection', getDocumentTextDetection_maxResults - The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

$sel:jobId:GetDocumentTextDetection', getDocumentTextDetection_jobId - A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

data GetDocumentTextDetectionResponse Source #

See: newGetDocumentTextDetectionResponse smart constructor.

Instances

Instances details
Eq GetDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Read GetDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Show GetDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Generic GetDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

Associated Types

type Rep GetDocumentTextDetectionResponse :: Type -> Type #

NFData GetDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

type Rep GetDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentTextDetection

type Rep GetDocumentTextDetectionResponse = D1 ('MetaData "GetDocumentTextDetectionResponse" "Amazonka.Textract.GetDocumentTextDetection" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "GetDocumentTextDetectionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block]))) :*: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detectDocumentTextModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetDocumentTextDetectionResponse Source #

Create a value of GetDocumentTextDetectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_documentMetadata - Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

$sel:blocks:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_blocks - The results of the text-detection operation.

$sel:warnings:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_warnings - A list of warnings that occurred during the text-detection operation for the document.

$sel:nextToken:GetDocumentTextDetection', getDocumentTextDetectionResponse_nextToken - If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

$sel:statusMessage:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_statusMessage - Returns if the detection job could not be completed. Contains explanation for what error occured.

$sel:detectDocumentTextModelVersion:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_detectDocumentTextModelVersion -

$sel:jobStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_jobStatus - The current status of the text detection job.

$sel:httpStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_httpStatus - The response's http status code.

AnalyzeExpense

data AnalyzeExpense Source #

See: newAnalyzeExpense smart constructor.

Instances

Instances details
Eq AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Read AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Show AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Generic AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Associated Types

type Rep AnalyzeExpense :: Type -> Type #

NFData AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Methods

rnf :: AnalyzeExpense -> () #

Hashable AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

ToJSON AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

AWSRequest AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Associated Types

type AWSResponse AnalyzeExpense #

ToHeaders AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

ToPath AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

ToQuery AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

type Rep AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

type Rep AnalyzeExpense = D1 ('MetaData "AnalyzeExpense" "Amazonka.Textract.AnalyzeExpense" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "AnalyzeExpense'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Document)))
type AWSResponse AnalyzeExpense Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

newAnalyzeExpense Source #

Create a value of AnalyzeExpense with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:document:AnalyzeExpense', analyzeExpense_document - Undocumented member.

data AnalyzeExpenseResponse Source #

See: newAnalyzeExpenseResponse smart constructor.

Instances

Instances details
Eq AnalyzeExpenseResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Read AnalyzeExpenseResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Show AnalyzeExpenseResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Generic AnalyzeExpenseResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Associated Types

type Rep AnalyzeExpenseResponse :: Type -> Type #

NFData AnalyzeExpenseResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

Methods

rnf :: AnalyzeExpenseResponse -> () #

type Rep AnalyzeExpenseResponse Source # 
Instance details

Defined in Amazonka.Textract.AnalyzeExpense

type Rep AnalyzeExpenseResponse = D1 ('MetaData "AnalyzeExpenseResponse" "Amazonka.Textract.AnalyzeExpense" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "AnalyzeExpenseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: (S1 ('MetaSel ('Just "expenseDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExpenseDocument])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAnalyzeExpenseResponse Source #

Create a value of AnalyzeExpenseResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:AnalyzeExpenseResponse', analyzeExpenseResponse_documentMetadata - Undocumented member.

$sel:expenseDocuments:AnalyzeExpenseResponse', analyzeExpenseResponse_expenseDocuments - The expenses detected by Amazon Textract.

$sel:httpStatus:AnalyzeExpenseResponse', analyzeExpenseResponse_httpStatus - The response's http status code.

StartDocumentTextDetection

data StartDocumentTextDetection Source #

See: newStartDocumentTextDetection smart constructor.

Instances

Instances details
Eq StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Read StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Show StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Generic StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Associated Types

type Rep StartDocumentTextDetection :: Type -> Type #

NFData StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Hashable StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

ToJSON StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

AWSRequest StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

ToHeaders StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

ToPath StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

ToQuery StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

type Rep StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

type Rep StartDocumentTextDetection = D1 ('MetaData "StartDocumentTextDetection" "Amazonka.Textract.StartDocumentTextDetection" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "StartDocumentTextDetection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputConfig)) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentLocation)))))
type AWSResponse StartDocumentTextDetection Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

newStartDocumentTextDetection Source #

Create a value of StartDocumentTextDetection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobTag:StartDocumentTextDetection', startDocumentTextDetection_jobTag - An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

$sel:notificationChannel:StartDocumentTextDetection', startDocumentTextDetection_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

$sel:kmsKeyId:StartDocumentTextDetection', startDocumentTextDetection_kmsKeyId - The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

$sel:outputConfig:StartDocumentTextDetection', startDocumentTextDetection_outputConfig - Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

$sel:clientRequestToken:StartDocumentTextDetection', startDocumentTextDetection_clientRequestToken - The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

$sel:documentLocation:StartDocumentTextDetection', startDocumentTextDetection_documentLocation - The location of the document to be processed.

data StartDocumentTextDetectionResponse Source #

Instances

Instances details
Eq StartDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Read StartDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Show StartDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Generic StartDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

Associated Types

type Rep StartDocumentTextDetectionResponse :: Type -> Type #

NFData StartDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

type Rep StartDocumentTextDetectionResponse Source # 
Instance details

Defined in Amazonka.Textract.StartDocumentTextDetection

type Rep StartDocumentTextDetectionResponse = D1 ('MetaData "StartDocumentTextDetectionResponse" "Amazonka.Textract.StartDocumentTextDetection" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "StartDocumentTextDetectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDocumentTextDetectionResponse Source #

Create a value of StartDocumentTextDetectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartDocumentTextDetectionResponse', startDocumentTextDetectionResponse_jobId - The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.

$sel:httpStatus:StartDocumentTextDetectionResponse', startDocumentTextDetectionResponse_httpStatus - The response's http status code.

GetDocumentAnalysis

data GetDocumentAnalysis Source #

See: newGetDocumentAnalysis smart constructor.

Instances

Instances details
Eq GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Read GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Show GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Generic GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Associated Types

type Rep GetDocumentAnalysis :: Type -> Type #

NFData GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Methods

rnf :: GetDocumentAnalysis -> () #

Hashable GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

ToJSON GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

AWSRequest GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Associated Types

type AWSResponse GetDocumentAnalysis #

ToHeaders GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

ToPath GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

ToQuery GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysis = D1 ('MetaData "GetDocumentAnalysis" "Amazonka.Textract.GetDocumentAnalysis" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "GetDocumentAnalysis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

newGetDocumentAnalysis Source #

Create a value of GetDocumentAnalysis with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:GetDocumentAnalysis', getDocumentAnalysis_nextToken - If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

$sel:maxResults:GetDocumentAnalysis', getDocumentAnalysis_maxResults - The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

$sel:jobId:GetDocumentAnalysis', getDocumentAnalysis_jobId - A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

data GetDocumentAnalysisResponse Source #

See: newGetDocumentAnalysisResponse smart constructor.

Instances

Instances details
Eq GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Read GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Show GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Generic GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Associated Types

type Rep GetDocumentAnalysisResponse :: Type -> Type #

NFData GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysisResponse = D1 ('MetaData "GetDocumentAnalysisResponse" "Amazonka.Textract.GetDocumentAnalysis" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "GetDocumentAnalysisResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block]))) :*: (S1 ('MetaSel ('Just "analyzeDocumentModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetDocumentAnalysisResponse Source #

Create a value of GetDocumentAnalysisResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_documentMetadata - Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

$sel:blocks:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_blocks - The results of the text-analysis operation.

$sel:analyzeDocumentModelVersion:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_analyzeDocumentModelVersion -

$sel:warnings:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_warnings - A list of warnings that occurred during the document-analysis operation.

$sel:nextToken:GetDocumentAnalysis', getDocumentAnalysisResponse_nextToken - If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

$sel:statusMessage:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_statusMessage - Returns if the detection job could not be completed. Contains explanation for what error occured.

$sel:jobStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_jobStatus - The current status of the text detection job.

$sel:httpStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_httpStatus - The response's http status code.

Types

BlockType

newtype BlockType Source #

Constructors

BlockType' 

Fields

Instances

Instances details
Eq BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Ord BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Read BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Show BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Generic BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Associated Types

type Rep BlockType :: Type -> Type #

NFData BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Methods

rnf :: BlockType -> () #

Hashable BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToJSON BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToJSONKey BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

FromJSON BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

FromJSONKey BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToLog BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToHeader BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToQuery BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

FromXML BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToXML BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Methods

toXML :: BlockType -> XML #

ToByteString BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Methods

toBS :: BlockType -> ByteString #

FromText BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

ToText BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

Methods

toText :: BlockType -> Text #

type Rep BlockType Source # 
Instance details

Defined in Amazonka.Textract.Types.BlockType

type Rep BlockType = D1 ('MetaData "BlockType" "Amazonka.Textract.Types.BlockType" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "BlockType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromBlockType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContentClassifier

newtype ContentClassifier Source #

Instances

Instances details
Eq ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

Ord ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

Read ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

Show ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

Generic ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

Associated Types

type Rep ContentClassifier :: Type -> Type #

NFData ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

Methods

rnf :: ContentClassifier -> () #

Hashable ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToJSON ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToJSONKey ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

FromJSON ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

FromJSONKey ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToLog ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToHeader ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToQuery ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

FromXML ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToXML ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToByteString ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

FromText ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

ToText ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

type Rep ContentClassifier Source # 
Instance details

Defined in Amazonka.Textract.Types.ContentClassifier

type Rep ContentClassifier = D1 ('MetaData "ContentClassifier" "Amazonka.Textract.Types.ContentClassifier" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "ContentClassifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentClassifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EntityType

newtype EntityType Source #

Constructors

EntityType' 

Fields

Bundled Patterns

pattern EntityType_KEY :: EntityType 
pattern EntityType_VALUE :: EntityType 

Instances

Instances details
Eq EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Ord EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Read EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Show EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Generic EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Associated Types

type Rep EntityType :: Type -> Type #

NFData EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Methods

rnf :: EntityType -> () #

Hashable EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToJSON EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToJSONKey EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

FromJSON EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

FromJSONKey EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToLog EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToHeader EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToQuery EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

FromXML EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToXML EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Methods

toXML :: EntityType -> XML #

ToByteString EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

FromText EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

ToText EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

Methods

toText :: EntityType -> Text #

type Rep EntityType Source # 
Instance details

Defined in Amazonka.Textract.Types.EntityType

type Rep EntityType = D1 ('MetaData "EntityType" "Amazonka.Textract.Types.EntityType" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "EntityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEntityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FeatureType

newtype FeatureType Source #

Constructors

FeatureType' 

Bundled Patterns

pattern FeatureType_FORMS :: FeatureType 
pattern FeatureType_TABLES :: FeatureType 

Instances

Instances details
Eq FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Ord FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Read FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Show FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Generic FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Associated Types

type Rep FeatureType :: Type -> Type #

NFData FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Methods

rnf :: FeatureType -> () #

Hashable FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToJSON FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToJSONKey FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

FromJSON FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

FromJSONKey FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToLog FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToHeader FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToQuery FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

FromXML FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToXML FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Methods

toXML :: FeatureType -> XML #

ToByteString FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

FromText FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

ToText FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

Methods

toText :: FeatureType -> Text #

type Rep FeatureType Source # 
Instance details

Defined in Amazonka.Textract.Types.FeatureType

type Rep FeatureType = D1 ('MetaData "FeatureType" "Amazonka.Textract.Types.FeatureType" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "FeatureType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFeatureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobStatus

newtype JobStatus Source #

Constructors

JobStatus' 

Fields

Instances

Instances details
Eq JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Ord JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Read JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Show JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Generic JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Associated Types

type Rep JobStatus :: Type -> Type #

NFData JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Methods

rnf :: JobStatus -> () #

Hashable JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToJSON JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

FromJSON JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

FromJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToLog JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToHeader JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToQuery JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

FromXML JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToXML JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Methods

toXML :: JobStatus -> XML #

ToByteString JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Methods

toBS :: JobStatus -> ByteString #

FromText JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

ToText JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

Methods

toText :: JobStatus -> Text #

type Rep JobStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.JobStatus

type Rep JobStatus = D1 ('MetaData "JobStatus" "Amazonka.Textract.Types.JobStatus" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "JobStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RelationshipType

newtype RelationshipType Source #

Instances

Instances details
Eq RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

Ord RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

Read RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

Show RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

Generic RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

Associated Types

type Rep RelationshipType :: Type -> Type #

NFData RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

Methods

rnf :: RelationshipType -> () #

Hashable RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToJSON RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToJSONKey RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

FromJSON RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

FromJSONKey RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToLog RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToHeader RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToQuery RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

FromXML RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToXML RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToByteString RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

FromText RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

ToText RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

type Rep RelationshipType Source # 
Instance details

Defined in Amazonka.Textract.Types.RelationshipType

type Rep RelationshipType = D1 ('MetaData "RelationshipType" "Amazonka.Textract.Types.RelationshipType" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "RelationshipType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRelationshipType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SelectionStatus

newtype SelectionStatus Source #

Constructors

SelectionStatus' 

Instances

Instances details
Eq SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Ord SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Read SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Show SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Generic SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Associated Types

type Rep SelectionStatus :: Type -> Type #

NFData SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Methods

rnf :: SelectionStatus -> () #

Hashable SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToJSON SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToJSONKey SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

FromJSON SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

FromJSONKey SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToLog SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToHeader SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToQuery SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

FromXML SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToXML SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

Methods

toXML :: SelectionStatus -> XML #

ToByteString SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

FromText SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

ToText SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

type Rep SelectionStatus Source # 
Instance details

Defined in Amazonka.Textract.Types.SelectionStatus

type Rep SelectionStatus = D1 ('MetaData "SelectionStatus" "Amazonka.Textract.Types.SelectionStatus" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "SelectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSelectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TextType

newtype TextType Source #

Constructors

TextType' 

Fields

Bundled Patterns

pattern TextType_HANDWRITING :: TextType 
pattern TextType_PRINTED :: TextType 

Instances

Instances details
Eq TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Ord TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Read TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Show TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Generic TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Associated Types

type Rep TextType :: Type -> Type #

Methods

from :: TextType -> Rep TextType x #

to :: Rep TextType x -> TextType #

NFData TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Methods

rnf :: TextType -> () #

Hashable TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Methods

hashWithSalt :: Int -> TextType -> Int #

hash :: TextType -> Int #

ToJSON TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

ToJSONKey TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

FromJSON TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

FromJSONKey TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

ToLog TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

ToHeader TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Methods

toHeader :: HeaderName -> TextType -> [Header] #

ToQuery TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

FromXML TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

ToXML TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Methods

toXML :: TextType -> XML #

ToByteString TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Methods

toBS :: TextType -> ByteString #

FromText TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

ToText TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

Methods

toText :: TextType -> Text #

type Rep TextType Source # 
Instance details

Defined in Amazonka.Textract.Types.TextType

type Rep TextType = D1 ('MetaData "TextType" "Amazonka.Textract.Types.TextType" "libZSservicesZSamazonka-textractZSamazonka-textract" 'True) (C1 ('MetaCons "TextType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTextType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Block

data Block Source #

A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables, and selection elements that are detected in the document.

An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.

For more information, see How Amazon Textract Works.

See: newBlock smart constructor.

Instances

Instances details
Eq Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

Methods

(==) :: Block -> Block -> Bool #

(/=) :: Block -> Block -> Bool #

Read Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

Show Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

Methods

showsPrec :: Int -> Block -> ShowS #

show :: Block -> String #

showList :: [Block] -> ShowS #

Generic Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

Associated Types

type Rep Block :: Type -> Type #

Methods

from :: Block -> Rep Block x #

to :: Rep Block x -> Block #

NFData Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

Methods

rnf :: Block -> () #

Hashable Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

Methods

hashWithSalt :: Int -> Block -> Int #

hash :: Block -> Int #

FromJSON Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

type Rep Block Source # 
Instance details

Defined in Amazonka.Textract.Types.Block

type Rep Block = D1 ('MetaData "Block" "Amazonka.Textract.Types.Block" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Block'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "columnSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityType])))) :*: ((S1 ('MetaSel ('Just "columnIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "page") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "rowSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "selectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelectionStatus))))) :*: ((S1 ('MetaSel ('Just "rowIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "relationships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Relationship])))) :*: ((S1 ('MetaSel ('Just "geometry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Geometry)) :*: S1 ('MetaSel ('Just "textType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextType))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "blockType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlockType)))))))

newBlock :: Block Source #

Create a value of Block with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:columnSpan:Block', block_columnSpan - The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:text:Block', block_text - The word or line of text that's recognized by Amazon Textract.

$sel:entityTypes:Block', block_entityTypes - The type of entity. The following can be returned:

  • KEY - An identifier for a field on the document.
  • VALUE - The field text.

EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:columnIndex:Block', block_columnIndex - The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:page:Block', block_page - The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.

$sel:rowSpan:Block', block_rowSpan - The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:selectionStatus:Block', block_selectionStatus - The selection status of a selection element, such as an option button or check box.

$sel:rowIndex:Block', block_rowIndex - The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:confidence:Block', block_confidence - The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

$sel:relationships:Block', block_relationships - A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:

  • 0 - The block has no child blocks.
  • 1 - The block has child blocks.

$sel:geometry:Block', block_geometry - The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

$sel:textType:Block', block_textType - The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

$sel:id:Block', block_id - The identifier for the recognized text. The identifier is only unique for a single operation.

$sel:blockType:Block', block_blockType - The type of text item that's recognized. In operations for text detection, the following types are returned:

  • PAGE - Contains a list of the LINE Block objects that are detected on a document page.
  • WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
  • LINE - A string of tab-delimited, contiguous words that are detected on a document page.

In text analysis operations, the following types are returned:

  • PAGE - Contains a list of child Block objects that are detected on a document page.
  • KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
  • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
  • LINE - A string of tab-delimited, contiguous words that are detected on a document page.
  • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
  • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
  • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

BoundingBox

data BoundingBox Source #

The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

See: newBoundingBox smart constructor.

Instances

Instances details
Eq BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

Read BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

Show BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

Generic BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

Associated Types

type Rep BoundingBox :: Type -> Type #

NFData BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

Methods

rnf :: BoundingBox -> () #

Hashable BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

FromJSON BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

type Rep BoundingBox Source # 
Instance details

Defined in Amazonka.Textract.Types.BoundingBox

type Rep BoundingBox = D1 ('MetaData "BoundingBox" "Amazonka.Textract.Types.BoundingBox" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "BoundingBox'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "left") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "top") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newBoundingBox :: BoundingBox Source #

Create a value of BoundingBox with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:height:BoundingBox', boundingBox_height - The height of the bounding box as a ratio of the overall document page height.

$sel:left:BoundingBox', boundingBox_left - The left coordinate of the bounding box as a ratio of overall document page width.

$sel:width:BoundingBox', boundingBox_width - The width of the bounding box as a ratio of the overall document page width.

$sel:top:BoundingBox', boundingBox_top - The top coordinate of the bounding box as a ratio of overall document page height.

Document

data Document Source #

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

See: newDocument smart constructor.

Constructors

Document' (Maybe S3Object) (Maybe Base64) 

Instances

Instances details
Eq Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

Read Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

Show Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

Generic Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

Associated Types

type Rep Document :: Type -> Type #

Methods

from :: Document -> Rep Document x #

to :: Rep Document x -> Document #

NFData Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

Methods

rnf :: Document -> () #

Hashable Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

Methods

hashWithSalt :: Int -> Document -> Int #

hash :: Document -> Int #

ToJSON Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

type Rep Document Source # 
Instance details

Defined in Amazonka.Textract.Types.Document

type Rep Document = D1 ('MetaData "Document" "Amazonka.Textract.Types.Document" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object)) :*: S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))))

newDocument :: Document Source #

Create a value of Document with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Object:Document', document_s3Object - Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

$sel:bytes:Document', document_bytes - A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

DocumentLocation

data DocumentLocation Source #

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

See: newDocumentLocation smart constructor.

Instances

Instances details
Eq DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

Read DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

Show DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

Generic DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

Associated Types

type Rep DocumentLocation :: Type -> Type #

NFData DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

Methods

rnf :: DocumentLocation -> () #

Hashable DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

ToJSON DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

type Rep DocumentLocation Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentLocation

type Rep DocumentLocation = D1 ('MetaData "DocumentLocation" "Amazonka.Textract.Types.DocumentLocation" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "DocumentLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object))))

newDocumentLocation :: DocumentLocation Source #

Create a value of DocumentLocation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Object:DocumentLocation', documentLocation_s3Object - The Amazon S3 bucket that contains the input document.

DocumentMetadata

data DocumentMetadata Source #

Information about the input document.

See: newDocumentMetadata smart constructor.

Instances

Instances details
Eq DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

Read DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

Show DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

Generic DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

Associated Types

type Rep DocumentMetadata :: Type -> Type #

NFData DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

Methods

rnf :: DocumentMetadata -> () #

Hashable DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

FromJSON DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

type Rep DocumentMetadata Source # 
Instance details

Defined in Amazonka.Textract.Types.DocumentMetadata

type Rep DocumentMetadata = D1 ('MetaData "DocumentMetadata" "Amazonka.Textract.Types.DocumentMetadata" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "DocumentMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newDocumentMetadata :: DocumentMetadata Source #

Create a value of DocumentMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pages:DocumentMetadata', documentMetadata_pages - The number of pages that are detected in the document.

ExpenseDetection

data ExpenseDetection Source #

An object used to store information about the Value or Label detected by Amazon Textract.

See: newExpenseDetection smart constructor.

Instances

Instances details
Eq ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

Read ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

Show ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

Generic ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

Associated Types

type Rep ExpenseDetection :: Type -> Type #

NFData ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

Methods

rnf :: ExpenseDetection -> () #

Hashable ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

FromJSON ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

type Rep ExpenseDetection Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDetection

type Rep ExpenseDetection = D1 ('MetaData "ExpenseDetection" "Amazonka.Textract.Types.ExpenseDetection" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "ExpenseDetection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "geometry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Geometry)))))

newExpenseDetection :: ExpenseDetection Source #

Create a value of ExpenseDetection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:ExpenseDetection', expenseDetection_text - The word or line of text recognized by Amazon Textract

$sel:confidence:ExpenseDetection', expenseDetection_confidence - The confidence in detection, as a percentage

$sel:geometry:ExpenseDetection', expenseDetection_geometry - Undocumented member.

ExpenseDocument

data ExpenseDocument Source #

The structure holding all the information returned by AnalyzeExpense

See: newExpenseDocument smart constructor.

Instances

Instances details
Eq ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

Read ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

Show ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

Generic ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

Associated Types

type Rep ExpenseDocument :: Type -> Type #

NFData ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

Methods

rnf :: ExpenseDocument -> () #

Hashable ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

FromJSON ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

type Rep ExpenseDocument Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseDocument

type Rep ExpenseDocument = D1 ('MetaData "ExpenseDocument" "Amazonka.Textract.Types.ExpenseDocument" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "ExpenseDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lineItemGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LineItemGroup])) :*: (S1 ('MetaSel ('Just "summaryFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExpenseField])) :*: S1 ('MetaSel ('Just "expenseIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newExpenseDocument :: ExpenseDocument Source #

Create a value of ExpenseDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lineItemGroups:ExpenseDocument', expenseDocument_lineItemGroups - Information detected on each table of a document, seperated into LineItems.

$sel:summaryFields:ExpenseDocument', expenseDocument_summaryFields - Any information found outside of a table by Amazon Textract.

$sel:expenseIndex:ExpenseDocument', expenseDocument_expenseIndex - Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

ExpenseField

data ExpenseField Source #

Breakdown of detected information, seperated into the catagories Type, LableDetection, and ValueDetection

See: newExpenseField smart constructor.

Instances

Instances details
Eq ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

Read ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

Show ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

Generic ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

Associated Types

type Rep ExpenseField :: Type -> Type #

NFData ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

Methods

rnf :: ExpenseField -> () #

Hashable ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

FromJSON ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

type Rep ExpenseField Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseField

type Rep ExpenseField = D1 ('MetaData "ExpenseField" "Amazonka.Textract.Types.ExpenseField" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "ExpenseField'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "labelDetection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExpenseDetection)) :*: S1 ('MetaSel ('Just "valueDetection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExpenseDetection))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExpenseType)) :*: S1 ('MetaSel ('Just "pageNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newExpenseField :: ExpenseField Source #

Create a value of ExpenseField with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:labelDetection:ExpenseField', expenseField_labelDetection - The explicitly stated label of a detected element.

$sel:valueDetection:ExpenseField', expenseField_valueDetection - The value of a detected element. Present in explicit and implicit elements.

$sel:type':ExpenseField', expenseField_type - The implied label of a detected element. Present alongside LabelDetection for explicit elements.

$sel:pageNumber:ExpenseField', expenseField_pageNumber - The page number the value was detected on.

ExpenseType

data ExpenseType Source #

An object used to store information about the Type detected by Amazon Textract.

See: newExpenseType smart constructor.

Constructors

ExpenseType' (Maybe Text) (Maybe Double) 

Instances

Instances details
Eq ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

Read ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

Show ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

Generic ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

Associated Types

type Rep ExpenseType :: Type -> Type #

NFData ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

Methods

rnf :: ExpenseType -> () #

Hashable ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

FromJSON ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

type Rep ExpenseType Source # 
Instance details

Defined in Amazonka.Textract.Types.ExpenseType

type Rep ExpenseType = D1 ('MetaData "ExpenseType" "Amazonka.Textract.Types.ExpenseType" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "ExpenseType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newExpenseType :: ExpenseType Source #

Create a value of ExpenseType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:ExpenseType', expenseType_text - The word or line of text detected by Amazon Textract.

$sel:confidence:ExpenseType', expenseType_confidence - The confidence of accuracy, as a percentage.

Geometry

data Geometry Source #

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

See: newGeometry smart constructor.

Constructors

Geometry' (Maybe BoundingBox) (Maybe [Point]) 

Instances

Instances details
Eq Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

Read Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

Show Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

Generic Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

Associated Types

type Rep Geometry :: Type -> Type #

Methods

from :: Geometry -> Rep Geometry x #

to :: Rep Geometry x -> Geometry #

NFData Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

Methods

rnf :: Geometry -> () #

Hashable Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

Methods

hashWithSalt :: Int -> Geometry -> Int #

hash :: Geometry -> Int #

FromJSON Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

type Rep Geometry Source # 
Instance details

Defined in Amazonka.Textract.Types.Geometry

type Rep Geometry = D1 ('MetaData "Geometry" "Amazonka.Textract.Types.Geometry" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Geometry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "boundingBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoundingBox)) :*: S1 ('MetaSel ('Just "polygon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Point]))))

newGeometry :: Geometry Source #

Create a value of Geometry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:boundingBox:Geometry', geometry_boundingBox - An axis-aligned coarse representation of the location of the recognized item on the document page.

$sel:polygon:Geometry', geometry_polygon - Within the bounding box, a fine-grained polygon around the recognized item.

HumanLoopActivationOutput

data HumanLoopActivationOutput Source #

Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.

See: newHumanLoopActivationOutput smart constructor.

Instances

Instances details
Eq HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

Read HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

Show HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

Generic HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

Associated Types

type Rep HumanLoopActivationOutput :: Type -> Type #

NFData HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

Hashable HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

FromJSON HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

type Rep HumanLoopActivationOutput Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopActivationOutput

type Rep HumanLoopActivationOutput = D1 ('MetaData "HumanLoopActivationOutput" "Amazonka.Textract.Types.HumanLoopActivationOutput" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "HumanLoopActivationOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "humanLoopActivationReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "humanLoopArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "humanLoopActivationConditionsEvaluationResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newHumanLoopActivationOutput :: HumanLoopActivationOutput Source #

Create a value of HumanLoopActivationOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:humanLoopActivationReasons:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationReasons - Shows if and why human review was needed.

$sel:humanLoopArn:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopArn - The Amazon Resource Name (ARN) of the HumanLoop created.

$sel:humanLoopActivationConditionsEvaluationResults:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationConditionsEvaluationResults - Shows the result of condition evaluations, including those conditions which activated a human review.

HumanLoopConfig

data HumanLoopConfig Source #

Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.

See: newHumanLoopConfig smart constructor.

Instances

Instances details
Eq HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

Read HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

Show HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

Generic HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

Associated Types

type Rep HumanLoopConfig :: Type -> Type #

NFData HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

Methods

rnf :: HumanLoopConfig -> () #

Hashable HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

ToJSON HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

type Rep HumanLoopConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopConfig

type Rep HumanLoopConfig = D1 ('MetaData "HumanLoopConfig" "Amazonka.Textract.Types.HumanLoopConfig" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "HumanLoopConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopDataAttributes)) :*: (S1 ('MetaSel ('Just "humanLoopName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "flowDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newHumanLoopConfig Source #

Create a value of HumanLoopConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataAttributes:HumanLoopConfig', humanLoopConfig_dataAttributes - Sets attributes of the input data.

$sel:humanLoopName:HumanLoopConfig', humanLoopConfig_humanLoopName - The name of the human workflow used for this image. This should be kept unique within a region.

$sel:flowDefinitionArn:HumanLoopConfig', humanLoopConfig_flowDefinitionArn - The Amazon Resource Name (ARN) of the flow definition.

HumanLoopDataAttributes

data HumanLoopDataAttributes Source #

Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.

See: newHumanLoopDataAttributes smart constructor.

Instances

Instances details
Eq HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

Read HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

Show HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

Generic HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

Associated Types

type Rep HumanLoopDataAttributes :: Type -> Type #

NFData HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

Methods

rnf :: HumanLoopDataAttributes -> () #

Hashable HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

ToJSON HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

type Rep HumanLoopDataAttributes Source # 
Instance details

Defined in Amazonka.Textract.Types.HumanLoopDataAttributes

type Rep HumanLoopDataAttributes = D1 ('MetaData "HumanLoopDataAttributes" "Amazonka.Textract.Types.HumanLoopDataAttributes" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "HumanLoopDataAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentClassifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContentClassifier]))))

newHumanLoopDataAttributes :: HumanLoopDataAttributes Source #

Create a value of HumanLoopDataAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentClassifiers:HumanLoopDataAttributes', humanLoopDataAttributes_contentClassifiers - Sets whether the input image is free of personally identifiable information or adult content.

LineItemFields

data LineItemFields Source #

A structure that holds information about the different lines found in a document's tables.

See: newLineItemFields smart constructor.

Instances

Instances details
Eq LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

Read LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

Show LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

Generic LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

Associated Types

type Rep LineItemFields :: Type -> Type #

NFData LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

Methods

rnf :: LineItemFields -> () #

Hashable LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

FromJSON LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

type Rep LineItemFields Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemFields

type Rep LineItemFields = D1 ('MetaData "LineItemFields" "Amazonka.Textract.Types.LineItemFields" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "LineItemFields'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lineItemExpenseFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExpenseField]))))

newLineItemFields :: LineItemFields Source #

Create a value of LineItemFields with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lineItemExpenseFields:LineItemFields', lineItemFields_lineItemExpenseFields - ExpenseFields used to show information from detected lines on a table.

LineItemGroup

data LineItemGroup Source #

A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex.

See: newLineItemGroup smart constructor.

Instances

Instances details
Eq LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

Read LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

Show LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

Generic LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

Associated Types

type Rep LineItemGroup :: Type -> Type #

NFData LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

Methods

rnf :: LineItemGroup -> () #

Hashable LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

FromJSON LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

type Rep LineItemGroup Source # 
Instance details

Defined in Amazonka.Textract.Types.LineItemGroup

type Rep LineItemGroup = D1 ('MetaData "LineItemGroup" "Amazonka.Textract.Types.LineItemGroup" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "LineItemGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lineItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LineItemFields])) :*: S1 ('MetaSel ('Just "lineItemGroupIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newLineItemGroup :: LineItemGroup Source #

Create a value of LineItemGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lineItems:LineItemGroup', lineItemGroup_lineItems - The breakdown of information on a particular line of a table.

$sel:lineItemGroupIndex:LineItemGroup', lineItemGroup_lineItemGroupIndex - The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

NotificationChannel

data NotificationChannel Source #

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.

See: newNotificationChannel smart constructor.

Instances

Instances details
Eq NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

Read NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

Show NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

Generic NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

Associated Types

type Rep NotificationChannel :: Type -> Type #

NFData NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

rnf :: NotificationChannel -> () #

Hashable NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

ToJSON NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

type Rep NotificationChannel Source # 
Instance details

Defined in Amazonka.Textract.Types.NotificationChannel

type Rep NotificationChannel = D1 ('MetaData "NotificationChannel" "Amazonka.Textract.Types.NotificationChannel" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "NotificationChannel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sNSTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newNotificationChannel Source #

Create a value of NotificationChannel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sNSTopicArn:NotificationChannel', notificationChannel_sNSTopicArn - The Amazon SNS topic that Amazon Textract posts the completion status to.

$sel:roleArn:NotificationChannel', notificationChannel_roleArn - The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

OutputConfig

data OutputConfig Source #

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to and the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

See: newOutputConfig smart constructor.

Constructors

OutputConfig' (Maybe Text) Text 

Instances

Instances details
Eq OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

Read OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

Show OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

Generic OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

Associated Types

type Rep OutputConfig :: Type -> Type #

NFData OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

Methods

rnf :: OutputConfig -> () #

Hashable OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

ToJSON OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

type Rep OutputConfig Source # 
Instance details

Defined in Amazonka.Textract.Types.OutputConfig

type Rep OutputConfig = D1 ('MetaData "OutputConfig" "Amazonka.Textract.Types.OutputConfig" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "OutputConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newOutputConfig Source #

Create a value of OutputConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Prefix:OutputConfig', outputConfig_s3Prefix - The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

$sel:s3Bucket:OutputConfig', outputConfig_s3Bucket - The name of the bucket your output will go to.

Point

data Point Source #

The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.

An array of Point objects, Polygon, is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.

See: newPoint smart constructor.

Constructors

Point' (Maybe Double) (Maybe Double) 

Instances

Instances details
Eq Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

Methods

(==) :: Point -> Point -> Bool #

(/=) :: Point -> Point -> Bool #

Read Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

Show Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

Methods

showsPrec :: Int -> Point -> ShowS #

show :: Point -> String #

showList :: [Point] -> ShowS #

Generic Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

Associated Types

type Rep Point :: Type -> Type #

Methods

from :: Point -> Rep Point x #

to :: Rep Point x -> Point #

NFData Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

Methods

rnf :: Point -> () #

Hashable Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

Methods

hashWithSalt :: Int -> Point -> Int #

hash :: Point -> Int #

FromJSON Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

type Rep Point Source # 
Instance details

Defined in Amazonka.Textract.Types.Point

type Rep Point = D1 ('MetaData "Point" "Amazonka.Textract.Types.Point" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Point'" 'PrefixI 'True) (S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newPoint :: Point Source #

Create a value of Point with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:x:Point', point_x - The value of the X coordinate for a point on a Polygon.

$sel:y:Point', point_y - The value of the Y coordinate for a point on a Polygon.

Relationship

data Relationship Source #

Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block.

The Type element provides the type of the relationship for all blocks in the IDs array.

See: newRelationship smart constructor.

Instances

Instances details
Eq Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

Read Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

Show Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

Generic Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

Associated Types

type Rep Relationship :: Type -> Type #

NFData Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

Methods

rnf :: Relationship -> () #

Hashable Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

FromJSON Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

type Rep Relationship Source # 
Instance details

Defined in Amazonka.Textract.Types.Relationship

type Rep Relationship = D1 ('MetaData "Relationship" "Amazonka.Textract.Types.Relationship" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Relationship'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelationshipType))))

newRelationship :: Relationship Source #

Create a value of Relationship with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ids:Relationship', relationship_ids - An array of IDs for related blocks. You can get the type of the relationship from the Type element.

$sel:type':Relationship', relationship_type - The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.

S3Object

data S3Object Source #

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

See: newS3Object smart constructor.

Constructors

S3Object' (Maybe Text) (Maybe Text) (Maybe Text) 

Instances

Instances details
Eq S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

Read S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

Show S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

Generic S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

Associated Types

type Rep S3Object :: Type -> Type #

Methods

from :: S3Object -> Rep S3Object x #

to :: Rep S3Object x -> S3Object #

NFData S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

Methods

rnf :: S3Object -> () #

Hashable S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

Methods

hashWithSalt :: Int -> S3Object -> Int #

hash :: S3Object -> Int #

ToJSON S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

type Rep S3Object Source # 
Instance details

Defined in Amazonka.Textract.Types.S3Object

type Rep S3Object = D1 ('MetaData "S3Object" "Amazonka.Textract.Types.S3Object" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "S3Object'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newS3Object :: S3Object Source #

Create a value of S3Object with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bucket:S3Object', s3Object_bucket - The name of the S3 bucket. Note that the # character is not valid in the file name.

$sel:name:S3Object', s3Object_name - The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF format files.

$sel:version:S3Object', s3Object_version - If the bucket has versioning enabled, you can specify the object version.

Warning

data Warning Source #

A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).

See: newWarning smart constructor.

Constructors

Warning' (Maybe [Natural]) (Maybe Text) 

Instances

Instances details
Eq Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

Methods

(==) :: Warning -> Warning -> Bool #

(/=) :: Warning -> Warning -> Bool #

Read Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

Show Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

Generic Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

Associated Types

type Rep Warning :: Type -> Type #

Methods

from :: Warning -> Rep Warning x #

to :: Rep Warning x -> Warning #

NFData Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

Methods

rnf :: Warning -> () #

Hashable Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

Methods

hashWithSalt :: Int -> Warning -> Int #

hash :: Warning -> Int #

FromJSON Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

type Rep Warning Source # 
Instance details

Defined in Amazonka.Textract.Types.Warning

type Rep Warning = D1 ('MetaData "Warning" "Amazonka.Textract.Types.Warning" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Warning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural])) :*: S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newWarning :: Warning Source #

Create a value of Warning with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pages:Warning', warning_pages - A list of the pages that the warning applies to.

$sel:errorCode:Warning', warning_errorCode - The error code for the warning.