aws-sdk-go: github.com/aws/aws-sdk-go/service/textract Index | Files | Directories

package textract

import "github.com/aws/aws-sdk-go/service/textract"

Package textract provides the client and types for making API requests to Amazon Textract.

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

See https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27 for more information on this service.

See textract package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/textract/

Using the Client

To contact Amazon Textract with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Textract client Textract for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/textract/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // BlockTypeKeyValueSet is a BlockType enum value
    BlockTypeKeyValueSet = "KEY_VALUE_SET"

    // BlockTypePage is a BlockType enum value
    BlockTypePage = "PAGE"

    // BlockTypeLine is a BlockType enum value
    BlockTypeLine = "LINE"

    // BlockTypeWord is a BlockType enum value
    BlockTypeWord = "WORD"

    // BlockTypeTable is a BlockType enum value
    BlockTypeTable = "TABLE"

    // BlockTypeCell is a BlockType enum value
    BlockTypeCell = "CELL"

    // BlockTypeSelectionElement is a BlockType enum value
    BlockTypeSelectionElement = "SELECTION_ELEMENT"
)
const (
    // EntityTypeKey is a EntityType enum value
    EntityTypeKey = "KEY"

    // EntityTypeValue is a EntityType enum value
    EntityTypeValue = "VALUE"
)
const (
    // FeatureTypeTables is a FeatureType enum value
    FeatureTypeTables = "TABLES"

    // FeatureTypeForms is a FeatureType enum value
    FeatureTypeForms = "FORMS"
)
const (
    // JobStatusInProgress is a JobStatus enum value
    JobStatusInProgress = "IN_PROGRESS"

    // JobStatusSucceeded is a JobStatus enum value
    JobStatusSucceeded = "SUCCEEDED"

    // JobStatusFailed is a JobStatus enum value
    JobStatusFailed = "FAILED"

    // JobStatusPartialSuccess is a JobStatus enum value
    JobStatusPartialSuccess = "PARTIAL_SUCCESS"
)
const (
    // RelationshipTypeValue is a RelationshipType enum value
    RelationshipTypeValue = "VALUE"

    // RelationshipTypeChild is a RelationshipType enum value
    RelationshipTypeChild = "CHILD"
)
const (
    // SelectionStatusSelected is a SelectionStatus enum value
    SelectionStatusSelected = "SELECTED"

    // SelectionStatusNotSelected is a SelectionStatus enum value
    SelectionStatusNotSelected = "NOT_SELECTED"
)
const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // You aren't authorized to perform the action.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeBadDocumentException for service response error code
    // "BadDocumentException".
    //
    // Amazon Textract isn't able to read the document.
    ErrCodeBadDocumentException = "BadDocumentException"

    // ErrCodeDocumentTooLargeException for service response error code
    // "DocumentTooLargeException".
    //
    // The document can't be processed because it's too large. The maximum document
    // size for synchronous operations 5 MB. The maximum document size for asynchronous
    // operations is 500 MB for PDF format files.
    ErrCodeDocumentTooLargeException = "DocumentTooLargeException"

    // ErrCodeIdempotentParameterMismatchException for service response error code
    // "IdempotentParameterMismatchException".
    //
    // A ClientRequestToken input parameter was reused with an operation, but at
    // least one of the other input parameters is different from the previous call
    // to the operation.
    ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

    // ErrCodeInternalServerError for service response error code
    // "InternalServerError".
    //
    // Amazon Textract experienced a service issue. Try your call again.
    ErrCodeInternalServerError = "InternalServerError"

    // ErrCodeInvalidJobIdException for service response error code
    // "InvalidJobIdException".
    //
    // An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.
    ErrCodeInvalidJobIdException = "InvalidJobIdException"

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

    // ErrCodeInvalidS3ObjectException for service response error code
    // "InvalidS3ObjectException".
    //
    // Amazon Textract is unable to access the S3 object that's specified in the
    // request.
    ErrCodeInvalidS3ObjectException = "InvalidS3ObjectException"

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

    // ErrCodeProvisionedThroughputExceededException for service response error code
    // "ProvisionedThroughputExceededException".
    //
    // The number of requests exceeded your throughput limit. If you want to increase
    // this limit, contact Amazon Textract.
    ErrCodeProvisionedThroughputExceededException = "ProvisionedThroughputExceededException"

    // ErrCodeThrottlingException for service response error code
    // "ThrottlingException".
    //
    // Amazon Textract is temporarily unable to process the request. Try your call
    // again.
    ErrCodeThrottlingException = "ThrottlingException"

    // ErrCodeUnsupportedDocumentException for service response error code
    // "UnsupportedDocumentException".
    //
    // The format of the input document isn't supported. Amazon Textract supports
    // documents that are .png or .jpg format.
    ErrCodeUnsupportedDocumentException = "UnsupportedDocumentException"
)
const (
    ServiceName = "Textract" // Name of service.
    EndpointsID = "textract" // ID to lookup a service endpoint with.
    ServiceID   = "Textract" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type AnalyzeDocumentInput Uses

type AnalyzeDocumentInput struct {

    // 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 JPG or PNG format.
    //
    // If you are using an AWS SDK to call Amazon Textract, you might not need to
    // base64-encode image bytes passed using the Bytes field.
    //
    // Document is a required field
    Document *Document `type:"structure" required:"true"`

    // A list of the types of analysis to perform. Add TABLES to the list to return
    // information about the tables detected in the input document. Add FORMS to
    // return detected fields and the associated text. To perform both types of
    // analysis, add TABLES and FORMS to FeatureTypes.
    //
    // FeatureTypes is a required field
    FeatureTypes []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (AnalyzeDocumentInput) GoString Uses

func (s AnalyzeDocumentInput) GoString() string

GoString returns the string representation

func (*AnalyzeDocumentInput) SetDocument Uses

func (s *AnalyzeDocumentInput) SetDocument(v *Document) *AnalyzeDocumentInput

SetDocument sets the Document field's value.

func (*AnalyzeDocumentInput) SetFeatureTypes Uses

func (s *AnalyzeDocumentInput) SetFeatureTypes(v []*string) *AnalyzeDocumentInput

SetFeatureTypes sets the FeatureTypes field's value.

func (AnalyzeDocumentInput) String Uses

func (s AnalyzeDocumentInput) String() string

String returns the string representation

func (*AnalyzeDocumentInput) Validate Uses

func (s *AnalyzeDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyzeDocumentOutput Uses

type AnalyzeDocumentOutput struct {

    // The text that's detected and analyzed by AnalyzeDocument.
    Blocks []*Block `type:"list"`

    // Metadata about the analyzed document. An example is the number of pages.
    DocumentMetadata *DocumentMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (AnalyzeDocumentOutput) GoString Uses

func (s AnalyzeDocumentOutput) GoString() string

GoString returns the string representation

func (*AnalyzeDocumentOutput) SetBlocks Uses

func (s *AnalyzeDocumentOutput) SetBlocks(v []*Block) *AnalyzeDocumentOutput

SetBlocks sets the Blocks field's value.

func (*AnalyzeDocumentOutput) SetDocumentMetadata Uses

func (s *AnalyzeDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *AnalyzeDocumentOutput

SetDocumentMetadata sets the DocumentMetadata field's value.

func (AnalyzeDocumentOutput) String Uses

func (s AnalyzeDocumentOutput) String() string

String returns the string representation

type Block Uses

type Block struct {

    // The type of text that's recognized in a block. In text-detection operations,
    // 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's 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 a field 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 detected on a document page. A word is one or more ISO
    //    basic Latin script characters that aren't separated by spaces that's detected
    //    on a document page.
    //
    //    * LINE - A string of tab-delimited, contiguous words that's detected on
    //    a document page.
    //
    //    * TABLE - A table that's detected on a document page. A table is any grid-based
    //    information with 2 or more rows or columns with a cell span of 1 row and
    //    1 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 selectable element such as a radio button or checkbox
    //    that's detected on a document page. Use the value of SelectionStatus to
    //    determine the status of the selection element.
    BlockType *string `type:"string" enum:"BlockType"`

    // The column in which a table cell appears. The first column position is 1.
    // ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    ColumnIndex *int64 `type:"integer"`

    // The number of columns that a table cell spans. ColumnSpan isn't returned
    // by DetectDocumentText and GetDocumentTextDetection.
    ColumnSpan *int64 `type:"integer"`

    // The confidence that Amazon Textract has in the accuracy of the recognized
    // text and the accuracy of the geometry points around the recognized text.
    Confidence *float64 `type:"float"`

    // 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.
    EntityTypes []*string `type:"list"`

    // 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.
    Geometry *Geometry `type:"structure"`

    // The identifier for the recognized text. The identifier is only unique for
    // a single operation.
    Id  *string `type:"string"`

    // The page in which a block was detected. Page is returned by asynchronous
    // operations. Page values greater than 1 are only returned for multi-page documents
    // that are in PDF format. A scanned image (JPG/PNG), even if it contains multiple
    // document pages, is always considered to be a single-page document and the
    // value of Page is always 1. Synchronous operations don't return Page as every
    // input document is considered to be a single-page document.
    Page *int64 `type:"integer"`

    // 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.
    Relationships []*Relationship `type:"list"`

    // The row in which a table cell is located. The first row position is 1. RowIndex
    // isn't returned by DetectDocumentText and GetDocumentTextDetection.
    RowIndex *int64 `type:"integer"`

    // The number of rows that a table spans. RowSpan isn't returned by DetectDocumentText
    // and GetDocumentTextDetection.
    RowSpan *int64 `type:"integer"`

    // The selection status of a selectable element such as a radio button or checkbox.
    SelectionStatus *string `type:"string" enum:"SelectionStatus"`

    // The word or line of text that's recognized by Amazon Textract.
    Text *string `type:"string"`
    // contains filtered or unexported fields
}

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 depends on the type of operation. In document-text detection (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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html).

func (Block) GoString Uses

func (s Block) GoString() string

GoString returns the string representation

func (*Block) SetBlockType Uses

func (s *Block) SetBlockType(v string) *Block

SetBlockType sets the BlockType field's value.

func (*Block) SetColumnIndex Uses

func (s *Block) SetColumnIndex(v int64) *Block

SetColumnIndex sets the ColumnIndex field's value.

func (*Block) SetColumnSpan Uses

func (s *Block) SetColumnSpan(v int64) *Block

SetColumnSpan sets the ColumnSpan field's value.

func (*Block) SetConfidence Uses

func (s *Block) SetConfidence(v float64) *Block

SetConfidence sets the Confidence field's value.

func (*Block) SetEntityTypes Uses

func (s *Block) SetEntityTypes(v []*string) *Block

SetEntityTypes sets the EntityTypes field's value.

func (*Block) SetGeometry Uses

func (s *Block) SetGeometry(v *Geometry) *Block

SetGeometry sets the Geometry field's value.

func (*Block) SetId Uses

func (s *Block) SetId(v string) *Block

SetId sets the Id field's value.

func (*Block) SetPage Uses

func (s *Block) SetPage(v int64) *Block

SetPage sets the Page field's value.

func (*Block) SetRelationships Uses

func (s *Block) SetRelationships(v []*Relationship) *Block

SetRelationships sets the Relationships field's value.

func (*Block) SetRowIndex Uses

func (s *Block) SetRowIndex(v int64) *Block

SetRowIndex sets the RowIndex field's value.

func (*Block) SetRowSpan Uses

func (s *Block) SetRowSpan(v int64) *Block

SetRowSpan sets the RowSpan field's value.

func (*Block) SetSelectionStatus Uses

func (s *Block) SetSelectionStatus(v string) *Block

SetSelectionStatus sets the SelectionStatus field's value.

func (*Block) SetText Uses

func (s *Block) SetText(v string) *Block

SetText sets the Text field's value.

func (Block) String Uses

func (s Block) String() string

String returns the string representation

type BoundingBox Uses

type BoundingBox struct {

    // The height of the bounding box as a ratio of the overall document page height.
    Height *float64 `type:"float"`

    // The left coordinate of the bounding box as a ratio of overall document page
    // width.
    Left *float64 `type:"float"`

    // The top coordinate of the bounding box as a ratio of overall document page
    // height.
    Top *float64 `type:"float"`

    // The width of the bounding box as a ratio of the overall document page width.
    Width *float64 `type:"float"`
    // contains filtered or unexported fields
}

The bounding box around the recognized text, key, value, table or table cell 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.

func (BoundingBox) GoString Uses

func (s BoundingBox) GoString() string

GoString returns the string representation

func (*BoundingBox) SetHeight Uses

func (s *BoundingBox) SetHeight(v float64) *BoundingBox

SetHeight sets the Height field's value.

func (*BoundingBox) SetLeft Uses

func (s *BoundingBox) SetLeft(v float64) *BoundingBox

SetLeft sets the Left field's value.

func (*BoundingBox) SetTop Uses

func (s *BoundingBox) SetTop(v float64) *BoundingBox

SetTop sets the Top field's value.

func (*BoundingBox) SetWidth Uses

func (s *BoundingBox) SetWidth(v float64) *BoundingBox

SetWidth sets the Width field's value.

func (BoundingBox) String Uses

func (s BoundingBox) String() string

String returns the string representation

type DetectDocumentTextInput Uses

type DetectDocumentTextInput struct {

    // 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 JPG or PNG format.
    //
    // If you are using an AWS SDK to call Amazon Textract, you might not need to
    // base64-encode image bytes passed using the Bytes field.
    //
    // Document is a required field
    Document *Document `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DetectDocumentTextInput) GoString Uses

func (s DetectDocumentTextInput) GoString() string

GoString returns the string representation

func (*DetectDocumentTextInput) SetDocument Uses

func (s *DetectDocumentTextInput) SetDocument(v *Document) *DetectDocumentTextInput

SetDocument sets the Document field's value.

func (DetectDocumentTextInput) String Uses

func (s DetectDocumentTextInput) String() string

String returns the string representation

func (*DetectDocumentTextInput) Validate Uses

func (s *DetectDocumentTextInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectDocumentTextOutput Uses

type DetectDocumentTextOutput struct {

    // An array of Block objects containing the text detected in the document.
    Blocks []*Block `type:"list"`

    // Metadata about the document. Contains the number of pages that are detected
    // in the document.
    DocumentMetadata *DocumentMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (DetectDocumentTextOutput) GoString Uses

func (s DetectDocumentTextOutput) GoString() string

GoString returns the string representation

func (*DetectDocumentTextOutput) SetBlocks Uses

func (s *DetectDocumentTextOutput) SetBlocks(v []*Block) *DetectDocumentTextOutput

SetBlocks sets the Blocks field's value.

func (*DetectDocumentTextOutput) SetDocumentMetadata Uses

func (s *DetectDocumentTextOutput) SetDocumentMetadata(v *DocumentMetadata) *DetectDocumentTextOutput

SetDocumentMetadata sets the DocumentMetadata field's value.

func (DetectDocumentTextOutput) String Uses

func (s DetectDocumentTextOutput) String() string

String returns the string representation

type Document Uses

type Document struct {

    // A blob of base-64 encoded documents 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 JPG format.
    //
    // If you are using an AWS SDK to call Amazon Textract, you might not need to
    // base64-encode image bytes passed using the Bytes field.
    //
    // Bytes is automatically base64 encoded/decoded by the SDK.
    Bytes []byte `min:"1" type:"blob"`

    // Identifies an S3 object as the document source. The maximum size of a document
    // stored in an S3 bucket is 5 MB.
    S3Object *S3Object `type:"structure"`
    // contains filtered or unexported fields
}

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.

func (Document) GoString Uses

func (s Document) GoString() string

GoString returns the string representation

func (*Document) SetBytes Uses

func (s *Document) SetBytes(v []byte) *Document

SetBytes sets the Bytes field's value.

func (*Document) SetS3Object Uses

func (s *Document) SetS3Object(v *S3Object) *Document

SetS3Object sets the S3Object field's value.

func (Document) String Uses

func (s Document) String() string

String returns the string representation

func (*Document) Validate Uses

func (s *Document) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentLocation Uses

type DocumentLocation struct {

    // The Amazon S3 bucket that contains the input document.
    S3Object *S3Object `type:"structure"`
    // contains filtered or unexported fields
}

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 JPG or PNG format. It can also be a file in PDF format.

func (DocumentLocation) GoString Uses

func (s DocumentLocation) GoString() string

GoString returns the string representation

func (*DocumentLocation) SetS3Object Uses

func (s *DocumentLocation) SetS3Object(v *S3Object) *DocumentLocation

SetS3Object sets the S3Object field's value.

func (DocumentLocation) String Uses

func (s DocumentLocation) String() string

String returns the string representation

func (*DocumentLocation) Validate Uses

func (s *DocumentLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentMetadata Uses

type DocumentMetadata struct {

    // The number of pages detected in the document.
    Pages *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Information about the input document.

func (DocumentMetadata) GoString Uses

func (s DocumentMetadata) GoString() string

GoString returns the string representation

func (*DocumentMetadata) SetPages Uses

func (s *DocumentMetadata) SetPages(v int64) *DocumentMetadata

SetPages sets the Pages field's value.

func (DocumentMetadata) String Uses

func (s DocumentMetadata) String() string

String returns the string representation

type Geometry Uses

type Geometry struct {

    // An axis-aligned coarse representation of the location of the recognized text
    // on the document page.
    BoundingBox *BoundingBox `type:"structure"`

    // Within the bounding box, a fine-grained polygon around the recognized text.
    Polygon []*Point `type:"list"`
    // contains filtered or unexported fields
}

Information about where a recognized text, key, value, table, or table cell is located on a document page.

func (Geometry) GoString Uses

func (s Geometry) GoString() string

GoString returns the string representation

func (*Geometry) SetBoundingBox Uses

func (s *Geometry) SetBoundingBox(v *BoundingBox) *Geometry

SetBoundingBox sets the BoundingBox field's value.

func (*Geometry) SetPolygon Uses

func (s *Geometry) SetPolygon(v []*Point) *Geometry

SetPolygon sets the Polygon field's value.

func (Geometry) String Uses

func (s Geometry) String() string

String returns the string representation

type GetDocumentAnalysisInput Uses

type GetDocumentAnalysisInput struct {

    // A unique identifier for the text-detection job. The JobId is returned from
    // StartDocumentAnalysis.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`

    // 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.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetDocumentAnalysisInput) GoString Uses

func (s GetDocumentAnalysisInput) GoString() string

GoString returns the string representation

func (*GetDocumentAnalysisInput) SetJobId Uses

func (s *GetDocumentAnalysisInput) SetJobId(v string) *GetDocumentAnalysisInput

SetJobId sets the JobId field's value.

func (*GetDocumentAnalysisInput) SetMaxResults Uses

func (s *GetDocumentAnalysisInput) SetMaxResults(v int64) *GetDocumentAnalysisInput

SetMaxResults sets the MaxResults field's value.

func (*GetDocumentAnalysisInput) SetNextToken Uses

func (s *GetDocumentAnalysisInput) SetNextToken(v string) *GetDocumentAnalysisInput

SetNextToken sets the NextToken field's value.

func (GetDocumentAnalysisInput) String Uses

func (s GetDocumentAnalysisInput) String() string

String returns the string representation

func (*GetDocumentAnalysisInput) Validate Uses

func (s *GetDocumentAnalysisInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDocumentAnalysisOutput Uses

type GetDocumentAnalysisOutput struct {

    // The results of the text analysis operation.
    Blocks []*Block `type:"list"`

    // Information about a document that Amazon Textract processed. DocumentMetadata
    // is returned in every page of paginated responses from an Amazon Textract
    // video operation.
    DocumentMetadata *DocumentMetadata `type:"structure"`

    // The current status of the text detection job.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // The current status of an asynchronous document analysis operation.
    StatusMessage *string `type:"string"`

    // A list of warnings that occurred during the document analysis operation.
    Warnings []*Warning `type:"list"`
    // contains filtered or unexported fields
}

func (GetDocumentAnalysisOutput) GoString Uses

func (s GetDocumentAnalysisOutput) GoString() string

GoString returns the string representation

func (*GetDocumentAnalysisOutput) SetBlocks Uses

func (s *GetDocumentAnalysisOutput) SetBlocks(v []*Block) *GetDocumentAnalysisOutput

SetBlocks sets the Blocks field's value.

func (*GetDocumentAnalysisOutput) SetDocumentMetadata Uses

func (s *GetDocumentAnalysisOutput) SetDocumentMetadata(v *DocumentMetadata) *GetDocumentAnalysisOutput

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetDocumentAnalysisOutput) SetJobStatus Uses

func (s *GetDocumentAnalysisOutput) SetJobStatus(v string) *GetDocumentAnalysisOutput

SetJobStatus sets the JobStatus field's value.

func (*GetDocumentAnalysisOutput) SetNextToken Uses

func (s *GetDocumentAnalysisOutput) SetNextToken(v string) *GetDocumentAnalysisOutput

SetNextToken sets the NextToken field's value.

func (*GetDocumentAnalysisOutput) SetStatusMessage Uses

func (s *GetDocumentAnalysisOutput) SetStatusMessage(v string) *GetDocumentAnalysisOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetDocumentAnalysisOutput) SetWarnings Uses

func (s *GetDocumentAnalysisOutput) SetWarnings(v []*Warning) *GetDocumentAnalysisOutput

SetWarnings sets the Warnings field's value.

func (GetDocumentAnalysisOutput) String Uses

func (s GetDocumentAnalysisOutput) String() string

String returns the string representation

type GetDocumentTextDetectionInput Uses

type GetDocumentTextDetectionInput struct {

    // A unique identifier for the text detection job. The JobId is returned from
    // StartDocumentTextDetection.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`

    // 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.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetDocumentTextDetectionInput) GoString Uses

func (s GetDocumentTextDetectionInput) GoString() string

GoString returns the string representation

func (*GetDocumentTextDetectionInput) SetJobId Uses

func (s *GetDocumentTextDetectionInput) SetJobId(v string) *GetDocumentTextDetectionInput

SetJobId sets the JobId field's value.

func (*GetDocumentTextDetectionInput) SetMaxResults Uses

func (s *GetDocumentTextDetectionInput) SetMaxResults(v int64) *GetDocumentTextDetectionInput

SetMaxResults sets the MaxResults field's value.

func (*GetDocumentTextDetectionInput) SetNextToken Uses

func (s *GetDocumentTextDetectionInput) SetNextToken(v string) *GetDocumentTextDetectionInput

SetNextToken sets the NextToken field's value.

func (GetDocumentTextDetectionInput) String Uses

func (s GetDocumentTextDetectionInput) String() string

String returns the string representation

func (*GetDocumentTextDetectionInput) Validate Uses

func (s *GetDocumentTextDetectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDocumentTextDetectionOutput Uses

type GetDocumentTextDetectionOutput struct {

    // The results of the text-detection operation.
    Blocks []*Block `type:"list"`

    // Information about a document that Amazon Textract processed. DocumentMetadata
    // is returned in every page of paginated responses from an Amazon Textract
    // video operation.
    DocumentMetadata *DocumentMetadata `type:"structure"`

    // The current status of the text detection job.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // The current status of an asynchronous document text-detection operation.
    StatusMessage *string `type:"string"`

    // A list of warnings that occurred during the document text-detection operation.
    Warnings []*Warning `type:"list"`
    // contains filtered or unexported fields
}

func (GetDocumentTextDetectionOutput) GoString Uses

func (s GetDocumentTextDetectionOutput) GoString() string

GoString returns the string representation

func (*GetDocumentTextDetectionOutput) SetBlocks Uses

func (s *GetDocumentTextDetectionOutput) SetBlocks(v []*Block) *GetDocumentTextDetectionOutput

SetBlocks sets the Blocks field's value.

func (*GetDocumentTextDetectionOutput) SetDocumentMetadata Uses

func (s *GetDocumentTextDetectionOutput) SetDocumentMetadata(v *DocumentMetadata) *GetDocumentTextDetectionOutput

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetDocumentTextDetectionOutput) SetJobStatus Uses

func (s *GetDocumentTextDetectionOutput) SetJobStatus(v string) *GetDocumentTextDetectionOutput

SetJobStatus sets the JobStatus field's value.

func (*GetDocumentTextDetectionOutput) SetNextToken Uses

func (s *GetDocumentTextDetectionOutput) SetNextToken(v string) *GetDocumentTextDetectionOutput

SetNextToken sets the NextToken field's value.

func (*GetDocumentTextDetectionOutput) SetStatusMessage Uses

func (s *GetDocumentTextDetectionOutput) SetStatusMessage(v string) *GetDocumentTextDetectionOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetDocumentTextDetectionOutput) SetWarnings Uses

func (s *GetDocumentTextDetectionOutput) SetWarnings(v []*Warning) *GetDocumentTextDetectionOutput

SetWarnings sets the Warnings field's value.

func (GetDocumentTextDetectionOutput) String Uses

func (s GetDocumentTextDetectionOutput) String() string

String returns the string representation

type NotificationChannel Uses

type NotificationChannel struct {

    // The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract
    // publishing permissions to the Amazon SNS topic.
    //
    // RoleArn is a required field
    RoleArn *string `min:"20" type:"string" required:"true"`

    // The Amazon SNS topic that Amazon Textract posts the completion status to.
    //
    // SNSTopicArn is a required field
    SNSTopicArn *string `min:"20" type:"string" required:"true"`
    // contains filtered or unexported fields
}

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

func (NotificationChannel) GoString Uses

func (s NotificationChannel) GoString() string

GoString returns the string representation

func (*NotificationChannel) SetRoleArn Uses

func (s *NotificationChannel) SetRoleArn(v string) *NotificationChannel

SetRoleArn sets the RoleArn field's value.

func (*NotificationChannel) SetSNSTopicArn Uses

func (s *NotificationChannel) SetSNSTopicArn(v string) *NotificationChannel

SetSNSTopicArn sets the SNSTopicArn field's value.

func (NotificationChannel) String Uses

func (s NotificationChannel) String() string

String returns the string representation

func (*NotificationChannel) Validate Uses

func (s *NotificationChannel) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Point Uses

type Point struct {

    // The value of the X coordinate for a point on a Polygon.
    X   *float64 `type:"float"`

    // The value of the Y coordinate for a point on a Polygon.
    Y   *float64 `type:"float"`
    // contains filtered or unexported fields
}

The X and Y coordinates of a point on a document page. The X and Y values 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.

func (Point) GoString Uses

func (s Point) GoString() string

GoString returns the string representation

func (*Point) SetX Uses

func (s *Point) SetX(v float64) *Point

SetX sets the X field's value.

func (*Point) SetY Uses

func (s *Point) SetY(v float64) *Point

SetY sets the Y field's value.

func (Point) String Uses

func (s Point) String() string

String returns the string representation

type Relationship Uses

type Relationship struct {

    // An array of IDs for related blocks. You can get the type of the relationship
    // from the Type element.
    Ids []*string `type:"list"`

    // The type of relationship that the blocks in the IDs array have with the current
    // block. The relationship can be VALUE or CHILD.
    Type *string `type:"string" enum:"RelationshipType"`
    // contains filtered or unexported fields
}

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.

func (Relationship) GoString Uses

func (s Relationship) GoString() string

GoString returns the string representation

func (*Relationship) SetIds Uses

func (s *Relationship) SetIds(v []*string) *Relationship

SetIds sets the Ids field's value.

func (*Relationship) SetType Uses

func (s *Relationship) SetType(v string) *Relationship

SetType sets the Type field's value.

func (Relationship) String Uses

func (s Relationship) String() string

String returns the string representation

type S3Object Uses

type S3Object struct {

    // The name of the S3 bucket.
    Bucket *string `min:"3" type:"string"`

    // The file name of the input document. It must be an image file (.JPG or .PNG
    // format). Asynchronous operations also support PDF files.
    Name *string `min:"1" type:"string"`

    // If the bucket has versioning enabled, you can specify the object version.
    Version *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

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.

func (S3Object) GoString Uses

func (s S3Object) GoString() string

GoString returns the string representation

func (*S3Object) SetBucket Uses

func (s *S3Object) SetBucket(v string) *S3Object

SetBucket sets the Bucket field's value.

func (*S3Object) SetName Uses

func (s *S3Object) SetName(v string) *S3Object

SetName sets the Name field's value.

func (*S3Object) SetVersion Uses

func (s *S3Object) SetVersion(v string) *S3Object

SetVersion sets the Version field's value.

func (S3Object) String Uses

func (s S3Object) String() string

String returns the string representation

func (*S3Object) Validate Uses

func (s *S3Object) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDocumentAnalysisInput Uses

type StartDocumentAnalysisInput struct {

    // 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.
    ClientRequestToken *string `min:"1" type:"string"`

    // The location of the document to be processed.
    //
    // DocumentLocation is a required field
    DocumentLocation *DocumentLocation `type:"structure" required:"true"`

    // 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 fields and the associated text. To perform both
    // types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements
    // (SELECTION_ELEMENT) that are detected are returned, whatever the value of
    // FeatureTypes.
    //
    // FeatureTypes is a required field
    FeatureTypes []*string `type:"list" required:"true"`

    // An identifier you specify that's included in the completion notification
    // that's published to the Amazon SNS topic. For example, you can use JobTag
    // to identify the type of document, such as a tax form or a receipt, that the
    // completion notification corresponds to.
    JobTag *string `min:"1" type:"string"`

    // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion
    // status of the operation to.
    NotificationChannel *NotificationChannel `type:"structure"`
    // contains filtered or unexported fields
}

func (StartDocumentAnalysisInput) GoString Uses

func (s StartDocumentAnalysisInput) GoString() string

GoString returns the string representation

func (*StartDocumentAnalysisInput) SetClientRequestToken Uses

func (s *StartDocumentAnalysisInput) SetClientRequestToken(v string) *StartDocumentAnalysisInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentAnalysisInput) SetDocumentLocation Uses

func (s *StartDocumentAnalysisInput) SetDocumentLocation(v *DocumentLocation) *StartDocumentAnalysisInput

SetDocumentLocation sets the DocumentLocation field's value.

func (*StartDocumentAnalysisInput) SetFeatureTypes Uses

func (s *StartDocumentAnalysisInput) SetFeatureTypes(v []*string) *StartDocumentAnalysisInput

SetFeatureTypes sets the FeatureTypes field's value.

func (*StartDocumentAnalysisInput) SetJobTag Uses

func (s *StartDocumentAnalysisInput) SetJobTag(v string) *StartDocumentAnalysisInput

SetJobTag sets the JobTag field's value.

func (*StartDocumentAnalysisInput) SetNotificationChannel Uses

func (s *StartDocumentAnalysisInput) SetNotificationChannel(v *NotificationChannel) *StartDocumentAnalysisInput

SetNotificationChannel sets the NotificationChannel field's value.

func (StartDocumentAnalysisInput) String Uses

func (s StartDocumentAnalysisInput) String() string

String returns the string representation

func (*StartDocumentAnalysisInput) Validate Uses

func (s *StartDocumentAnalysisInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDocumentAnalysisOutput Uses

type StartDocumentAnalysisOutput struct {

    // The identifier for the document text detection job. Use JobId to identify
    // the job in a subsequent call to GetDocumentAnalysis.
    JobId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartDocumentAnalysisOutput) GoString Uses

func (s StartDocumentAnalysisOutput) GoString() string

GoString returns the string representation

func (*StartDocumentAnalysisOutput) SetJobId Uses

func (s *StartDocumentAnalysisOutput) SetJobId(v string) *StartDocumentAnalysisOutput

SetJobId sets the JobId field's value.

func (StartDocumentAnalysisOutput) String Uses

func (s StartDocumentAnalysisOutput) String() string

String returns the string representation

type StartDocumentTextDetectionInput Uses

type StartDocumentTextDetectionInput struct {

    // 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.
    ClientRequestToken *string `min:"1" type:"string"`

    // The location of the document to be processed.
    //
    // DocumentLocation is a required field
    DocumentLocation *DocumentLocation `type:"structure" required:"true"`

    // An identifier you specify that's included in the completion notification
    // that's published to the Amazon SNS topic. For example, you can use JobTag
    // to identify the type of document, such as a tax form or a receipt, that the
    // completion notification corresponds to.
    JobTag *string `min:"1" type:"string"`

    // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion
    // status of the operation to.
    NotificationChannel *NotificationChannel `type:"structure"`
    // contains filtered or unexported fields
}

func (StartDocumentTextDetectionInput) GoString Uses

func (s StartDocumentTextDetectionInput) GoString() string

GoString returns the string representation

func (*StartDocumentTextDetectionInput) SetClientRequestToken Uses

func (s *StartDocumentTextDetectionInput) SetClientRequestToken(v string) *StartDocumentTextDetectionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentTextDetectionInput) SetDocumentLocation Uses

func (s *StartDocumentTextDetectionInput) SetDocumentLocation(v *DocumentLocation) *StartDocumentTextDetectionInput

SetDocumentLocation sets the DocumentLocation field's value.

func (*StartDocumentTextDetectionInput) SetJobTag Uses

func (s *StartDocumentTextDetectionInput) SetJobTag(v string) *StartDocumentTextDetectionInput

SetJobTag sets the JobTag field's value.

func (*StartDocumentTextDetectionInput) SetNotificationChannel Uses

func (s *StartDocumentTextDetectionInput) SetNotificationChannel(v *NotificationChannel) *StartDocumentTextDetectionInput

SetNotificationChannel sets the NotificationChannel field's value.

func (StartDocumentTextDetectionInput) String Uses

func (s StartDocumentTextDetectionInput) String() string

String returns the string representation

func (*StartDocumentTextDetectionInput) Validate Uses

func (s *StartDocumentTextDetectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDocumentTextDetectionOutput Uses

type StartDocumentTextDetectionOutput struct {

    // The identifier for the document text-detection job. Use JobId to identify
    // the job in a subsequent call to GetDocumentTextDetection.
    JobId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartDocumentTextDetectionOutput) GoString Uses

func (s StartDocumentTextDetectionOutput) GoString() string

GoString returns the string representation

func (*StartDocumentTextDetectionOutput) SetJobId Uses

func (s *StartDocumentTextDetectionOutput) SetJobId(v string) *StartDocumentTextDetectionOutput

SetJobId sets the JobId field's value.

func (StartDocumentTextDetectionOutput) String Uses

func (s StartDocumentTextDetectionOutput) String() string

String returns the string representation

type Textract Uses

type Textract struct {
    *client.Client
}

Textract provides the API operation methods for making requests to Amazon Textract. See this package's package overview docs for details on the service.

Textract methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Textract

New creates a new instance of the Textract client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a Textract client from just a session.
svc := textract.New(mySession)

// Create a Textract client with additional configuration
svc := textract.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Textract) AnalyzeDocument Uses

func (c *Textract) AnalyzeDocument(input *AnalyzeDocumentInput) (*AnalyzeDocumentOutput, error)

AnalyzeDocument API operation for Amazon Textract.

Analyzes an input document for relationships between detected items.

The types of information returned are as follows:

* Words and lines that are related to nearby lines and words. The related
information is returned in two Block objects each of type KEY_VALUE_SET:
a KEY Block object and a VALUE Block object. For example, Name: Ana Silva
Carolina contains a key and value. Name: is the key. Ana Silva Carolina
is the value.

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

* Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT
Block object contains information about a selectable element.

* Lines and words of text. A LINE Block object contains one or more WORD
Block objects.

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

The output is returned in a list of BLOCK objects.

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

For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Textract's API operation AnalyzeDocument for usage and error information.

Returned Error Codes:

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

* ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
Amazon Textract is unable to access the S3 object that's specified in the
request.

* ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
The format of the input document isn't supported. Amazon Textract supports
documents that are .png or .jpg format.

* ErrCodeDocumentTooLargeException "DocumentTooLargeException"
The document can't be processed because it's too large. The maximum document
size for synchronous operations 5 MB. The maximum document size for asynchronous
operations is 500 MB for PDF format files.

* ErrCodeBadDocumentException "BadDocumentException"
Amazon Textract isn't able to read the document.

* ErrCodeAccessDeniedException "AccessDeniedException"
You aren't authorized to perform the action.

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

* ErrCodeInternalServerError "InternalServerError"
Amazon Textract experienced a service issue. Try your call again.

* ErrCodeThrottlingException "ThrottlingException"
Amazon Textract is temporarily unable to process the request. Try your call
again.

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocument

func (*Textract) AnalyzeDocumentRequest Uses

func (c *Textract) AnalyzeDocumentRequest(input *AnalyzeDocumentInput) (req *request.Request, output *AnalyzeDocumentOutput)

AnalyzeDocumentRequest generates a "aws/request.Request" representing the client's request for the AnalyzeDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AnalyzeDocument for more information on using the AnalyzeDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AnalyzeDocumentRequest method.
req, resp := client.AnalyzeDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocument

func (*Textract) AnalyzeDocumentWithContext Uses

func (c *Textract) AnalyzeDocumentWithContext(ctx aws.Context, input *AnalyzeDocumentInput, opts ...request.Option) (*AnalyzeDocumentOutput, error)

AnalyzeDocumentWithContext is the same as AnalyzeDocument with the addition of the ability to pass a context and additional request options.

See AnalyzeDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Textract) DetectDocumentText Uses

func (c *Textract) DetectDocumentText(input *DetectDocumentTextInput) (*DetectDocumentTextOutput, error)

DetectDocumentText API operation for Amazon Textract.

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in an array of Block objects.

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

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

For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Textract's API operation DetectDocumentText for usage and error information.

Returned Error Codes:

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

* ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
Amazon Textract is unable to access the S3 object that's specified in the
request.

* ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
The format of the input document isn't supported. Amazon Textract supports
documents that are .png or .jpg format.

* ErrCodeDocumentTooLargeException "DocumentTooLargeException"
The document can't be processed because it's too large. The maximum document
size for synchronous operations 5 MB. The maximum document size for asynchronous
operations is 500 MB for PDF format files.

* ErrCodeBadDocumentException "BadDocumentException"
Amazon Textract isn't able to read the document.

* ErrCodeAccessDeniedException "AccessDeniedException"
You aren't authorized to perform the action.

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

* ErrCodeInternalServerError "InternalServerError"
Amazon Textract experienced a service issue. Try your call again.

* ErrCodeThrottlingException "ThrottlingException"
Amazon Textract is temporarily unable to process the request. Try your call
again.

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectDocumentText

func (*Textract) DetectDocumentTextRequest Uses

func (c *Textract) DetectDocumentTextRequest(input *DetectDocumentTextInput) (req *request.Request, output *DetectDocumentTextOutput)

DetectDocumentTextRequest generates a "aws/request.Request" representing the client's request for the DetectDocumentText operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectDocumentText for more information on using the DetectDocumentText API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetectDocumentTextRequest method.
req, resp := client.DetectDocumentTextRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectDocumentText

func (*Textract) DetectDocumentTextWithContext Uses

func (c *Textract) DetectDocumentTextWithContext(ctx aws.Context, input *DetectDocumentTextInput, opts ...request.Option) (*DetectDocumentTextOutput, error)

DetectDocumentTextWithContext is the same as DetectDocumentText with the addition of the ability to pass a context and additional request options.

See DetectDocumentText for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Textract) GetDocumentAnalysis Uses

func (c *Textract) GetDocumentAnalysis(input *GetDocumentAnalysisInput) (*GetDocumentAnalysisOutput, error)

GetDocumentAnalysis API operation for Amazon Textract.

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

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

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

* Words and lines that are related to nearby lines and words. The related
information is returned in two Block objects each of type KEY_VALUE_SET:
a KEY Block object and a VALUE Block object. For example, Name: Ana Silva
Carolina contains a key and value. Name: is the key. Ana Silva Carolina
is the value.

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

* Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT
Block object contains information about a selectable element.

* Lines and words of text. A LINE Block object contains one or more WORD
Block objects.

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

For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Textract's API operation GetDocumentAnalysis for usage and error information.

Returned Error Codes:

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

* ErrCodeAccessDeniedException "AccessDeniedException"
You aren't authorized to perform the action.

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

* ErrCodeInvalidJobIdException "InvalidJobIdException"
An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

* ErrCodeInternalServerError "InternalServerError"
Amazon Textract experienced a service issue. Try your call again.

* ErrCodeThrottlingException "ThrottlingException"
Amazon Textract is temporarily unable to process the request. Try your call
again.

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentAnalysis

func (*Textract) GetDocumentAnalysisRequest Uses

func (c *Textract) GetDocumentAnalysisRequest(input *GetDocumentAnalysisInput) (req *request.Request, output *GetDocumentAnalysisOutput)

GetDocumentAnalysisRequest generates a "aws/request.Request" representing the client's request for the GetDocumentAnalysis operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDocumentAnalysis for more information on using the GetDocumentAnalysis API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDocumentAnalysisRequest method.
req, resp := client.GetDocumentAnalysisRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentAnalysis

func (*Textract) GetDocumentAnalysisWithContext Uses

func (c *Textract) GetDocumentAnalysisWithContext(ctx aws.Context, input *GetDocumentAnalysisInput, opts ...request.Option) (*GetDocumentAnalysisOutput, error)

GetDocumentAnalysisWithContext is the same as GetDocumentAnalysis with the addition of the ability to pass a context and additional request options.

See GetDocumentAnalysis for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Textract) GetDocumentTextDetection Uses

func (c *Textract) GetDocumentTextDetection(input *GetDocumentTextDetectionInput) (*GetDocumentTextDetectionOutput, error)

GetDocumentTextDetection API operation for Amazon Textract.

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

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

GetDocumentTextDetection returns an array of Block objects.

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

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

For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Textract's API operation GetDocumentTextDetection for usage and error information.

Returned Error Codes:

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

* ErrCodeAccessDeniedException "AccessDeniedException"
You aren't authorized to perform the action.

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

* ErrCodeInvalidJobIdException "InvalidJobIdException"
An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

* ErrCodeInternalServerError "InternalServerError"
Amazon Textract experienced a service issue. Try your call again.

* ErrCodeThrottlingException "ThrottlingException"
Amazon Textract is temporarily unable to process the request. Try your call
again.

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection

func (*Textract) GetDocumentTextDetectionRequest Uses

func (c *Textract) GetDocumentTextDetectionRequest(input *GetDocumentTextDetectionInput) (req *request.Request, output *GetDocumentTextDetectionOutput)

GetDocumentTextDetectionRequest generates a "aws/request.Request" representing the client's request for the GetDocumentTextDetection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDocumentTextDetection for more information on using the GetDocumentTextDetection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDocumentTextDetectionRequest method.
req, resp := client.GetDocumentTextDetectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection

func (*Textract) GetDocumentTextDetectionWithContext Uses

func (c *Textract) GetDocumentTextDetectionWithContext(ctx aws.Context, input *GetDocumentTextDetectionInput, opts ...request.Option) (*GetDocumentTextDetectionOutput, error)

GetDocumentTextDetectionWithContext is the same as GetDocumentTextDetection with the addition of the ability to pass a context and additional request options.

See GetDocumentTextDetection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Textract) StartDocumentAnalysis Uses

func (c *Textract) StartDocumentAnalysis(input *StartDocumentAnalysisInput) (*StartDocumentAnalysisOutput, error)

StartDocumentAnalysis API operation for Amazon Textract.

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

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

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

For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Textract's API operation StartDocumentAnalysis for usage and error information.

Returned Error Codes:

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

* ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
Amazon Textract is unable to access the S3 object that's specified in the
request.

* ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
The format of the input document isn't supported. Amazon Textract supports
documents that are .png or .jpg format.

* ErrCodeDocumentTooLargeException "DocumentTooLargeException"
The document can't be processed because it's too large. The maximum document
size for synchronous operations 5 MB. The maximum document size for asynchronous
operations is 500 MB for PDF format files.

* ErrCodeBadDocumentException "BadDocumentException"
Amazon Textract isn't able to read the document.

* ErrCodeAccessDeniedException "AccessDeniedException"
You aren't authorized to perform the action.

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

* ErrCodeInternalServerError "InternalServerError"
Amazon Textract experienced a service issue. Try your call again.

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

* ErrCodeThrottlingException "ThrottlingException"
Amazon Textract is temporarily unable to process the request. Try your call
again.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysis

func (*Textract) StartDocumentAnalysisRequest Uses

func (c *Textract) StartDocumentAnalysisRequest(input *StartDocumentAnalysisInput) (req *request.Request, output *StartDocumentAnalysisOutput)

StartDocumentAnalysisRequest generates a "aws/request.Request" representing the client's request for the StartDocumentAnalysis operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDocumentAnalysis for more information on using the StartDocumentAnalysis API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDocumentAnalysisRequest method.
req, resp := client.StartDocumentAnalysisRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysis

func (*Textract) StartDocumentAnalysisWithContext Uses

func (c *Textract) StartDocumentAnalysisWithContext(ctx aws.Context, input *StartDocumentAnalysisInput, opts ...request.Option) (*StartDocumentAnalysisOutput, error)

StartDocumentAnalysisWithContext is the same as StartDocumentAnalysis with the addition of the ability to pass a context and additional request options.

See StartDocumentAnalysis for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Textract) StartDocumentTextDetection Uses

func (c *Textract) StartDocumentTextDetection(input *StartDocumentTextDetectionInput) (*StartDocumentTextDetectionOutput, error)

StartDocumentTextDetection API operation for Amazon Textract.

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

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

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

For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Textract's API operation StartDocumentTextDetection for usage and error information.

Returned Error Codes:

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

* ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
Amazon Textract is unable to access the S3 object that's specified in the
request.

* ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
The format of the input document isn't supported. Amazon Textract supports
documents that are .png or .jpg format.

* ErrCodeDocumentTooLargeException "DocumentTooLargeException"
The document can't be processed because it's too large. The maximum document
size for synchronous operations 5 MB. The maximum document size for asynchronous
operations is 500 MB for PDF format files.

* ErrCodeBadDocumentException "BadDocumentException"
Amazon Textract isn't able to read the document.

* ErrCodeAccessDeniedException "AccessDeniedException"
You aren't authorized to perform the action.

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

* ErrCodeInternalServerError "InternalServerError"
Amazon Textract experienced a service issue. Try your call again.

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

* ErrCodeThrottlingException "ThrottlingException"
Amazon Textract is temporarily unable to process the request. Try your call
again.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetection

func (*Textract) StartDocumentTextDetectionRequest Uses

func (c *Textract) StartDocumentTextDetectionRequest(input *StartDocumentTextDetectionInput) (req *request.Request, output *StartDocumentTextDetectionOutput)

StartDocumentTextDetectionRequest generates a "aws/request.Request" representing the client's request for the StartDocumentTextDetection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDocumentTextDetection for more information on using the StartDocumentTextDetection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDocumentTextDetectionRequest method.
req, resp := client.StartDocumentTextDetectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetection

func (*Textract) StartDocumentTextDetectionWithContext Uses

func (c *Textract) StartDocumentTextDetectionWithContext(ctx aws.Context, input *StartDocumentTextDetectionInput, opts ...request.Option) (*StartDocumentTextDetectionOutput, error)

StartDocumentTextDetectionWithContext is the same as StartDocumentTextDetection with the addition of the ability to pass a context and additional request options.

See StartDocumentTextDetection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Warning Uses

type Warning struct {

    // The error code for the warning.
    ErrorCode *string `type:"string"`

    // A list of the pages that the warning applies to.
    Pages []*int64 `type:"list"`
    // contains filtered or unexported fields
}

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

func (Warning) GoString Uses

func (s Warning) GoString() string

GoString returns the string representation

func (*Warning) SetErrorCode Uses

func (s *Warning) SetErrorCode(v string) *Warning

SetErrorCode sets the ErrorCode field's value.

func (*Warning) SetPages Uses

func (s *Warning) SetPages(v []*int64) *Warning

SetPages sets the Pages field's value.

func (Warning) String Uses

func (s Warning) String() string

String returns the string representation

Directories

PathSynopsis
textractifacePackage textractiface provides an interface to enable mocking the Amazon Textract service client for testing your code.

Package textract imports 7 packages (graph) and is imported by 8 packages. Updated 2019-05-27. Refresh now. Tools for package owners.