const (
    // AdapterVersionStatusActive is a AdapterVersionStatus enum value
    AdapterVersionStatusActive = "ACTIVE"

    // AdapterVersionStatusAtRisk is a AdapterVersionStatus enum value
    AdapterVersionStatusAtRisk = "AT_RISK"

    // AdapterVersionStatusDeprecated is a AdapterVersionStatus enum value
    AdapterVersionStatusDeprecated = "DEPRECATED"

    // AdapterVersionStatusCreationError is a AdapterVersionStatus enum value
    AdapterVersionStatusCreationError = "CREATION_ERROR"

    // AdapterVersionStatusCreationInProgress is a AdapterVersionStatus enum value
    AdapterVersionStatusCreationInProgress = "CREATION_IN_PROGRESS"
)

const (
    // AutoUpdateEnabled is a AutoUpdate enum value
    AutoUpdateEnabled = "ENABLED"

    // AutoUpdateDisabled is a AutoUpdate enum value
    AutoUpdateDisabled = "DISABLED"
)

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"

    // BlockTypeMergedCell is a BlockType enum value
    BlockTypeMergedCell = "MERGED_CELL"

    // BlockTypeTitle is a BlockType enum value
    BlockTypeTitle = "TITLE"

    // BlockTypeQuery is a BlockType enum value
    BlockTypeQuery = "QUERY"

    // BlockTypeQueryResult is a BlockType enum value
    BlockTypeQueryResult = "QUERY_RESULT"

    // BlockTypeSignature is a BlockType enum value
    BlockTypeSignature = "SIGNATURE"

    // BlockTypeTableTitle is a BlockType enum value
    BlockTypeTableTitle = "TABLE_TITLE"

    // BlockTypeTableFooter is a BlockType enum value
    BlockTypeTableFooter = "TABLE_FOOTER"

    // BlockTypeLayoutText is a BlockType enum value
    BlockTypeLayoutText = "LAYOUT_TEXT"

    // BlockTypeLayoutTitle is a BlockType enum value
    BlockTypeLayoutTitle = "LAYOUT_TITLE"

    // BlockTypeLayoutHeader is a BlockType enum value
    BlockTypeLayoutHeader = "LAYOUT_HEADER"

    // BlockTypeLayoutFooter is a BlockType enum value
    BlockTypeLayoutFooter = "LAYOUT_FOOTER"

    // BlockTypeLayoutSectionHeader is a BlockType enum value
    BlockTypeLayoutSectionHeader = "LAYOUT_SECTION_HEADER"

    // BlockTypeLayoutPageNumber is a BlockType enum value
    BlockTypeLayoutPageNumber = "LAYOUT_PAGE_NUMBER"

    // BlockTypeLayoutList is a BlockType enum value
    BlockTypeLayoutList = "LAYOUT_LIST"

    // BlockTypeLayoutFigure is a BlockType enum value
    BlockTypeLayoutFigure = "LAYOUT_FIGURE"

    // BlockTypeLayoutTable is a BlockType enum value
    BlockTypeLayoutTable = "LAYOUT_TABLE"

    // BlockTypeLayoutKeyValue is a BlockType enum value
    BlockTypeLayoutKeyValue = "LAYOUT_KEY_VALUE"
)

const (
    // ContentClassifierFreeOfPersonallyIdentifiableInformation is a ContentClassifier enum value
    ContentClassifierFreeOfPersonallyIdentifiableInformation = "FreeOfPersonallyIdentifiableInformation"

    // ContentClassifierFreeOfAdultContent is a ContentClassifier enum value
    ContentClassifierFreeOfAdultContent = "FreeOfAdultContent"
)

const (
    // EntityTypeKey is a EntityType enum value
    EntityTypeKey = "KEY"

    // EntityTypeValue is a EntityType enum value
    EntityTypeValue = "VALUE"

    // EntityTypeColumnHeader is a EntityType enum value
    EntityTypeColumnHeader = "COLUMN_HEADER"

    // EntityTypeTableTitle is a EntityType enum value
    EntityTypeTableTitle = "TABLE_TITLE"

    // EntityTypeTableFooter is a EntityType enum value
    EntityTypeTableFooter = "TABLE_FOOTER"

    // EntityTypeTableSectionTitle is a EntityType enum value
    EntityTypeTableSectionTitle = "TABLE_SECTION_TITLE"

    // EntityTypeTableSummary is a EntityType enum value
    EntityTypeTableSummary = "TABLE_SUMMARY"

    // EntityTypeStructuredTable is a EntityType enum value
    EntityTypeStructuredTable = "STRUCTURED_TABLE"

    // EntityTypeSemiStructuredTable is a EntityType enum value
    EntityTypeSemiStructuredTable = "SEMI_STRUCTURED_TABLE"
)

const (
    // FeatureTypeTables is a FeatureType enum value
    FeatureTypeTables = "TABLES"

    // FeatureTypeForms is a FeatureType enum value
    FeatureTypeForms = "FORMS"

    // FeatureTypeQueries is a FeatureType enum value
    FeatureTypeQueries = "QUERIES"

    // FeatureTypeSignatures is a FeatureType enum value
    FeatureTypeSignatures = "SIGNATURES"

    // FeatureTypeLayout is a FeatureType enum value
    FeatureTypeLayout = "LAYOUT"
)

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"

    // RelationshipTypeComplexFeatures is a RelationshipType enum value
    RelationshipTypeComplexFeatures = "COMPLEX_FEATURES"

    // RelationshipTypeMergedCell is a RelationshipType enum value
    RelationshipTypeMergedCell = "MERGED_CELL"

    // RelationshipTypeTitle is a RelationshipType enum value
    RelationshipTypeTitle = "TITLE"

    // RelationshipTypeAnswer is a RelationshipType enum value
    RelationshipTypeAnswer = "ANSWER"

    // RelationshipTypeTable is a RelationshipType enum value
    RelationshipTypeTable = "TABLE"

    // RelationshipTypeTableTitle is a RelationshipType enum value
    RelationshipTypeTableTitle = "TABLE_TITLE"

    // RelationshipTypeTableFooter is a RelationshipType enum value
    RelationshipTypeTableFooter = "TABLE_FOOTER"
)

const (
    // SelectionStatusSelected is a SelectionStatus enum value
    SelectionStatusSelected = "SELECTED"

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

const (
    // TextTypeHandwriting is a TextType enum value
    TextTypeHandwriting = "HANDWRITING"

    // TextTypePrinted is a TextType enum value
    TextTypePrinted = "PRINTED"
)

const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // You aren't authorized to perform the action. Use the Amazon Resource Name
    // (ARN) of an authorized user or IAM role to perform the operation.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeBadDocumentException for service response error code
    // "BadDocumentException".
    //
    // Amazon Textract isn't able to read the document. For more information on
    // the document limits in Amazon Textract, see limits.
    ErrCodeBadDocumentException = "BadDocumentException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // Updating or deleting a resource can cause an inconsistent state.
    ErrCodeConflictException = "ConflictException"

    // 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 10 MB. The maximum document size for asynchronous
    // operations is 500 MB for PDF files.
    ErrCodeDocumentTooLargeException = "DocumentTooLargeException"

    // ErrCodeHumanLoopQuotaExceededException for service response error code
    // "HumanLoopQuotaExceededException".
    //
    // Indicates you have exceeded the maximum number of active human in the loop
    // workflows available
    ErrCodeHumanLoopQuotaExceededException = "HumanLoopQuotaExceededException"

    // 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 an asynchronous analysis operation.
    ErrCodeInvalidJobIdException = "InvalidJobIdException"

    // ErrCodeInvalidKMSKeyException for service response error code
    // "InvalidKMSKeyException".
    //
    // Indicates you do not have decrypt permissions with the KMS key entered, or
    // the KMS key was entered incorrectly.
    ErrCodeInvalidKMSKeyException = "InvalidKMSKeyException"

    // 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. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)
    // For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
    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"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // Returned when an operation tried to access a nonexistent resource.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceQuotaExceededException for service response error code
    // "ServiceQuotaExceededException".
    //
    // Returned when a request cannot be completed as it would exceed a maximum
    // service quota.
    ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

    // 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. Documents for operations
    // can be in PNG, JPEG, PDF, or TIFF format.
    ErrCodeUnsupportedDocumentException = "UnsupportedDocumentException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // Indicates that a request was not valid. Check request for proper formatting.
    ErrCodeValidationException = "ValidationException"
)

const (
    ServiceName = "Textract" // Name of service.
    EndpointsID = "textract" // ID to lookup a service endpoint with.
    ServiceID   = "Textract" // ServiceID is a unique identifier of a specific service.
)

const (
    // ValueTypeDate is a ValueType enum value
    ValueTypeDate = "DATE"
)

func AdapterVersionStatus_Values ¶

func AdapterVersionStatus_Values() []string

AdapterVersionStatus_Values returns all elements of the AdapterVersionStatus enum

func AutoUpdate_Values ¶

func AutoUpdate_Values() []string

AutoUpdate_Values returns all elements of the AutoUpdate enum

func BlockType_Values ¶

func BlockType_Values() []string

BlockType_Values returns all elements of the BlockType enum

func ContentClassifier_Values ¶

func ContentClassifier_Values() []string

ContentClassifier_Values returns all elements of the ContentClassifier enum

func EntityType_Values ¶

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func FeatureType_Values ¶

func FeatureType_Values() []string

FeatureType_Values returns all elements of the FeatureType enum

func JobStatus_Values ¶

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func RelationshipType_Values ¶

func RelationshipType_Values() []string

RelationshipType_Values returns all elements of the RelationshipType enum

func SelectionStatus_Values ¶

func SelectionStatus_Values() []string

SelectionStatus_Values returns all elements of the SelectionStatus enum

func TextType_Values ¶

func TextType_Values() []string

TextType_Values returns all elements of the TextType enum

func ValueType_Values ¶

func ValueType_Values() []string

ValueType_Values returns all elements of the ValueType enum

type AccessDeniedException ¶

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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.

func (*AccessDeniedException) Code ¶

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error ¶

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString ¶

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message ¶

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr ¶

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID ¶

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode ¶

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String ¶

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Adapter ¶

type Adapter struct {

    // A unique identifier for the adapter resource.
    //
    // AdapterId is a required field
    AdapterId *string `min:"12" type:"string" required:"true"`

    // Pages is a parameter that the user inputs to specify which pages to apply
    // an adapter to. The following is a list of rules for using this parameter.
    //
    //    * If a page is not specified, it is set to ["1"] by default.
    //
    //    * The following characters are allowed in the parameter's string: 0 1
    //    2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    //
    //    * When using * to indicate all pages, it must be the only element in the
    //    list.
    //
    //    * You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates
    //    last page of document.
    //
    //    * Specified pages must be greater than 0 and less than or equal to the
    //    number of pages in the document.
    Pages []*string `min:"1" type:"list"`

    // A string that identifies the version of the adapter.
    //
    // Version is a required field
    Version *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

func (Adapter) GoString ¶

func (s Adapter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Adapter) SetAdapterId ¶

func (s *Adapter) SetAdapterId(v string) *Adapter

SetAdapterId sets the AdapterId field's value.

func (*Adapter) SetPages ¶

func (s *Adapter) SetPages(v []*string) *Adapter

SetPages sets the Pages field's value.

func (*Adapter) SetVersion ¶

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

SetVersion sets the Version field's value.

func (Adapter) String ¶

func (s Adapter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Adapter) Validate ¶

func (s *Adapter) Validate() error

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

type AdapterOverview ¶

type AdapterOverview struct {

    // A unique identifier for the adapter resource.
    AdapterId *string `min:"12" type:"string"`

    // A string naming the adapter resource.
    AdapterName *string `min:"1" type:"string"`

    // The date and time that the adapter was created.
    CreationTime *time.Time `type:"timestamp"`

    // The feature types that the adapter is operating on.
    FeatureTypes []*string `type:"list" enum:"FeatureType"`
    // contains filtered or unexported fields
}

Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.

func (AdapterOverview) GoString ¶

func (s AdapterOverview) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdapterOverview) SetAdapterId ¶

func (s *AdapterOverview) SetAdapterId(v string) *AdapterOverview

SetAdapterId sets the AdapterId field's value.

func (*AdapterOverview) SetAdapterName ¶

func (s *AdapterOverview) SetAdapterName(v string) *AdapterOverview

SetAdapterName sets the AdapterName field's value.

func (*AdapterOverview) SetCreationTime ¶

func (s *AdapterOverview) SetCreationTime(v time.Time) *AdapterOverview

SetCreationTime sets the CreationTime field's value.

func (*AdapterOverview) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (AdapterOverview) String ¶

func (s AdapterOverview) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdapterVersionDatasetConfig ¶

type AdapterVersionDatasetConfig struct {

    // 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.
    ManifestS3Object *S3Object `type:"structure"`
    // contains filtered or unexported fields
}

The dataset configuration options for a given version of an adapter. Can include an Amazon S3 bucket if specified.

func (AdapterVersionDatasetConfig) GoString ¶

func (s AdapterVersionDatasetConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdapterVersionDatasetConfig) SetManifestS3Object ¶

func (s *AdapterVersionDatasetConfig) SetManifestS3Object(v *S3Object) *AdapterVersionDatasetConfig

SetManifestS3Object sets the ManifestS3Object field's value.

func (AdapterVersionDatasetConfig) String ¶

func (s AdapterVersionDatasetConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdapterVersionDatasetConfig) Validate ¶

func (s *AdapterVersionDatasetConfig) Validate() error

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

type AdapterVersionEvaluationMetric ¶

type AdapterVersionEvaluationMetric struct {

    // The F1 score, precision, and recall metrics for the baseline model.
    AdapterVersion *EvaluationMetric `type:"structure"`

    // The F1 score, precision, and recall metrics for the baseline model.
    Baseline *EvaluationMetric `type:"structure"`

    // Indicates the feature type being analyzed by a given adapter version.
    FeatureType *string `type:"string" enum:"FeatureType"`
    // contains filtered or unexported fields
}

Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance.

func (AdapterVersionEvaluationMetric) GoString ¶

func (s AdapterVersionEvaluationMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdapterVersionEvaluationMetric) SetAdapterVersion ¶

func (s *AdapterVersionEvaluationMetric) SetAdapterVersion(v *EvaluationMetric) *AdapterVersionEvaluationMetric

SetAdapterVersion sets the AdapterVersion field's value.

func (*AdapterVersionEvaluationMetric) SetBaseline ¶

func (s *AdapterVersionEvaluationMetric) SetBaseline(v *EvaluationMetric) *AdapterVersionEvaluationMetric

SetBaseline sets the Baseline field's value.

func (*AdapterVersionEvaluationMetric) SetFeatureType ¶

func (s *AdapterVersionEvaluationMetric) SetFeatureType(v string) *AdapterVersionEvaluationMetric

SetFeatureType sets the FeatureType field's value.

func (AdapterVersionEvaluationMetric) String ¶

func (s AdapterVersionEvaluationMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdapterVersionOverview ¶

type AdapterVersionOverview struct {

    // A unique identifier for the adapter associated with a given adapter version.
    AdapterId *string `min:"12" type:"string"`

    // An identified for a given adapter version.
    AdapterVersion *string `min:"1" type:"string"`

    // The date and time that a given adapter version was created.
    CreationTime *time.Time `type:"timestamp"`

    // The feature types that the adapter version is operating on.
    FeatureTypes []*string `type:"list" enum:"FeatureType"`

    // Contains information on the status of a given adapter version.
    Status *string `type:"string" enum:"AdapterVersionStatus"`

    // A message explaining the status of a given adapter vesion.
    StatusMessage *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.

func (AdapterVersionOverview) GoString ¶

func (s AdapterVersionOverview) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdapterVersionOverview) SetAdapterId ¶

func (s *AdapterVersionOverview) SetAdapterId(v string) *AdapterVersionOverview

SetAdapterId sets the AdapterId field's value.

func (*AdapterVersionOverview) SetAdapterVersion ¶

func (s *AdapterVersionOverview) SetAdapterVersion(v string) *AdapterVersionOverview

SetAdapterVersion sets the AdapterVersion field's value.

func (*AdapterVersionOverview) SetCreationTime ¶

func (s *AdapterVersionOverview) SetCreationTime(v time.Time) *AdapterVersionOverview

SetCreationTime sets the CreationTime field's value.

func (*AdapterVersionOverview) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (*AdapterVersionOverview) SetStatus ¶

func (s *AdapterVersionOverview) SetStatus(v string) *AdapterVersionOverview

SetStatus sets the Status field's value.

func (*AdapterVersionOverview) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (AdapterVersionOverview) String ¶

func (s AdapterVersionOverview) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdaptersConfig ¶

type AdaptersConfig struct {

    // A list of adapters to be used when analyzing the specified document.
    //
    // Adapters is a required field
    Adapters []*Adapter `min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version

func (AdaptersConfig) GoString ¶

func (s AdaptersConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdaptersConfig) SetAdapters ¶

func (s *AdaptersConfig) SetAdapters(v []*Adapter) *AdaptersConfig

SetAdapters sets the Adapters field's value.

func (AdaptersConfig) String ¶

func (s AdaptersConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdaptersConfig) Validate ¶

func (s *AdaptersConfig) Validate() error

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

type AnalyzeDocumentInput ¶

type AnalyzeDocumentInput struct {

    // Specifies the adapter to be used when analyzing a document.
    AdaptersConfig *AdaptersConfig `type:"structure"`

    // 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, PNG, PDF, or TIFF 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.
    //
    // 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 that are detected in the input document. Add
    // FORMS to return detected form data. Add SIGNATURES to return the locations
    // of detected signatures. Add LAYOUT to the list to return information about
    // the layout of the document. All lines and words detected in the document
    // are included in the response (including text that isn't related to the value
    // of FeatureTypes).
    //
    // FeatureTypes is a required field
    FeatureTypes []*string `type:"list" required:"true" enum:"FeatureType"`

    // Sets the configuration for the human in the loop workflow for analyzing documents.
    HumanLoopConfig *HumanLoopConfig `type:"structure"`

    // Contains Queries and the alias for those Queries, as determined by the input.
    QueriesConfig *QueriesConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (AnalyzeDocumentInput) GoString ¶

func (s AnalyzeDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeDocumentInput) SetAdaptersConfig ¶

func (s *AnalyzeDocumentInput) SetAdaptersConfig(v *AdaptersConfig) *AnalyzeDocumentInput

SetAdaptersConfig sets the AdaptersConfig field's value.

func (*AnalyzeDocumentInput) SetDocument ¶

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

SetDocument sets the Document field's value.

func (*AnalyzeDocumentInput) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (*AnalyzeDocumentInput) SetHumanLoopConfig ¶

func (s *AnalyzeDocumentInput) SetHumanLoopConfig(v *HumanLoopConfig) *AnalyzeDocumentInput

SetHumanLoopConfig sets the HumanLoopConfig field's value.

func (*AnalyzeDocumentInput) SetQueriesConfig ¶

func (s *AnalyzeDocumentInput) SetQueriesConfig(v *QueriesConfig) *AnalyzeDocumentInput

SetQueriesConfig sets the QueriesConfig field's value.

func (AnalyzeDocumentInput) String ¶

func (s AnalyzeDocumentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeDocumentInput) Validate ¶

func (s *AnalyzeDocumentInput) Validate() error

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

type AnalyzeDocumentOutput ¶

type AnalyzeDocumentOutput struct {

    // The version of the model used to analyze the document.
    AnalyzeDocumentModelVersion *string `type:"string"`

    // The items that are 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"`

    // Shows the results of the human in the loop evaluation.
    HumanLoopActivationOutput *HumanLoopActivationOutput `type:"structure"`
    // contains filtered or unexported fields
}

func (AnalyzeDocumentOutput) GoString ¶

func (s AnalyzeDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeDocumentOutput) SetAnalyzeDocumentModelVersion ¶

func (s *AnalyzeDocumentOutput) SetAnalyzeDocumentModelVersion(v string) *AnalyzeDocumentOutput

SetAnalyzeDocumentModelVersion sets the AnalyzeDocumentModelVersion field's value.

func (*AnalyzeDocumentOutput) SetBlocks ¶

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

SetBlocks sets the Blocks field's value.

func (*AnalyzeDocumentOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*AnalyzeDocumentOutput) SetHumanLoopActivationOutput ¶

func (s *AnalyzeDocumentOutput) SetHumanLoopActivationOutput(v *HumanLoopActivationOutput) *AnalyzeDocumentOutput

SetHumanLoopActivationOutput sets the HumanLoopActivationOutput field's value.

func (AnalyzeDocumentOutput) String ¶

func (s AnalyzeDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnalyzeExpenseInput ¶

type AnalyzeExpenseInput struct {

    // 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.
    //
    // Document is a required field
    Document *Document `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (AnalyzeExpenseInput) GoString ¶

func (s AnalyzeExpenseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeExpenseInput) SetDocument ¶

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

SetDocument sets the Document field's value.

func (AnalyzeExpenseInput) String ¶

func (s AnalyzeExpenseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeExpenseInput) Validate ¶

func (s *AnalyzeExpenseInput) Validate() error

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

type AnalyzeExpenseOutput ¶

type AnalyzeExpenseOutput struct {

    // Information about the input document.
    DocumentMetadata *DocumentMetadata `type:"structure"`

    // The expenses detected by Amazon Textract.
    ExpenseDocuments []*ExpenseDocument `type:"list"`
    // contains filtered or unexported fields
}

func (AnalyzeExpenseOutput) GoString ¶

func (s AnalyzeExpenseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeExpenseOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*AnalyzeExpenseOutput) SetExpenseDocuments ¶

func (s *AnalyzeExpenseOutput) SetExpenseDocuments(v []*ExpenseDocument) *AnalyzeExpenseOutput

SetExpenseDocuments sets the ExpenseDocuments field's value.

func (AnalyzeExpenseOutput) String ¶

func (s AnalyzeExpenseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnalyzeIDDetections ¶

type AnalyzeIDDetections struct {

    // The confidence score of the detected text.
    Confidence *float64 `type:"float"`

    // Only returned for dates, returns the type of value detected and the date
    // written in a more machine readable way.
    NormalizedValue *NormalizedValue `type:"structure"`

    // Text of either the normalized field or value associated with it.
    //
    // Text is a required field
    Text *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Used to contain the information detected by an AnalyzeID operation.

func (AnalyzeIDDetections) GoString ¶

func (s AnalyzeIDDetections) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeIDDetections) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*AnalyzeIDDetections) SetNormalizedValue ¶

func (s *AnalyzeIDDetections) SetNormalizedValue(v *NormalizedValue) *AnalyzeIDDetections

SetNormalizedValue sets the NormalizedValue field's value.

func (*AnalyzeIDDetections) SetText ¶

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

SetText sets the Text field's value.

func (AnalyzeIDDetections) String ¶

func (s AnalyzeIDDetections) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnalyzeIDInput ¶

type AnalyzeIDInput struct {

    // The document being passed to AnalyzeID.
    //
    // DocumentPages is a required field
    DocumentPages []*Document `min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (AnalyzeIDInput) GoString ¶

func (s AnalyzeIDInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeIDInput) SetDocumentPages ¶

func (s *AnalyzeIDInput) SetDocumentPages(v []*Document) *AnalyzeIDInput

SetDocumentPages sets the DocumentPages field's value.

func (AnalyzeIDInput) String ¶

func (s AnalyzeIDInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeIDInput) Validate ¶

func (s *AnalyzeIDInput) Validate() error

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

type AnalyzeIDOutput ¶

type AnalyzeIDOutput struct {

    // The version of the AnalyzeIdentity API being used to process documents.
    AnalyzeIDModelVersion *string `type:"string"`

    // Information about the input document.
    DocumentMetadata *DocumentMetadata `type:"structure"`

    // The list of documents processed by AnalyzeID. Includes a number denoting
    // their place in the list and the response structure for the document.
    IdentityDocuments []*IdentityDocument `type:"list"`
    // contains filtered or unexported fields
}

func (AnalyzeIDOutput) GoString ¶

func (s AnalyzeIDOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyzeIDOutput) SetAnalyzeIDModelVersion ¶

func (s *AnalyzeIDOutput) SetAnalyzeIDModelVersion(v string) *AnalyzeIDOutput

SetAnalyzeIDModelVersion sets the AnalyzeIDModelVersion field's value.

func (*AnalyzeIDOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*AnalyzeIDOutput) SetIdentityDocuments ¶

func (s *AnalyzeIDOutput) SetIdentityDocuments(v []*IdentityDocument) *AnalyzeIDOutput

SetIdentityDocuments sets the IdentityDocuments field's value.

func (AnalyzeIDOutput) String ¶

func (s AnalyzeIDOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadDocumentException ¶

type BadDocumentException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*BadDocumentException) Code ¶

func (s *BadDocumentException) Code() string

Code returns the exception type name.

func (*BadDocumentException) Error ¶

func (s *BadDocumentException) Error() string

func (BadDocumentException) GoString ¶

func (s BadDocumentException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadDocumentException) Message ¶

func (s *BadDocumentException) Message() string

Message returns the exception's message.

func (*BadDocumentException) OrigErr ¶

func (s *BadDocumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadDocumentException) RequestID ¶

func (s *BadDocumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadDocumentException) StatusCode ¶

func (s *BadDocumentException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadDocumentException) String ¶

func (s BadDocumentException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Block ¶

type Block struct {

    // 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.
    //
    //    * TABLE_TITLE - The title of a table. A title is typically a line of text
    //    above or below a table, or embedded as the first row of a table.
    //
    //    * TABLE_FOOTER - The footer associated with a table. A footer is typically
    //    a line or lines of text below a table or embedded as the last row of a
    //    table.
    //
    //    * CELL - A cell within a detected table. The cell is the parent of the
    //    block that contains the text in the cell.
    //
    //    * MERGED_CELL - A cell in a table whose content spans more than one row
    //    or column. The Relationships array for this cell contain data from individual
    //    cells.
    //
    //    * 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.
    //
    //    * SIGNATURE - The location and confidence score of a signature detected
    //    on a document page. Can be returned as part of a Key-Value pair or a detected
    //    cell.
    //
    //    * QUERY - A question asked during the call of AnalyzeDocument. Contains
    //    an alias and an ID that attaches it to its answer.
    //
    //    * QUERY_RESULT - A response to a question asked during the call of analyze
    //    document. Comes with an alias and ID for ease of locating in a response.
    //    Also contains location and confidence score.
    //
    // The following BlockTypes are only returned for Amazon Textract Layout.
    //
    //    * LAYOUT_TITLE - The main title of the document.
    //
    //    * LAYOUT_HEADER - Text located in the top margin of the document.
    //
    //    * LAYOUT_FOOTER - Text located in the bottom margin of the document.
    //
    //    * LAYOUT_SECTION_HEADER - The titles of sections within a document.
    //
    //    * LAYOUT_PAGE_NUMBER - The page number of the documents.
    //
    //    * LAYOUT_LIST - Any information grouped together in list form.
    //
    //    * LAYOUT_FIGURE - Indicates the location of an image in a document.
    //
    //    * LAYOUT_TABLE - Indicates the location of a table in the document.
    //
    //    * LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.
    //
    //    * LAYOUT_TEXT - Text that is present typically as a part of paragraphs
    //    in documents.
    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 score 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 entity types can be returned by FORMS analysis:
    //
    //    * KEY - An identifier for a field on the document.
    //
    //    * VALUE - The field text.
    //
    // The following entity types can be returned by TABLES analysis:
    //
    //    * COLUMN_HEADER - Identifies a cell that is a header of a column.
    //
    //    * TABLE_TITLE - Identifies a cell that is a title within the table.
    //
    //    * TABLE_SECTION_TITLE - Identifies a cell that is a title of a section
    //    within a table. A section title is a cell that typically spans an entire
    //    row above a section.
    //
    //    * TABLE_FOOTER - Identifies a cell that is a footer of a table.
    //
    //    * TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell
    //    can be a row of a table or an additional, smaller table that contains
    //    summary information for another table.
    //
    //    * STRUCTURED_TABLE - Identifies a table with column headers where the
    //    content of each row corresponds to the headers.
    //
    //    * SEMI_STRUCTURED_TABLE - Identifies a non-structured table.
    //
    // EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    EntityTypes []*string `type:"list" enum:"EntityType"`

    // 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 on which a block was detected. Page is returned by synchronous and
    // asynchronous operations. Page values greater than 1 are only returned for
    // multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG)
    // provided to an asynchronous operation, even if it contains multiple document
    // pages, is considered a single-page document. This means that for scanned
    // images the value of Page is always 1.
    Page *int64 `type:"integer"`

    // Each query contains the question you want to ask in the Text and the alias
    // you want to associate.
    Query *Query `type:"structure"`

    // A list of relationship objects that describe how blocks are related to each
    // other. For example, a LINE block object contains a CHILD relationship type
    // with the WORD blocks that make up 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.
    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 cell spans. RowSpan isn't returned by DetectDocumentText
    // and GetDocumentTextDetection.
    RowSpan *int64 `type:"integer"`

    // The selection status of a selection element, such as an option button or
    // check box.
    SelectionStatus *string `type:"string" enum:"SelectionStatus"`

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

    // The kind of text that Amazon Textract has detected. Can check for handwritten
    // text and printed text.
    TextType *string `type:"string" enum:"TextType"`
    // 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 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html).

func (Block) GoString ¶

func (s Block) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Block) SetBlockType ¶

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

SetBlockType sets the BlockType field's value.

func (*Block) SetColumnIndex ¶

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

SetColumnIndex sets the ColumnIndex field's value.

func (*Block) SetColumnSpan ¶

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

SetColumnSpan sets the ColumnSpan field's value.

func (*Block) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*Block) SetEntityTypes ¶

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

SetEntityTypes sets the EntityTypes field's value.

func (*Block) SetGeometry ¶

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

SetGeometry sets the Geometry field's value.

func (*Block) SetId ¶

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

SetId sets the Id field's value.

func (*Block) SetPage ¶

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

SetPage sets the Page field's value.

func (*Block) SetQuery ¶

func (s *Block) SetQuery(v *Query) *Block

SetQuery sets the Query field's value.

func (*Block) SetRelationships ¶

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

SetRelationships sets the Relationships field's value.

func (*Block) SetRowIndex ¶

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

SetRowIndex sets the RowIndex field's value.

func (*Block) SetRowSpan ¶

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

SetRowSpan sets the RowSpan field's value.

func (*Block) SetSelectionStatus ¶

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

SetSelectionStatus sets the SelectionStatus field's value.

func (*Block) SetText ¶

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

SetText sets the Text field's value.

func (*Block) SetTextType ¶

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

SetTextType sets the TextType field's value.

func (Block) String ¶

func (s Block) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BoundingBox ¶

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

func (BoundingBox) GoString ¶

func (s BoundingBox) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BoundingBox) SetHeight ¶

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

SetHeight sets the Height field's value.

func (*BoundingBox) SetLeft ¶

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

SetLeft sets the Left field's value.

func (*BoundingBox) SetTop ¶

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

SetTop sets the Top field's value.

func (*BoundingBox) SetWidth ¶

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

SetWidth sets the Width field's value.

func (BoundingBox) String ¶

func (s BoundingBox) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException ¶

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Updating or deleting a resource can cause an inconsistent state.

func (*ConflictException) Code ¶

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error ¶

func (s *ConflictException) Error() string

func (ConflictException) GoString ¶

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message ¶

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr ¶

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID ¶

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode ¶

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String ¶

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAdapterInput ¶

type CreateAdapterInput struct {

    // The name to be assigned to the adapter being created.
    //
    // AdapterName is a required field
    AdapterName *string `min:"1" type:"string" required:"true"`

    // Controls whether or not the adapter should automatically update.
    AutoUpdate *string `type:"string" enum:"AutoUpdate"`

    // Idempotent token is used to recognize the request. If the same token is used
    // with multiple CreateAdapter requests, the same session is returned. This
    // token is employed to avoid unintentionally creating the same session multiple
    // times.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The description to be assigned to the adapter being created.
    Description *string `min:"1" type:"string"`

    // The type of feature that the adapter is being trained on. Currrenly, supported
    // feature types are: QUERIES
    //
    // FeatureTypes is a required field
    FeatureTypes []*string `type:"list" required:"true" enum:"FeatureType"`

    // A list of tags to be added to the adapter.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (CreateAdapterInput) GoString ¶

func (s CreateAdapterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAdapterInput) SetAdapterName ¶

func (s *CreateAdapterInput) SetAdapterName(v string) *CreateAdapterInput

SetAdapterName sets the AdapterName field's value.

func (*CreateAdapterInput) SetAutoUpdate ¶

func (s *CreateAdapterInput) SetAutoUpdate(v string) *CreateAdapterInput

SetAutoUpdate sets the AutoUpdate field's value.

func (*CreateAdapterInput) SetClientRequestToken ¶

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateAdapterInput) SetDescription ¶

func (s *CreateAdapterInput) SetDescription(v string) *CreateAdapterInput

SetDescription sets the Description field's value.

func (*CreateAdapterInput) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (*CreateAdapterInput) SetTags ¶

func (s *CreateAdapterInput) SetTags(v map[string]*string) *CreateAdapterInput

SetTags sets the Tags field's value.

func (CreateAdapterInput) String ¶

func (s CreateAdapterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAdapterInput) Validate ¶

func (s *CreateAdapterInput) Validate() error

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

type CreateAdapterOutput ¶

type CreateAdapterOutput struct {

    // A string containing the unique ID for the adapter that has been created.
    AdapterId *string `min:"12" type:"string"`
    // contains filtered or unexported fields
}

func (CreateAdapterOutput) GoString ¶

func (s CreateAdapterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAdapterOutput) SetAdapterId ¶

func (s *CreateAdapterOutput) SetAdapterId(v string) *CreateAdapterOutput

SetAdapterId sets the AdapterId field's value.

func (CreateAdapterOutput) String ¶

func (s CreateAdapterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAdapterVersionInput ¶

type CreateAdapterVersionInput struct {

    // A string containing a unique ID for the adapter that will receive a new version.
    //
    // AdapterId is a required field
    AdapterId *string `min:"12" type:"string" required:"true"`

    // Idempotent token is used to recognize the request. If the same token is used
    // with multiple CreateAdapterVersion requests, the same session is returned.
    // This token is employed to avoid unintentionally creating the same session
    // multiple times.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object
    // as the value.
    //
    // DatasetConfig is a required field
    DatasetConfig *AdapterVersionDatasetConfig `type:"structure" required:"true"`

    // The identifier for your AWS Key Management Service key (AWS KMS key). Used
    // to encrypt your documents.
    KMSKeyId *string `min:"1" type:"string"`

    // 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 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. (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)
    //
    // For more information on data privacy, see the Data Privacy FAQ (https://aws.amazon.com/compliance/data-privacy-faq/).
    //
    // OutputConfig is a required field
    OutputConfig *OutputConfig `type:"structure" required:"true"`

    // A set of tags (key-value pairs) that you want to attach to the adapter version.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (CreateAdapterVersionInput) GoString ¶

func (s CreateAdapterVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAdapterVersionInput) SetAdapterId ¶

func (s *CreateAdapterVersionInput) SetAdapterId(v string) *CreateAdapterVersionInput

SetAdapterId sets the AdapterId field's value.

func (*CreateAdapterVersionInput) SetClientRequestToken ¶

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateAdapterVersionInput) SetDatasetConfig ¶

func (s *CreateAdapterVersionInput) SetDatasetConfig(v *AdapterVersionDatasetConfig) *CreateAdapterVersionInput

SetDatasetConfig sets the DatasetConfig field's value.

func (*CreateAdapterVersionInput) SetKMSKeyId ¶

func (s *CreateAdapterVersionInput) SetKMSKeyId(v string) *CreateAdapterVersionInput

SetKMSKeyId sets the KMSKeyId field's value.

func (*CreateAdapterVersionInput) SetOutputConfig ¶

func (s *CreateAdapterVersionInput) SetOutputConfig(v *OutputConfig) *CreateAdapterVersionInput

SetOutputConfig sets the OutputConfig field's value.

func (*CreateAdapterVersionInput) SetTags ¶

func (s *CreateAdapterVersionInput) SetTags(v map[string]*string) *CreateAdapterVersionInput

SetTags sets the Tags field's value.

func (CreateAdapterVersionInput) String ¶

func (s CreateAdapterVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAdapterVersionInput) Validate ¶

func (s *CreateAdapterVersionInput) Validate() error

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

type CreateAdapterVersionOutput ¶

type CreateAdapterVersionOutput struct {

    // A string containing the unique ID for the adapter that has received a new
    // version.
    AdapterId *string `min:"12" type:"string"`

    // A string describing the new version of the adapter.
    AdapterVersion *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (CreateAdapterVersionOutput) GoString ¶

func (s CreateAdapterVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAdapterVersionOutput) SetAdapterId ¶

func (s *CreateAdapterVersionOutput) SetAdapterId(v string) *CreateAdapterVersionOutput

SetAdapterId sets the AdapterId field's value.

func (*CreateAdapterVersionOutput) SetAdapterVersion ¶

func (s *CreateAdapterVersionOutput) SetAdapterVersion(v string) *CreateAdapterVersionOutput

SetAdapterVersion sets the AdapterVersion field's value.

func (CreateAdapterVersionOutput) String ¶

func (s CreateAdapterVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAdapterInput ¶

type DeleteAdapterInput struct {

    // A string containing a unique ID for the adapter to be deleted.
    //
    // AdapterId is a required field
    AdapterId *string `min:"12" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAdapterInput) GoString ¶

func (s DeleteAdapterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdapterInput) SetAdapterId ¶

func (s *DeleteAdapterInput) SetAdapterId(v string) *DeleteAdapterInput

SetAdapterId sets the AdapterId field's value.

func (DeleteAdapterInput) String ¶

func (s DeleteAdapterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdapterInput) Validate ¶

func (s *DeleteAdapterInput) Validate() error

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

type DeleteAdapterOutput ¶

type DeleteAdapterOutput struct {
    // contains filtered or unexported fields
}

func (DeleteAdapterOutput) GoString ¶

func (s DeleteAdapterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAdapterOutput) String ¶

func (s DeleteAdapterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAdapterVersionInput ¶

type DeleteAdapterVersionInput struct {

    // A string containing a unique ID for the adapter version that will be deleted.
    //
    // AdapterId is a required field
    AdapterId *string `min:"12" type:"string" required:"true"`

    // Specifies the adapter version to be deleted.
    //
    // AdapterVersion is a required field
    AdapterVersion *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAdapterVersionInput) GoString ¶

func (s DeleteAdapterVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdapterVersionInput) SetAdapterId ¶

func (s *DeleteAdapterVersionInput) SetAdapterId(v string) *DeleteAdapterVersionInput

SetAdapterId sets the AdapterId field's value.

func (*DeleteAdapterVersionInput) SetAdapterVersion ¶

func (s *DeleteAdapterVersionInput) SetAdapterVersion(v string) *DeleteAdapterVersionInput

SetAdapterVersion sets the AdapterVersion field's value.

func (DeleteAdapterVersionInput) String ¶

func (s DeleteAdapterVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdapterVersionInput) Validate ¶

func (s *DeleteAdapterVersionInput) Validate() error

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

type DeleteAdapterVersionOutput ¶

type DeleteAdapterVersionOutput struct {
    // contains filtered or unexported fields
}

func (DeleteAdapterVersionOutput) GoString ¶

func (s DeleteAdapterVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAdapterVersionOutput) String ¶

func (s DeleteAdapterVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectDocumentTextInput ¶

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 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.
    //
    // Document is a required field
    Document *Document `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DetectDocumentTextInput) GoString ¶

func (s DetectDocumentTextInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectDocumentTextInput) SetDocument ¶

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

SetDocument sets the Document field's value.

func (DetectDocumentTextInput) String ¶

func (s DetectDocumentTextInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectDocumentTextInput) Validate ¶

func (s *DetectDocumentTextInput) Validate() error

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

type DetectDocumentTextOutput ¶

type DetectDocumentTextOutput struct {

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

    DetectDocumentTextModelVersion *string `type:"string"`

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

func (DetectDocumentTextOutput) GoString ¶

func (s DetectDocumentTextOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectDocumentTextOutput) SetBlocks ¶

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

SetBlocks sets the Blocks field's value.

func (*DetectDocumentTextOutput) SetDetectDocumentTextModelVersion ¶

func (s *DetectDocumentTextOutput) SetDetectDocumentTextModelVersion(v string) *DetectDocumentTextOutput

SetDetectDocumentTextModelVersion sets the DetectDocumentTextModelVersion field's value.

func (*DetectDocumentTextOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (DetectDocumentTextOutput) String ¶

func (s DetectDocumentTextOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectedSignature ¶

type DetectedSignature struct {

    // The page a detected signature was found on.
    Page *int64 `type:"integer"`
    // contains filtered or unexported fields
}

A structure that holds information regarding a detected signature on a page.

func (DetectedSignature) GoString ¶

func (s DetectedSignature) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectedSignature) SetPage ¶

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

SetPage sets the Page field's value.

func (DetectedSignature) String ¶

func (s DetectedSignature) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Document ¶

type Document struct {

    // 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.
    // 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
    // that's 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 ¶

func (s Document) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) SetBytes ¶

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

SetBytes sets the Bytes field's value.

func (*Document) SetS3Object ¶

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

SetS3Object sets the S3Object field's value.

func (Document) String ¶

func (s Document) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) Validate ¶

func (s *Document) Validate() error

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

type DocumentGroup ¶

type DocumentGroup struct {

    // A list of the detected signatures found in a document group.
    DetectedSignatures []*DetectedSignature `type:"list"`

    // An array that contains information about the pages of a document, defined
    // by logical boundary.
    SplitDocuments []*SplitDocument `type:"list"`

    // The type of document that Amazon Textract has detected. See Analyze Lending
    // Response Objects (https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html)
    // for a list of all types returned by Textract.
    Type *string `type:"string"`

    // A list of any expected signatures not found in a document group.
    UndetectedSignatures []*UndetectedSignature `type:"list"`
    // contains filtered or unexported fields
}

Summary information about documents grouped by the same document type.

func (DocumentGroup) GoString ¶

func (s DocumentGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentGroup) SetDetectedSignatures ¶

func (s *DocumentGroup) SetDetectedSignatures(v []*DetectedSignature) *DocumentGroup

SetDetectedSignatures sets the DetectedSignatures field's value.

func (*DocumentGroup) SetSplitDocuments ¶

func (s *DocumentGroup) SetSplitDocuments(v []*SplitDocument) *DocumentGroup

SetSplitDocuments sets the SplitDocuments field's value.

func (*DocumentGroup) SetType ¶

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

SetType sets the Type field's value.

func (*DocumentGroup) SetUndetectedSignatures ¶

func (s *DocumentGroup) SetUndetectedSignatures(v []*UndetectedSignature) *DocumentGroup

SetUndetectedSignatures sets the UndetectedSignatures field's value.

func (DocumentGroup) String ¶

func (s DocumentGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentLocation ¶

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.

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

func (DocumentLocation) GoString ¶

func (s DocumentLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentLocation) SetS3Object ¶

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

SetS3Object sets the S3Object field's value.

func (DocumentLocation) String ¶

func (s DocumentLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentLocation) Validate ¶

func (s *DocumentLocation) Validate() error

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

type DocumentMetadata ¶

type DocumentMetadata struct {

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

Information about the input document.

func (DocumentMetadata) GoString ¶

func (s DocumentMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentMetadata) SetPages ¶

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

SetPages sets the Pages field's value.

func (DocumentMetadata) String ¶

func (s DocumentMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentTooLargeException ¶

type DocumentTooLargeException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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.

func (*DocumentTooLargeException) Code ¶

func (s *DocumentTooLargeException) Code() string

Code returns the exception type name.

func (*DocumentTooLargeException) Error ¶

func (s *DocumentTooLargeException) Error() string

func (DocumentTooLargeException) GoString ¶

func (s DocumentTooLargeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentTooLargeException) Message ¶

func (s *DocumentTooLargeException) Message() string

Message returns the exception's message.

func (*DocumentTooLargeException) OrigErr ¶

func (s *DocumentTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DocumentTooLargeException) RequestID ¶

func (s *DocumentTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DocumentTooLargeException) StatusCode ¶

func (s *DocumentTooLargeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DocumentTooLargeException) String ¶

func (s DocumentTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EvaluationMetric ¶

type EvaluationMetric struct {

    // The F1 score for an adapter version.
    F1Score *float64 `type:"float"`

    // The Precision score for an adapter version.
    Precision *float64 `type:"float"`

    // The Recall score for an adapter version.
    Recall *float64 `type:"float"`
    // contains filtered or unexported fields
}

The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.

func (EvaluationMetric) GoString ¶

func (s EvaluationMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EvaluationMetric) SetF1Score ¶

func (s *EvaluationMetric) SetF1Score(v float64) *EvaluationMetric

SetF1Score sets the F1Score field's value.

func (*EvaluationMetric) SetPrecision ¶

func (s *EvaluationMetric) SetPrecision(v float64) *EvaluationMetric

SetPrecision sets the Precision field's value.

func (*EvaluationMetric) SetRecall ¶

func (s *EvaluationMetric) SetRecall(v float64) *EvaluationMetric

SetRecall sets the Recall field's value.

func (EvaluationMetric) String ¶

func (s EvaluationMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpenseCurrency ¶

type ExpenseCurrency struct {

    // Currency code for detected currency. the current supported codes are:
    //
    //    * USD
    //
    //    * EUR
    //
    //    * GBP
    //
    //    * CAD
    //
    //    * INR
    //
    //    * JPY
    //
    //    * CHF
    //
    //    * AUD
    //
    //    * CNY
    //
    //    * BZR
    //
    //    * SEK
    //
    //    * HKD
    Code *string `type:"string"`

    // Percentage confideence in the detected currency.
    Confidence *float64 `type:"float"`
    // contains filtered or unexported fields
}

Returns the kind of currency detected.

func (ExpenseCurrency) GoString ¶

func (s ExpenseCurrency) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpenseCurrency) SetCode ¶

func (s *ExpenseCurrency) SetCode(v string) *ExpenseCurrency

SetCode sets the Code field's value.

func (*ExpenseCurrency) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (ExpenseCurrency) String ¶

func (s ExpenseCurrency) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpenseDetection ¶

type ExpenseDetection struct {

    // The confidence in detection, as a percentage
    Confidence *float64 `type:"float"`

    // Information about where the following items are located on a document page:
    // detected page, text, key-value pairs, tables, table cells, and selection
    // elements.
    Geometry *Geometry `type:"structure"`

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

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

func (ExpenseDetection) GoString ¶

func (s ExpenseDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpenseDetection) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*ExpenseDetection) SetGeometry ¶

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

SetGeometry sets the Geometry field's value.

func (*ExpenseDetection) SetText ¶

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

SetText sets the Text field's value.

func (ExpenseDetection) String ¶

func (s ExpenseDetection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpenseDocument ¶

type ExpenseDocument struct {

    // This is a block object, the same as reported when DetectDocumentText is run
    // on a document. It provides word level recognition of text.
    Blocks []*Block `type:"list"`

    // Denotes which invoice or receipt in the document the information is coming
    // from. First document will be 1, the second 2, and so on.
    ExpenseIndex *int64 `type:"integer"`

    // Information detected on each table of a document, seperated into LineItems.
    LineItemGroups []*LineItemGroup `type:"list"`

    // Any information found outside of a table by Amazon Textract.
    SummaryFields []*ExpenseField `type:"list"`
    // contains filtered or unexported fields
}

The structure holding all the information returned by AnalyzeExpense

func (ExpenseDocument) GoString ¶

func (s ExpenseDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpenseDocument) SetBlocks ¶

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

SetBlocks sets the Blocks field's value.

func (*ExpenseDocument) SetExpenseIndex ¶

func (s *ExpenseDocument) SetExpenseIndex(v int64) *ExpenseDocument

SetExpenseIndex sets the ExpenseIndex field's value.

func (*ExpenseDocument) SetLineItemGroups ¶

func (s *ExpenseDocument) SetLineItemGroups(v []*LineItemGroup) *ExpenseDocument

SetLineItemGroups sets the LineItemGroups field's value.

func (*ExpenseDocument) SetSummaryFields ¶

func (s *ExpenseDocument) SetSummaryFields(v []*ExpenseField) *ExpenseDocument

SetSummaryFields sets the SummaryFields field's value.

func (ExpenseDocument) String ¶

func (s ExpenseDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpenseField ¶

type ExpenseField struct {

    // Shows the kind of currency, both the code and confidence associated with
    // any monatary value detected.
    Currency *ExpenseCurrency `type:"structure"`

    // Shows which group a response object belongs to, such as whether an address
    // line belongs to the vendor's address or the recipent's address.
    GroupProperties []*ExpenseGroupProperty `type:"list"`

    // The explicitly stated label of a detected element.
    LabelDetection *ExpenseDetection `type:"structure"`

    // The page number the value was detected on.
    PageNumber *int64 `type:"integer"`

    // The implied label of a detected element. Present alongside LabelDetection
    // for explicit elements.
    Type *ExpenseType `type:"structure"`

    // The value of a detected element. Present in explicit and implicit elements.
    ValueDetection *ExpenseDetection `type:"structure"`
    // contains filtered or unexported fields
}

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

func (ExpenseField) GoString ¶

func (s ExpenseField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpenseField) SetCurrency ¶

func (s *ExpenseField) SetCurrency(v *ExpenseCurrency) *ExpenseField

SetCurrency sets the Currency field's value.

func (*ExpenseField) SetGroupProperties ¶

func (s *ExpenseField) SetGroupProperties(v []*ExpenseGroupProperty) *ExpenseField

SetGroupProperties sets the GroupProperties field's value.

func (*ExpenseField) SetLabelDetection ¶

func (s *ExpenseField) SetLabelDetection(v *ExpenseDetection) *ExpenseField

SetLabelDetection sets the LabelDetection field's value.

func (*ExpenseField) SetPageNumber ¶

func (s *ExpenseField) SetPageNumber(v int64) *ExpenseField

SetPageNumber sets the PageNumber field's value.

func (*ExpenseField) SetType ¶

func (s *ExpenseField) SetType(v *ExpenseType) *ExpenseField

SetType sets the Type field's value.

func (*ExpenseField) SetValueDetection ¶

func (s *ExpenseField) SetValueDetection(v *ExpenseDetection) *ExpenseField

SetValueDetection sets the ValueDetection field's value.

func (ExpenseField) String ¶

func (s ExpenseField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpenseGroupProperty ¶

type ExpenseGroupProperty struct {

    // Provides a group Id number, which will be the same for each in the group.
    Id *string `type:"string"`

    // Informs you on whether the expense group is a name or an address.
    Types []*string `type:"list"`
    // contains filtered or unexported fields
}

Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.

func (ExpenseGroupProperty) GoString ¶

func (s ExpenseGroupProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpenseGroupProperty) SetId ¶

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

SetId sets the Id field's value.

func (*ExpenseGroupProperty) SetTypes ¶

func (s *ExpenseGroupProperty) SetTypes(v []*string) *ExpenseGroupProperty

SetTypes sets the Types field's value.

func (ExpenseGroupProperty) String ¶

func (s ExpenseGroupProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpenseType ¶

type ExpenseType struct {

    // The confidence of accuracy, as a percentage.
    Confidence *float64 `type:"float"`

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

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

func (ExpenseType) GoString ¶

func (s ExpenseType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpenseType) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*ExpenseType) SetText ¶

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

SetText sets the Text field's value.

func (ExpenseType) String ¶

func (s ExpenseType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Extraction ¶

type Extraction struct {

    // The structure holding all the information returned by AnalyzeExpense
    ExpenseDocument *ExpenseDocument `type:"structure"`

    // The structure that lists each document processed in an AnalyzeID operation.
    IdentityDocument *IdentityDocument `type:"structure"`

    // Holds the structured data returned by AnalyzeDocument for lending documents.
    LendingDocument *LendingDocument `type:"structure"`
    // contains filtered or unexported fields
}

Contains information extracted by an analysis operation after using StartLendingAnalysis.

func (Extraction) GoString ¶

func (s Extraction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Extraction) SetExpenseDocument ¶

func (s *Extraction) SetExpenseDocument(v *ExpenseDocument) *Extraction

SetExpenseDocument sets the ExpenseDocument field's value.

func (*Extraction) SetIdentityDocument ¶

func (s *Extraction) SetIdentityDocument(v *IdentityDocument) *Extraction

SetIdentityDocument sets the IdentityDocument field's value.

func (*Extraction) SetLendingDocument ¶

func (s *Extraction) SetLendingDocument(v *LendingDocument) *Extraction

SetLendingDocument sets the LendingDocument field's value.

func (Extraction) String ¶

func (s Extraction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Geometry ¶

type Geometry struct {

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

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

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

func (Geometry) GoString ¶

func (s Geometry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Geometry) SetBoundingBox ¶

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

SetBoundingBox sets the BoundingBox field's value.

func (*Geometry) SetPolygon ¶

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

SetPolygon sets the Polygon field's value.

func (Geometry) String ¶

func (s Geometry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAdapterInput ¶

type GetAdapterInput struct {

    // A string containing a unique ID for the adapter.
    //
    // AdapterId is a required field
    AdapterId *string `min:"12" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetAdapterInput) GoString ¶

func (s GetAdapterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdapterInput) SetAdapterId ¶

func (s *GetAdapterInput) SetAdapterId(v string) *GetAdapterInput

SetAdapterId sets the AdapterId field's value.

func (GetAdapterInput) String ¶

func (s GetAdapterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdapterInput) Validate ¶

func (s *GetAdapterInput) Validate() error

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

type GetAdapterOutput ¶

type GetAdapterOutput struct {

    // A string identifying the adapter that information has been retrieved for.
    AdapterId *string `min:"12" type:"string"`

    // The name of the requested adapter.
    AdapterName *string `min:"1" type:"string"`

    // Binary value indicating if the adapter is being automatically updated or
    // not.
    AutoUpdate *string `type:"string" enum:"AutoUpdate"`

    // The date and time the requested adapter was created at.
    CreationTime *time.Time `type:"timestamp"`

    // The description for the requested adapter.
    Description *string `min:"1" type:"string"`

    // List of the targeted feature types for the requested adapter.
    FeatureTypes []*string `type:"list" enum:"FeatureType"`

    // A set of tags (key-value pairs) associated with the adapter that has been
    // retrieved.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (GetAdapterOutput) GoString ¶

func (s GetAdapterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdapterOutput) SetAdapterId ¶

func (s *GetAdapterOutput) SetAdapterId(v string) *GetAdapterOutput

SetAdapterId sets the AdapterId field's value.

func (*GetAdapterOutput) SetAdapterName ¶

func (s *GetAdapterOutput) SetAdapterName(v string) *GetAdapterOutput

SetAdapterName sets the AdapterName field's value.

func (*GetAdapterOutput) SetAutoUpdate ¶

func (s *GetAdapterOutput) SetAutoUpdate(v string) *GetAdapterOutput

SetAutoUpdate sets the AutoUpdate field's value.

func (*GetAdapterOutput) SetCreationTime ¶

func (s *GetAdapterOutput) SetCreationTime(v time.Time) *GetAdapterOutput

SetCreationTime sets the CreationTime field's value.

func (*GetAdapterOutput) SetDescription ¶

func (s *GetAdapterOutput) SetDescription(v string) *GetAdapterOutput

SetDescription sets the Description field's value.

func (*GetAdapterOutput) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (*GetAdapterOutput) SetTags ¶

func (s *GetAdapterOutput) SetTags(v map[string]*string) *GetAdapterOutput

SetTags sets the Tags field's value.

func (GetAdapterOutput) String ¶

func (s GetAdapterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAdapterVersionInput ¶

type GetAdapterVersionInput struct {

    // A string specifying a unique ID for the adapter version you want to retrieve
    // information for.
    //
    // AdapterId is a required field
    AdapterId *string `min:"12" type:"string" required:"true"`

    // A string specifying the adapter version you want to retrieve information
    // for.
    //
    // AdapterVersion is a required field
    AdapterVersion *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetAdapterVersionInput) GoString ¶

func (s GetAdapterVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdapterVersionInput) SetAdapterId ¶

func (s *GetAdapterVersionInput) SetAdapterId(v string) *GetAdapterVersionInput

SetAdapterId sets the AdapterId field's value.

func (*GetAdapterVersionInput) SetAdapterVersion ¶

func (s *GetAdapterVersionInput) SetAdapterVersion(v string) *GetAdapterVersionInput

SetAdapterVersion sets the AdapterVersion field's value.

func (GetAdapterVersionInput) String ¶

func (s GetAdapterVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdapterVersionInput) Validate ¶

func (s *GetAdapterVersionInput) Validate() error

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

type GetAdapterVersionOutput ¶

type GetAdapterVersionOutput struct {

    // A string containing a unique ID for the adapter version being retrieved.
    AdapterId *string `min:"12" type:"string"`

    // A string containing the adapter version that has been retrieved.
    AdapterVersion *string `min:"1" type:"string"`

    // The time that the adapter version was created.
    CreationTime *time.Time `type:"timestamp"`

    // Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec
    // as the value.
    DatasetConfig *AdapterVersionDatasetConfig `type:"structure"`

    // The evaluation metrics (F1 score, Precision, and Recall) for the requested
    // version, grouped by baseline metrics and adapter version.
    EvaluationMetrics []*AdapterVersionEvaluationMetric `type:"list"`

    // List of the targeted feature types for the requested adapter version.
    FeatureTypes []*string `type:"list" enum:"FeatureType"`

    // The identifier for your AWS Key Management Service key (AWS KMS key). Used
    // to encrypt your documents.
    KMSKeyId *string `min:"1" type:"string"`

    // 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 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. (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)
    //
    // For more information on data privacy, see the Data Privacy FAQ (https://aws.amazon.com/compliance/data-privacy-faq/).
    OutputConfig *OutputConfig `type:"structure"`

    // The status of the adapter version that has been requested.
    Status *string `type:"string" enum:"AdapterVersionStatus"`

    // A message that describes the status of the requested adapter version.
    StatusMessage *string `min:"1" type:"string"`

    // A set of tags (key-value pairs) that are associated with the adapter version.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (GetAdapterVersionOutput) GoString ¶

func (s GetAdapterVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdapterVersionOutput) SetAdapterId ¶

func (s *GetAdapterVersionOutput) SetAdapterId(v string) *GetAdapterVersionOutput

SetAdapterId sets the AdapterId field's value.

func (*GetAdapterVersionOutput) SetAdapterVersion ¶

func (s *GetAdapterVersionOutput) SetAdapterVersion(v string) *GetAdapterVersionOutput

SetAdapterVersion sets the AdapterVersion field's value.

func (*GetAdapterVersionOutput) SetCreationTime ¶

func (s *GetAdapterVersionOutput) SetCreationTime(v time.Time) *GetAdapterVersionOutput

SetCreationTime sets the CreationTime field's value.

func (*GetAdapterVersionOutput) SetDatasetConfig ¶

func (s *GetAdapterVersionOutput) SetDatasetConfig(v *AdapterVersionDatasetConfig) *GetAdapterVersionOutput

SetDatasetConfig sets the DatasetConfig field's value.

func (*GetAdapterVersionOutput) SetEvaluationMetrics ¶

func (s *GetAdapterVersionOutput) SetEvaluationMetrics(v []*AdapterVersionEvaluationMetric) *GetAdapterVersionOutput

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*GetAdapterVersionOutput) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (*GetAdapterVersionOutput) SetKMSKeyId ¶

func (s *GetAdapterVersionOutput) SetKMSKeyId(v string) *GetAdapterVersionOutput

SetKMSKeyId sets the KMSKeyId field's value.

func (*GetAdapterVersionOutput) SetOutputConfig ¶

func (s *GetAdapterVersionOutput) SetOutputConfig(v *OutputConfig) *GetAdapterVersionOutput

SetOutputConfig sets the OutputConfig field's value.

func (*GetAdapterVersionOutput) SetStatus ¶

func (s *GetAdapterVersionOutput) SetStatus(v string) *GetAdapterVersionOutput

SetStatus sets the Status field's value.

func (*GetAdapterVersionOutput) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetAdapterVersionOutput) SetTags ¶

func (s *GetAdapterVersionOutput) SetTags(v map[string]*string) *GetAdapterVersionOutput

SetTags sets the Tags field's value.

func (GetAdapterVersionOutput) String ¶

func (s GetAdapterVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDocumentAnalysisInput ¶

type GetDocumentAnalysisInput struct {

    // A unique identifier for the text-detection job. The JobId is returned from
    // StartDocumentAnalysis. A JobId value is only valid for 7 days.
    //
    // 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 ¶

func (s GetDocumentAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentAnalysisInput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (*GetDocumentAnalysisInput) SetMaxResults ¶

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

SetMaxResults sets the MaxResults field's value.

func (*GetDocumentAnalysisInput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (GetDocumentAnalysisInput) String ¶

func (s GetDocumentAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentAnalysisInput) Validate ¶

func (s *GetDocumentAnalysisInput) Validate() error

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

type GetDocumentAnalysisOutput ¶

type GetDocumentAnalysisOutput struct {
    AnalyzeDocumentModelVersion *string `type:"string"`

    // 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"`

    // Returns if the detection job could not be completed. Contains explanation
    // for what error occured.
    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 ¶

func (s GetDocumentAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentAnalysisOutput) SetAnalyzeDocumentModelVersion ¶

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

SetAnalyzeDocumentModelVersion sets the AnalyzeDocumentModelVersion field's value.

func (*GetDocumentAnalysisOutput) SetBlocks ¶

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

SetBlocks sets the Blocks field's value.

func (*GetDocumentAnalysisOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetDocumentAnalysisOutput) SetJobStatus ¶

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

SetJobStatus sets the JobStatus field's value.

func (*GetDocumentAnalysisOutput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (*GetDocumentAnalysisOutput) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetDocumentAnalysisOutput) SetWarnings ¶

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

SetWarnings sets the Warnings field's value.

func (GetDocumentAnalysisOutput) String ¶

func (s GetDocumentAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDocumentTextDetectionInput ¶

type GetDocumentTextDetectionInput struct {

    // A unique identifier for the text detection job. The JobId is returned from
    // StartDocumentTextDetection. A JobId value is only valid for 7 days.
    //
    // 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 ¶

func (s GetDocumentTextDetectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentTextDetectionInput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (*GetDocumentTextDetectionInput) SetMaxResults ¶

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

SetMaxResults sets the MaxResults field's value.

func (*GetDocumentTextDetectionInput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (GetDocumentTextDetectionInput) String ¶

func (s GetDocumentTextDetectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentTextDetectionInput) Validate ¶

func (s *GetDocumentTextDetectionInput) Validate() error

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

type GetDocumentTextDetectionOutput ¶

type GetDocumentTextDetectionOutput struct {

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

    DetectDocumentTextModelVersion *string `type:"string"`

    // 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"`

    // Returns if the detection job could not be completed. Contains explanation
    // for what error occured.
    StatusMessage *string `type:"string"`

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

func (GetDocumentTextDetectionOutput) GoString ¶

func (s GetDocumentTextDetectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentTextDetectionOutput) SetBlocks ¶

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

SetBlocks sets the Blocks field's value.

func (*GetDocumentTextDetectionOutput) SetDetectDocumentTextModelVersion ¶

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

SetDetectDocumentTextModelVersion sets the DetectDocumentTextModelVersion field's value.

func (*GetDocumentTextDetectionOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetDocumentTextDetectionOutput) SetJobStatus ¶

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

SetJobStatus sets the JobStatus field's value.

func (*GetDocumentTextDetectionOutput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (*GetDocumentTextDetectionOutput) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetDocumentTextDetectionOutput) SetWarnings ¶

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

SetWarnings sets the Warnings field's value.

func (GetDocumentTextDetectionOutput) String ¶

func (s GetDocumentTextDetectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetExpenseAnalysisInput ¶

type GetExpenseAnalysisInput struct {

    // A unique identifier for the text detection job. The JobId is returned from
    // StartExpenseAnalysis. A JobId value is only valid for 7 days.
    //
    // 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 20. If you specify a value greater than 20, a maximum
    // of 20 results is returned. The default value is 20.
    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 (GetExpenseAnalysisInput) GoString ¶

func (s GetExpenseAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExpenseAnalysisInput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (*GetExpenseAnalysisInput) SetMaxResults ¶

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

SetMaxResults sets the MaxResults field's value.

func (*GetExpenseAnalysisInput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (GetExpenseAnalysisInput) String ¶

func (s GetExpenseAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExpenseAnalysisInput) Validate ¶

func (s *GetExpenseAnalysisInput) Validate() error

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

type GetExpenseAnalysisOutput ¶

type GetExpenseAnalysisOutput struct {

    // The current model version of AnalyzeExpense.
    AnalyzeExpenseModelVersion *string `type:"string"`

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

    // The expenses detected by Amazon Textract.
    ExpenseDocuments []*ExpenseDocument `type:"list"`

    // 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"`

    // Returns if the detection job could not be completed. Contains explanation
    // for what error occured.
    StatusMessage *string `type:"string"`

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

func (GetExpenseAnalysisOutput) GoString ¶

func (s GetExpenseAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExpenseAnalysisOutput) SetAnalyzeExpenseModelVersion ¶

func (s *GetExpenseAnalysisOutput) SetAnalyzeExpenseModelVersion(v string) *GetExpenseAnalysisOutput

SetAnalyzeExpenseModelVersion sets the AnalyzeExpenseModelVersion field's value.

func (*GetExpenseAnalysisOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetExpenseAnalysisOutput) SetExpenseDocuments ¶

func (s *GetExpenseAnalysisOutput) SetExpenseDocuments(v []*ExpenseDocument) *GetExpenseAnalysisOutput

SetExpenseDocuments sets the ExpenseDocuments field's value.

func (*GetExpenseAnalysisOutput) SetJobStatus ¶

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

SetJobStatus sets the JobStatus field's value.

func (*GetExpenseAnalysisOutput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (*GetExpenseAnalysisOutput) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetExpenseAnalysisOutput) SetWarnings ¶

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

SetWarnings sets the Warnings field's value.

func (GetExpenseAnalysisOutput) String ¶

func (s GetExpenseAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLendingAnalysisInput ¶

type GetLendingAnalysisInput struct {

    // A unique identifier for the lending or text-detection job. The JobId is returned
    // from StartLendingAnalysis. A JobId value is only valid for 7 days.
    //
    // 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 30. If you specify a value greater than 30, a maximum
    // of 30 results is returned. The default value is 30.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete, Amazon Textract returns a pagination
    // token in the response. You can use this pagination token to retrieve the
    // next set of lending results.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetLendingAnalysisInput) GoString ¶

func (s GetLendingAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLendingAnalysisInput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (*GetLendingAnalysisInput) SetMaxResults ¶

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

SetMaxResults sets the MaxResults field's value.

func (*GetLendingAnalysisInput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (GetLendingAnalysisInput) String ¶

func (s GetLendingAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLendingAnalysisInput) Validate ¶

func (s *GetLendingAnalysisInput) Validate() error

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

type GetLendingAnalysisOutput ¶

type GetLendingAnalysisOutput struct {

    // The current model version of the Analyze Lending API.
    AnalyzeLendingModelVersion *string `type:"string"`

    // Information about the input document.
    DocumentMetadata *DocumentMetadata `type:"structure"`

    // The current status of the lending analysis 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 lending
    // results.
    NextToken *string `min:"1" type:"string"`

    // Holds the information returned by one of AmazonTextract's document analysis
    // operations for the pinstripe.
    Results []*LendingResult `type:"list"`

    // Returns if the lending analysis job could not be completed. Contains explanation
    // for what error occurred.
    StatusMessage *string `type:"string"`

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

func (GetLendingAnalysisOutput) GoString ¶

func (s GetLendingAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLendingAnalysisOutput) SetAnalyzeLendingModelVersion ¶

func (s *GetLendingAnalysisOutput) SetAnalyzeLendingModelVersion(v string) *GetLendingAnalysisOutput

SetAnalyzeLendingModelVersion sets the AnalyzeLendingModelVersion field's value.

func (*GetLendingAnalysisOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetLendingAnalysisOutput) SetJobStatus ¶

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

SetJobStatus sets the JobStatus field's value.

func (*GetLendingAnalysisOutput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (*GetLendingAnalysisOutput) SetResults ¶

func (s *GetLendingAnalysisOutput) SetResults(v []*LendingResult) *GetLendingAnalysisOutput

SetResults sets the Results field's value.

func (*GetLendingAnalysisOutput) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetLendingAnalysisOutput) SetWarnings ¶

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

SetWarnings sets the Warnings field's value.

func (GetLendingAnalysisOutput) String ¶

func (s GetLendingAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLendingAnalysisSummaryInput ¶

type GetLendingAnalysisSummaryInput struct {

    // A unique identifier for the lending or text-detection job. The JobId is returned
    // from StartLendingAnalysis. A JobId value is only valid for 7 days.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetLendingAnalysisSummaryInput) GoString ¶

func (s GetLendingAnalysisSummaryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLendingAnalysisSummaryInput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (GetLendingAnalysisSummaryInput) String ¶

func (s GetLendingAnalysisSummaryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLendingAnalysisSummaryInput) Validate ¶

func (s *GetLendingAnalysisSummaryInput) Validate() error

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

type GetLendingAnalysisSummaryOutput ¶

type GetLendingAnalysisSummaryOutput struct {

    // The current model version of the Analyze Lending API.
    AnalyzeLendingModelVersion *string `type:"string"`

    // Information about the input document.
    DocumentMetadata *DocumentMetadata `type:"structure"`

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

    // Returns if the lending analysis could not be completed. Contains explanation
    // for what error occurred.
    StatusMessage *string `type:"string"`

    // Contains summary information for documents grouped by type.
    Summary *LendingSummary `type:"structure"`

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

func (GetLendingAnalysisSummaryOutput) GoString ¶

func (s GetLendingAnalysisSummaryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLendingAnalysisSummaryOutput) SetAnalyzeLendingModelVersion ¶

func (s *GetLendingAnalysisSummaryOutput) SetAnalyzeLendingModelVersion(v string) *GetLendingAnalysisSummaryOutput

SetAnalyzeLendingModelVersion sets the AnalyzeLendingModelVersion field's value.

func (*GetLendingAnalysisSummaryOutput) SetDocumentMetadata ¶

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*GetLendingAnalysisSummaryOutput) SetJobStatus ¶

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

SetJobStatus sets the JobStatus field's value.

func (*GetLendingAnalysisSummaryOutput) SetStatusMessage ¶

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetLendingAnalysisSummaryOutput) SetSummary ¶

func (s *GetLendingAnalysisSummaryOutput) SetSummary(v *LendingSummary) *GetLendingAnalysisSummaryOutput

SetSummary sets the Summary field's value.

func (*GetLendingAnalysisSummaryOutput) SetWarnings ¶

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

SetWarnings sets the Warnings field's value.

func (GetLendingAnalysisSummaryOutput) String ¶

func (s GetLendingAnalysisSummaryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HumanLoopActivationOutput ¶

type HumanLoopActivationOutput struct {

    // Shows the result of condition evaluations, including those conditions which
    // activated a human review.
    HumanLoopActivationConditionsEvaluationResults aws.JSONValue `type:"jsonvalue"`

    // Shows if and why human review was needed.
    HumanLoopActivationReasons []*string `min:"1" type:"list"`

    // The Amazon Resource Name (ARN) of the HumanLoop created.
    HumanLoopArn *string `type:"string"`
    // contains filtered or unexported fields
}

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

func (HumanLoopActivationOutput) GoString ¶

func (s HumanLoopActivationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopActivationOutput) SetHumanLoopActivationConditionsEvaluationResults ¶

func (s *HumanLoopActivationOutput) SetHumanLoopActivationConditionsEvaluationResults(v aws.JSONValue) *HumanLoopActivationOutput

SetHumanLoopActivationConditionsEvaluationResults sets the HumanLoopActivationConditionsEvaluationResults field's value.

func (*HumanLoopActivationOutput) SetHumanLoopActivationReasons ¶

func (s *HumanLoopActivationOutput) SetHumanLoopActivationReasons(v []*string) *HumanLoopActivationOutput

SetHumanLoopActivationReasons sets the HumanLoopActivationReasons field's value.

func (*HumanLoopActivationOutput) SetHumanLoopArn ¶

func (s *HumanLoopActivationOutput) SetHumanLoopArn(v string) *HumanLoopActivationOutput

SetHumanLoopArn sets the HumanLoopArn field's value.

func (HumanLoopActivationOutput) String ¶

func (s HumanLoopActivationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HumanLoopConfig ¶

type HumanLoopConfig struct {

    // Sets attributes of the input data.
    DataAttributes *HumanLoopDataAttributes `type:"structure"`

    // The Amazon Resource Name (ARN) of the flow definition.
    //
    // FlowDefinitionArn is a required field
    FlowDefinitionArn *string `type:"string" required:"true"`

    // The name of the human workflow used for this image. This should be kept unique
    // within a region.
    //
    // HumanLoopName is a required field
    HumanLoopName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

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.

func (HumanLoopConfig) GoString ¶

func (s HumanLoopConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopConfig) SetDataAttributes ¶

func (s *HumanLoopConfig) SetDataAttributes(v *HumanLoopDataAttributes) *HumanLoopConfig

SetDataAttributes sets the DataAttributes field's value.

func (*HumanLoopConfig) SetFlowDefinitionArn ¶

func (s *HumanLoopConfig) SetFlowDefinitionArn(v string) *HumanLoopConfig

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*HumanLoopConfig) SetHumanLoopName ¶

func (s *HumanLoopConfig) SetHumanLoopName(v string) *HumanLoopConfig

SetHumanLoopName sets the HumanLoopName field's value.

func (HumanLoopConfig) String ¶

func (s HumanLoopConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopConfig) Validate ¶

func (s *HumanLoopConfig) Validate() error

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

type HumanLoopDataAttributes ¶

type HumanLoopDataAttributes struct {

    // Sets whether the input image is free of personally identifiable information
    // or adult content.
    ContentClassifiers []*string `type:"list" enum:"ContentClassifier"`
    // contains filtered or unexported fields
}

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

func (HumanLoopDataAttributes) GoString ¶

func (s HumanLoopDataAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopDataAttributes) SetContentClassifiers ¶

func (s *HumanLoopDataAttributes) SetContentClassifiers(v []*string) *HumanLoopDataAttributes

SetContentClassifiers sets the ContentClassifiers field's value.

func (HumanLoopDataAttributes) String ¶

func (s HumanLoopDataAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HumanLoopQuotaExceededException ¶

type HumanLoopQuotaExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`

    // The quota code.
    QuotaCode *string `type:"string"`

    // The resource type.
    ResourceType *string `type:"string"`

    // The service code.
    ServiceCode *string `type:"string"`
    // contains filtered or unexported fields
}

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

func (*HumanLoopQuotaExceededException) Code ¶

func (s *HumanLoopQuotaExceededException) Code() string

Code returns the exception type name.

func (*HumanLoopQuotaExceededException) Error ¶

func (s *HumanLoopQuotaExceededException) Error() string

func (HumanLoopQuotaExceededException) GoString ¶

func (s HumanLoopQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopQuotaExceededException) Message ¶

func (s *HumanLoopQuotaExceededException) Message() string

Message returns the exception's message.

func (*HumanLoopQuotaExceededException) OrigErr ¶

func (s *HumanLoopQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*HumanLoopQuotaExceededException) RequestID ¶

func (s *HumanLoopQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*HumanLoopQuotaExceededException) StatusCode ¶

func (s *HumanLoopQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (HumanLoopQuotaExceededException) String ¶

func (s HumanLoopQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdempotentParameterMismatchException ¶

type IdempotentParameterMismatchException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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.

func (*IdempotentParameterMismatchException) Code ¶

func (s *IdempotentParameterMismatchException) Code() string

Code returns the exception type name.

func (*IdempotentParameterMismatchException) Error ¶

func (s *IdempotentParameterMismatchException) Error() string

func (IdempotentParameterMismatchException) GoString ¶

func (s IdempotentParameterMismatchException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdempotentParameterMismatchException) Message ¶

func (s *IdempotentParameterMismatchException) Message() string

Message returns the exception's message.

func (*IdempotentParameterMismatchException) OrigErr ¶

func (s *IdempotentParameterMismatchException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IdempotentParameterMismatchException) RequestID ¶

func (s *IdempotentParameterMismatchException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IdempotentParameterMismatchException) StatusCode ¶

func (s *IdempotentParameterMismatchException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IdempotentParameterMismatchException) String ¶

func (s IdempotentParameterMismatchException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdentityDocument ¶

type IdentityDocument struct {

    // Individual word recognition, as returned by document detection.
    Blocks []*Block `type:"list"`

    // Denotes the placement of a document in the IdentityDocument list. The first
    // document is marked 1, the second 2 and so on.
    DocumentIndex *int64 `type:"integer"`

    // The structure used to record information extracted from identity documents.
    // Contains both normalized field and value of the extracted text.
    IdentityDocumentFields []*IdentityDocumentField `type:"list"`
    // contains filtered or unexported fields
}

The structure that lists each document processed in an AnalyzeID operation.

func (IdentityDocument) GoString ¶

func (s IdentityDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityDocument) SetBlocks ¶

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

SetBlocks sets the Blocks field's value.

func (*IdentityDocument) SetDocumentIndex ¶

func (s *IdentityDocument) SetDocumentIndex(v int64) *IdentityDocument

SetDocumentIndex sets the DocumentIndex field's value.

func (*IdentityDocument) SetIdentityDocumentFields ¶

func (s *IdentityDocument) SetIdentityDocumentFields(v []*IdentityDocumentField) *IdentityDocument

SetIdentityDocumentFields sets the IdentityDocumentFields field's value.

func (IdentityDocument) String ¶

func (s IdentityDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdentityDocumentField ¶

type IdentityDocumentField struct {

    // Used to contain the information detected by an AnalyzeID operation.
    Type *AnalyzeIDDetections `type:"structure"`

    // Used to contain the information detected by an AnalyzeID operation.
    ValueDetection *AnalyzeIDDetections `type:"structure"`
    // contains filtered or unexported fields
}

Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.

func (IdentityDocumentField) GoString ¶

func (s IdentityDocumentField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityDocumentField) SetType ¶

func (s *IdentityDocumentField) SetType(v *AnalyzeIDDetections) *IdentityDocumentField

SetType sets the Type field's value.

func (*IdentityDocumentField) SetValueDetection ¶

func (s *IdentityDocumentField) SetValueDetection(v *AnalyzeIDDetections) *IdentityDocumentField

SetValueDetection sets the ValueDetection field's value.

func (IdentityDocumentField) String ¶

func (s IdentityDocumentField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError ¶

type InternalServerError struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*InternalServerError) Code ¶

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error ¶

func (s *InternalServerError) Error() string

func (InternalServerError) GoString ¶

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message ¶

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr ¶

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID ¶

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode ¶

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String ¶

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidJobIdException ¶

type InvalidJobIdException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*InvalidJobIdException) Code ¶

func (s *InvalidJobIdException) Code() string

Code returns the exception type name.

func (*InvalidJobIdException) Error ¶

func (s *InvalidJobIdException) Error() string

func (InvalidJobIdException) GoString ¶

func (s InvalidJobIdException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidJobIdException) Message ¶

func (s *InvalidJobIdException) Message() string

Message returns the exception's message.

func (*InvalidJobIdException) OrigErr ¶

func (s *InvalidJobIdException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidJobIdException) RequestID ¶

func (s *InvalidJobIdException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidJobIdException) StatusCode ¶

func (s *InvalidJobIdException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidJobIdException) String ¶

func (s InvalidJobIdException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidKMSKeyException ¶

type InvalidKMSKeyException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*InvalidKMSKeyException) Code ¶

func (s *InvalidKMSKeyException) Code() string

Code returns the exception type name.

func (*InvalidKMSKeyException) Error ¶

func (s *InvalidKMSKeyException) Error() string

func (InvalidKMSKeyException) GoString ¶

func (s InvalidKMSKeyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidKMSKeyException) Message ¶

func (s *InvalidKMSKeyException) Message() string

Message returns the exception's message.

func (*InvalidKMSKeyException) OrigErr ¶

func (s *InvalidKMSKeyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidKMSKeyException) RequestID ¶

func (s *InvalidKMSKeyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidKMSKeyException) StatusCode ¶

func (s *InvalidKMSKeyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidKMSKeyException) String ¶

func (s InvalidKMSKeyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException ¶

type InvalidParameterException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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.

func (*InvalidParameterException) Code ¶

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error ¶

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString ¶

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message ¶

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr ¶

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID ¶

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode ¶

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String ¶

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidS3ObjectException ¶

type InvalidS3ObjectException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

func (*InvalidS3ObjectException) Code ¶

func (s *InvalidS3ObjectException) Code() string

Code returns the exception type name.

func (*InvalidS3ObjectException) Error ¶

func (s *InvalidS3ObjectException) Error() string

func (InvalidS3ObjectException) GoString ¶

func (s InvalidS3ObjectException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidS3ObjectException) Message ¶

func (s *InvalidS3ObjectException) Message() string

Message returns the exception's message.

func (*InvalidS3ObjectException) OrigErr ¶

func (s *InvalidS3ObjectException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidS3ObjectException) RequestID ¶

func (s *InvalidS3ObjectException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidS3ObjectException) StatusCode ¶

func (s *InvalidS3ObjectException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidS3ObjectException) String ¶

func (s InvalidS3ObjectException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LendingDetection ¶

type LendingDetection struct {

    // The confidence level for the text of a detected value in a lending document.
    Confidence *float64 `type:"float"`

    // Information about where the following items are located on a document page:
    // detected page, text, key-value pairs, tables, table cells, and selection
    // elements.
    Geometry *Geometry `type:"structure"`

    // The selection status of a selection element, such as an option button or
    // check box.
    SelectionStatus *string `type:"string" enum:"SelectionStatus"`

    // The text extracted for a detected value in a lending document.
    Text *string `type:"string"`
    // contains filtered or unexported fields
}

The results extracted for a lending document.

func (LendingDetection) GoString ¶

func (s LendingDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LendingDetection) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*LendingDetection) SetGeometry ¶

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

SetGeometry sets the Geometry field's value.

func (*LendingDetection) SetSelectionStatus ¶

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

SetSelectionStatus sets the SelectionStatus field's value.

func (*LendingDetection) SetText ¶

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

SetText sets the Text field's value.

func (LendingDetection) String ¶

func (s LendingDetection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LendingDocument ¶

type LendingDocument struct {

    // An array of LendingField objects.
    LendingFields []*LendingField `type:"list"`

    // A list of signatures detected in a lending document.
    SignatureDetections []*SignatureDetection `type:"list"`
    // contains filtered or unexported fields
}

Holds the structured data returned by AnalyzeDocument for lending documents.

func (LendingDocument) GoString ¶

func (s LendingDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LendingDocument) SetLendingFields ¶

func (s *LendingDocument) SetLendingFields(v []*LendingField) *LendingDocument

SetLendingFields sets the LendingFields field's value.

func (*LendingDocument) SetSignatureDetections ¶

func (s *LendingDocument) SetSignatureDetections(v []*SignatureDetection) *LendingDocument

SetSignatureDetections sets the SignatureDetections field's value.

func (LendingDocument) String ¶

func (s LendingDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LendingField ¶

type LendingField struct {

    // The results extracted for a lending document.
    KeyDetection *LendingDetection `type:"structure"`

    // The type of the lending document.
    Type *string `type:"string"`

    // An array of LendingDetection objects.
    ValueDetections []*LendingDetection `type:"list"`
    // contains filtered or unexported fields
}

Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.

func (LendingField) GoString ¶

func (s LendingField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LendingField) SetKeyDetection ¶

func (s *LendingField) SetKeyDetection(v *LendingDetection) *LendingField

SetKeyDetection sets the KeyDetection field's value.

func (*LendingField) SetType ¶

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

SetType sets the Type field's value.

func (*LendingField) SetValueDetections ¶

func (s *LendingField) SetValueDetections(v []*LendingDetection) *LendingField

SetValueDetections sets the ValueDetections field's value.

func (LendingField) String ¶

func (s LendingField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LendingResult ¶

type LendingResult struct {

    // An array of Extraction to hold structured data. e.g. normalized key value
    // pairs instead of raw OCR detections .
    Extractions []*Extraction `type:"list"`

    // The page number for a page, with regard to whole submission.
    Page *int64 `type:"integer"`

    // The classifier result for a given page.
    PageClassification *PageClassification `type:"structure"`
    // contains filtered or unexported fields
}

Contains the detections for each page analyzed through the Analyze Lending API.

func (LendingResult) GoString ¶

func (s LendingResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LendingResult) SetExtractions ¶

func (s *LendingResult) SetExtractions(v []*Extraction) *LendingResult

SetExtractions sets the Extractions field's value.

func (*LendingResult) SetPage ¶

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

SetPage sets the Page field's value.

func (*LendingResult) SetPageClassification ¶

func (s *LendingResult) SetPageClassification(v *PageClassification) *LendingResult

SetPageClassification sets the PageClassification field's value.

func (LendingResult) String ¶

func (s LendingResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LendingSummary ¶

type LendingSummary struct {

    // Contains an array of all DocumentGroup objects.
    DocumentGroups []*DocumentGroup `type:"list"`

    // UndetectedDocumentTypes.
    UndetectedDocumentTypes []*string `type:"list"`
    // contains filtered or unexported fields
}

Contains information regarding DocumentGroups and UndetectedDocumentTypes.

func (LendingSummary) GoString ¶

func (s LendingSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LendingSummary) SetDocumentGroups ¶

func (s *LendingSummary) SetDocumentGroups(v []*DocumentGroup) *LendingSummary

SetDocumentGroups sets the DocumentGroups field's value.

func (*LendingSummary) SetUndetectedDocumentTypes ¶

func (s *LendingSummary) SetUndetectedDocumentTypes(v []*string) *LendingSummary

SetUndetectedDocumentTypes sets the UndetectedDocumentTypes field's value.

func (LendingSummary) String ¶

func (s LendingSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException ¶

type LimitExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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.

func (*LimitExceededException) Code ¶

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error ¶

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString ¶

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message ¶

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr ¶

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID ¶

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode ¶

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String ¶

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LineItemFields ¶

type LineItemFields struct {

    // ExpenseFields used to show information from detected lines on a table.
    LineItemExpenseFields []*ExpenseField `type:"list"`
    // contains filtered or unexported fields
}

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

func (LineItemFields) GoString ¶

func (s LineItemFields) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LineItemFields) SetLineItemExpenseFields ¶

func (s *LineItemFields) SetLineItemExpenseFields(v []*ExpenseField) *LineItemFields

SetLineItemExpenseFields sets the LineItemExpenseFields field's value.

func (LineItemFields) String ¶

func (s LineItemFields) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LineItemGroup ¶

type LineItemGroup struct {

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

    // The breakdown of information on a particular line of a table.
    LineItems []*LineItemFields `type:"list"`
    // contains filtered or unexported fields
}

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

func (LineItemGroup) GoString ¶

func (s LineItemGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LineItemGroup) SetLineItemGroupIndex ¶

func (s *LineItemGroup) SetLineItemGroupIndex(v int64) *LineItemGroup

SetLineItemGroupIndex sets the LineItemGroupIndex field's value.

func (*LineItemGroup) SetLineItems ¶

func (s *LineItemGroup) SetLineItems(v []*LineItemFields) *LineItemGroup

SetLineItems sets the LineItems field's value.

func (LineItemGroup) String ¶

func (s LineItemGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAdapterVersionsInput ¶

type ListAdapterVersionsInput struct {

    // A string containing a unique ID for the adapter to match for when listing
    // adapter versions.
    AdapterId *string `min:"12" type:"string"`

    // Specifies the lower bound for the ListAdapterVersions operation. Ensures
    // ListAdapterVersions returns only adapter versions created after the specified
    // creation time.
    AfterCreationTime *time.Time `type:"timestamp"`

    // Specifies the upper bound for the ListAdapterVersions operation. Ensures
    // ListAdapterVersions returns only adapter versions created after the specified
    // creation time.
    BeforeCreationTime *time.Time `type:"timestamp"`

    // The maximum number of results to return when listing adapter versions.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return when listing adapter versions.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAdapterVersionsInput) GoString ¶

func (s ListAdapterVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAdapterVersionsInput) SetAdapterId ¶

func (s *ListAdapterVersionsInput) SetAdapterId(v string) *ListAdapterVersionsInput

SetAdapterId sets the AdapterId field's value.

func (*ListAdapterVersionsInput) SetAfterCreationTime ¶

func (s *ListAdapterVersionsInput) SetAfterCreationTime(v time.Time) *ListAdapterVersionsInput

SetAfterCreationTime sets the AfterCreationTime field's value.

func (*ListAdapterVersionsInput) SetBeforeCreationTime ¶

func (s *ListAdapterVersionsInput) SetBeforeCreationTime(v time.Time) *ListAdapterVersionsInput

SetBeforeCreationTime sets the BeforeCreationTime field's value.

func (*ListAdapterVersionsInput) SetMaxResults ¶

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

SetMaxResults sets the MaxResults field's value.

func (*ListAdapterVersionsInput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (ListAdapterVersionsInput) String ¶

func (s ListAdapterVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAdapterVersionsInput) Validate ¶

func (s *ListAdapterVersionsInput) Validate() error

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

type ListAdapterVersionsOutput ¶

type ListAdapterVersionsOutput struct {

    // Adapter versions that match the filtering criteria specified when calling
    // ListAdapters.
    AdapterVersions []*AdapterVersionOverview `type:"list"`

    // Identifies the next page of results to return when listing adapter versions.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAdapterVersionsOutput) GoString ¶

func (s ListAdapterVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAdapterVersionsOutput) SetAdapterVersions ¶

func (s *ListAdapterVersionsOutput) SetAdapterVersions(v []*AdapterVersionOverview) *ListAdapterVersionsOutput

SetAdapterVersions sets the AdapterVersions field's value.

func (*ListAdapterVersionsOutput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (ListAdapterVersionsOutput) String ¶

func (s ListAdapterVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAdaptersInput ¶

type ListAdaptersInput struct {

    // Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters
    // returns only adapters created after the specified creation time.
    AfterCreationTime *time.Time `type:"timestamp"`

    // Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters
    // returns only adapters created before the specified creation time.
    BeforeCreationTime *time.Time `type:"timestamp"`

    // The maximum number of results to return when listing adapters.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return when listing adapters.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAdaptersInput) GoString ¶

func (s ListAdaptersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAdaptersInput) SetAfterCreationTime ¶

func (s *ListAdaptersInput) SetAfterCreationTime(v time.Time) *ListAdaptersInput

SetAfterCreationTime sets the AfterCreationTime field's value.

func (*ListAdaptersInput) SetBeforeCreationTime ¶

func (s *ListAdaptersInput) SetBeforeCreationTime(v time.Time) *ListAdaptersInput

SetBeforeCreationTime sets the BeforeCreationTime field's value.

func (*ListAdaptersInput) SetMaxResults ¶

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

SetMaxResults sets the MaxResults field's value.

func (*ListAdaptersInput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (ListAdaptersInput) String ¶

func (s ListAdaptersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAdaptersInput) Validate ¶

func (s *ListAdaptersInput) Validate() error

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

type ListAdaptersOutput ¶

type ListAdaptersOutput struct {

    // A list of adapters that matches the filtering criteria specified when calling
    // ListAdapters.
    Adapters []*AdapterOverview `type:"list"`

    // Identifies the next page of results to return when listing adapters.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAdaptersOutput) GoString ¶

func (s ListAdaptersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAdaptersOutput) SetAdapters ¶

func (s *ListAdaptersOutput) SetAdapters(v []*AdapterOverview) *ListAdaptersOutput

SetAdapters sets the Adapters field's value.

func (*ListAdaptersOutput) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (ListAdaptersOutput) String ¶

func (s ListAdaptersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput ¶

type ListTagsForResourceInput struct {

    // The Amazon Resource Name (ARN) that specifies the resource to list tags for.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString ¶

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN ¶

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String ¶

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate ¶

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput ¶

type ListTagsForResourceOutput struct {

    // A set of tags (key-value pairs) that are part of the requested resource.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString ¶

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags ¶

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String ¶

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NormalizedValue ¶

type NormalizedValue struct {

    // The value of the date, written as Year-Month-DayTHour:Minute:Second.
    Value *string `type:"string"`

    // The normalized type of the value detected. In this case, DATE.
    ValueType *string `type:"string" enum:"ValueType"`
    // contains filtered or unexported fields
}

Contains information relating to dates in a document, including the type of value, and the value.

func (NormalizedValue) GoString ¶

func (s NormalizedValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NormalizedValue) SetValue ¶

func (s *NormalizedValue) SetValue(v string) *NormalizedValue

SetValue sets the Value field's value.

func (*NormalizedValue) SetValueType ¶

func (s *NormalizedValue) SetValueType(v string) *NormalizedValue

SetValueType sets the ValueType field's value.

func (NormalizedValue) String ¶

func (s NormalizedValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotificationChannel ¶

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.

func (NotificationChannel) GoString ¶

func (s NotificationChannel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationChannel) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*NotificationChannel) SetSNSTopicArn ¶

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

SetSNSTopicArn sets the SNSTopicArn field's value.

func (NotificationChannel) String ¶

func (s NotificationChannel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationChannel) Validate ¶

func (s *NotificationChannel) Validate() error

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

type OutputConfig ¶

type OutputConfig struct {

    // The name of the bucket your output will go to.
    //
    // S3Bucket is a required field
    S3Bucket *string `min:"3" type:"string" required:"true"`

    // The prefix of the object key that the output will be saved to. When not enabled,
    // the prefix will be “textract_output".
    S3Prefix *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

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 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. (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)

For more information on data privacy, see the Data Privacy FAQ (https://aws.amazon.com/compliance/data-privacy-faq/).

func (OutputConfig) GoString ¶

func (s OutputConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputConfig) SetS3Bucket ¶

func (s *OutputConfig) SetS3Bucket(v string) *OutputConfig

SetS3Bucket sets the S3Bucket field's value.

func (*OutputConfig) SetS3Prefix ¶

func (s *OutputConfig) SetS3Prefix(v string) *OutputConfig

SetS3Prefix sets the S3Prefix field's value.

func (OutputConfig) String ¶

func (s OutputConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputConfig) Validate ¶

func (s *OutputConfig) Validate() error

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

type PageClassification ¶

type PageClassification struct {

    // The page number the value was detected on, relative to Amazon Textract's
    // starting position.
    //
    // PageNumber is a required field
    PageNumber []*Prediction `type:"list" required:"true"`

    // The class, or document type, assigned to a detected Page object. The class,
    // or document type, assigned to a detected Page object.
    //
    // PageType is a required field
    PageType []*Prediction `type:"list" required:"true"`
    // contains filtered or unexported fields
}

The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.

func (PageClassification) GoString ¶

func (s PageClassification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PageClassification) SetPageNumber ¶

func (s *PageClassification) SetPageNumber(v []*Prediction) *PageClassification

SetPageNumber sets the PageNumber field's value.

func (*PageClassification) SetPageType ¶

func (s *PageClassification) SetPageType(v []*Prediction) *PageClassification

SetPageType sets the PageType field's value.

func (PageClassification) String ¶

func (s PageClassification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Point ¶

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

func (Point) GoString ¶

func (s Point) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Point) SetX ¶

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

SetX sets the X field's value.

func (*Point) SetY ¶

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

SetY sets the Y field's value.

func (Point) String ¶

func (s Point) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Prediction ¶

type Prediction struct {

    // Amazon Textract's confidence in its predicted value.
    Confidence *float64 `type:"float"`

    // The predicted value of a detected object.
    Value *string `type:"string"`
    // contains filtered or unexported fields
}

Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.

func (Prediction) GoString ¶

func (s Prediction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Prediction) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*Prediction) SetValue ¶

func (s *Prediction) SetValue(v string) *Prediction

SetValue sets the Value field's value.

func (Prediction) String ¶

func (s Prediction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProvisionedThroughputExceededException ¶

type ProvisionedThroughputExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*ProvisionedThroughputExceededException) Code ¶

func (s *ProvisionedThroughputExceededException) Code() string

Code returns the exception type name.

func (*ProvisionedThroughputExceededException) Error ¶

func (s *ProvisionedThroughputExceededException) Error() string

func (ProvisionedThroughputExceededException) GoString ¶

func (s ProvisionedThroughputExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisionedThroughputExceededException) Message ¶

func (s *ProvisionedThroughputExceededException) Message() string

Message returns the exception's message.

func (*ProvisionedThroughputExceededException) OrigErr ¶

func (s *ProvisionedThroughputExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ProvisionedThroughputExceededException) RequestID ¶

func (s *ProvisionedThroughputExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ProvisionedThroughputExceededException) StatusCode ¶

func (s *ProvisionedThroughputExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ProvisionedThroughputExceededException) String ¶

func (s ProvisionedThroughputExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueriesConfig ¶

type QueriesConfig struct {

    // Queries is a required field
    Queries []*Query `min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (QueriesConfig) GoString ¶

func (s QueriesConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueriesConfig) SetQueries ¶

func (s *QueriesConfig) SetQueries(v []*Query) *QueriesConfig

SetQueries sets the Queries field's value.

func (QueriesConfig) String ¶

func (s QueriesConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueriesConfig) Validate ¶

func (s *QueriesConfig) Validate() error

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

type Query ¶

type Query struct {

    // Alias attached to the query, for ease of location.
    Alias *string `min:"1" type:"string"`

    // Pages is a parameter that the user inputs to specify which pages to apply
    // a query to. The following is a list of rules for using this parameter.
    //
    //    * If a page is not specified, it is set to ["1"] by default.
    //
    //    * The following characters are allowed in the parameter's string: 0 1
    //    2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    //
    //    * When using * to indicate all pages, it must be the only element in the
    //    list.
    //
    //    * You can use page intervals, such as [“1-3”, “1-1”, “4-*”].
    //    Where * indicates last page of document.
    //
    //    * Specified pages must be greater than 0 and less than or equal to the
    //    number of pages in the document.
    Pages []*string `min:"1" type:"list"`

    // Question that Amazon Textract will apply to the document. An example would
    // be "What is the customer's SSN?"
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Each query contains the question you want to ask in the Text and the alias you want to associate.

func (Query) GoString ¶

func (s Query) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Query) SetAlias ¶

func (s *Query) SetAlias(v string) *Query

SetAlias sets the Alias field's value.

func (*Query) SetPages ¶

func (s *Query) SetPages(v []*string) *Query

SetPages sets the Pages field's value.

func (*Query) SetText ¶

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

SetText sets the Text field's value.

func (Query) String ¶

func (s Query) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Query) Validate ¶

func (s *Query) Validate() error

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

type Relationship ¶

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 between the blocks in the IDs array and the current
    // block. The following list describes the relationship types that can be returned.
    //
    //    * VALUE - A list that contains the ID of the VALUE block that's associated
    //    with the KEY of a key-value pair.
    //
    //    * CHILD - A list of IDs that identify blocks found within the current
    //    block object. For example, WORD blocks have a CHILD relationship to the
    //    LINE block type.
    //
    //    * MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block
    //    types in a table.
    //
    //    * ANSWER - A list that contains the ID of the QUERY_RESULT block that’s
    //    associated with the corresponding QUERY block.
    //
    //    * TABLE - A list of IDs that identify associated TABLE block types.
    //
    //    * TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block
    //    type in a table.
    //
    //    * TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types
    //    in a table.
    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 ¶

func (s Relationship) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relationship) SetIds ¶

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

SetIds sets the Ids field's value.

func (*Relationship) SetType ¶

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

SetType sets the Type field's value.

func (Relationship) String ¶

func (s Relationship) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException ¶

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Returned when an operation tried to access a nonexistent resource.

func (*ResourceNotFoundException) Code ¶

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error ¶

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString ¶

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message ¶

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr ¶

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID ¶

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode ¶

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String ¶

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Object ¶

type S3Object struct {

    // The name of the S3 bucket. Note that the # character is not valid in the
    // file name.
    Bucket *string `min:"3" type:"string"`

    // 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 and TIFF format 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 ¶

func (s S3Object) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Object) SetBucket ¶

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

SetBucket sets the Bucket field's value.

func (*S3Object) SetName ¶

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

SetName sets the Name field's value.

func (*S3Object) SetVersion ¶

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

SetVersion sets the Version field's value.

func (S3Object) String ¶

func (s S3Object) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Object) Validate ¶

func (s *S3Object) Validate() error

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

type ServiceQuotaExceededException ¶

type ServiceQuotaExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*ServiceQuotaExceededException) Code ¶

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error ¶

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString ¶

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message ¶

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr ¶

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID ¶

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode ¶

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String ¶

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SignatureDetection ¶

type SignatureDetection struct {

    // The confidence, from 0 to 100, in the predicted values for a detected signature.
    Confidence *float64 `type:"float"`

    // Information about where the following items are located on a document page:
    // detected page, text, key-value pairs, tables, table cells, and selection
    // elements.
    Geometry *Geometry `type:"structure"`
    // contains filtered or unexported fields
}

Information regarding a detected signature on a page.

func (SignatureDetection) GoString ¶

func (s SignatureDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SignatureDetection) SetConfidence ¶

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

SetConfidence sets the Confidence field's value.

func (*SignatureDetection) SetGeometry ¶

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

SetGeometry sets the Geometry field's value.

func (SignatureDetection) String ¶

func (s SignatureDetection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SplitDocument ¶

type SplitDocument struct {

    // The index for a given document in a DocumentGroup of a specific Type.
    Index *int64 `type:"integer"`

    // An array of page numbers for a for a given document, ordered by logical boundary.
    Pages []*int64 `type:"list"`
    // contains filtered or unexported fields
}

Contains information about the pages of a document, defined by logical boundary.

func (SplitDocument) GoString ¶

func (s SplitDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SplitDocument) SetIndex ¶

func (s *SplitDocument) SetIndex(v int64) *SplitDocument

SetIndex sets the Index field's value.

func (*SplitDocument) SetPages ¶

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

SetPages sets the Pages field's value.

func (SplitDocument) String ¶

func (s SplitDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDocumentAnalysisInput ¶

type StartDocumentAnalysisInput struct {

    // Specifies the adapter to be used when analyzing a document.
    AdaptersConfig *AdaptersConfig `type:"structure"`

    // 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 (https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
    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 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).
    //
    // FeatureTypes is a required field
    FeatureTypes []*string `type:"list" required:"true" enum:"FeatureType"`

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

    // 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.
    KMSKeyId *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"`

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

    QueriesConfig *QueriesConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartDocumentAnalysisInput) GoString ¶

func (s StartDocumentAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentAnalysisInput) SetAdaptersConfig ¶

func (s *StartDocumentAnalysisInput) SetAdaptersConfig(v *AdaptersConfig) *StartDocumentAnalysisInput

SetAdaptersConfig sets the AdaptersConfig field's value.

func (*StartDocumentAnalysisInput) SetClientRequestToken ¶

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentAnalysisInput) SetDocumentLocation ¶

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

SetDocumentLocation sets the DocumentLocation field's value.

func (*StartDocumentAnalysisInput) SetFeatureTypes ¶

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

SetFeatureTypes sets the FeatureTypes field's value.

func (*StartDocumentAnalysisInput) SetJobTag ¶

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

SetJobTag sets the JobTag field's value.

func (*StartDocumentAnalysisInput) SetKMSKeyId ¶

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

SetKMSKeyId sets the KMSKeyId field's value.

func (*StartDocumentAnalysisInput) SetNotificationChannel ¶

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

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartDocumentAnalysisInput) SetOutputConfig ¶

func (s *StartDocumentAnalysisInput) SetOutputConfig(v *OutputConfig) *StartDocumentAnalysisInput

SetOutputConfig sets the OutputConfig field's value.

func (*StartDocumentAnalysisInput) SetQueriesConfig ¶

func (s *StartDocumentAnalysisInput) SetQueriesConfig(v *QueriesConfig) *StartDocumentAnalysisInput

SetQueriesConfig sets the QueriesConfig field's value.

func (StartDocumentAnalysisInput) String ¶

func (s StartDocumentAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentAnalysisInput) Validate ¶

func (s *StartDocumentAnalysisInput) Validate() error

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

type StartDocumentAnalysisOutput ¶

type StartDocumentAnalysisOutput struct {

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

func (StartDocumentAnalysisOutput) GoString ¶

func (s StartDocumentAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentAnalysisOutput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (StartDocumentAnalysisOutput) String ¶

func (s StartDocumentAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDocumentTextDetectionInput ¶

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. For more information, see Calling Amazon
    // Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
    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 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).
    JobTag *string `min:"1" type:"string"`

    // 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.
    KMSKeyId *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"`

    // 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.
    OutputConfig *OutputConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartDocumentTextDetectionInput) GoString ¶

func (s StartDocumentTextDetectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentTextDetectionInput) SetClientRequestToken ¶

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentTextDetectionInput) SetDocumentLocation ¶

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

SetDocumentLocation sets the DocumentLocation field's value.

func (*StartDocumentTextDetectionInput) SetJobTag ¶

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

SetJobTag sets the JobTag field's value.

func (*StartDocumentTextDetectionInput) SetKMSKeyId ¶

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

SetKMSKeyId sets the KMSKeyId field's value.

func (*StartDocumentTextDetectionInput) SetNotificationChannel ¶

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

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartDocumentTextDetectionInput) SetOutputConfig ¶

func (s *StartDocumentTextDetectionInput) SetOutputConfig(v *OutputConfig) *StartDocumentTextDetectionInput

SetOutputConfig sets the OutputConfig field's value.

func (StartDocumentTextDetectionInput) String ¶

func (s StartDocumentTextDetectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentTextDetectionInput) Validate ¶

func (s *StartDocumentTextDetectionInput) Validate() error

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

type StartDocumentTextDetectionOutput ¶

type StartDocumentTextDetectionOutput struct {

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

func (StartDocumentTextDetectionOutput) GoString ¶

func (s StartDocumentTextDetectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentTextDetectionOutput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (StartDocumentTextDetectionOutput) String ¶

func (s StartDocumentTextDetectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartExpenseAnalysisInput ¶

type StartExpenseAnalysisInput 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. For more information, see Calling Amazon
    // Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-async.html)
    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
    // 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).
    JobTag *string `min:"1" type:"string"`

    // 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.
    KMSKeyId *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"`

    // 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 GetExpenseAnalysis
    // operation.
    OutputConfig *OutputConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartExpenseAnalysisInput) GoString ¶

func (s StartExpenseAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExpenseAnalysisInput) SetClientRequestToken ¶

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartExpenseAnalysisInput) SetDocumentLocation ¶

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

SetDocumentLocation sets the DocumentLocation field's value.

func (*StartExpenseAnalysisInput) SetJobTag ¶

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

SetJobTag sets the JobTag field's value.

func (*StartExpenseAnalysisInput) SetKMSKeyId ¶

func (s *StartExpenseAnalysisInput) SetKMSKeyId(v string) *StartExpenseAnalysisInput

SetKMSKeyId sets the KMSKeyId field's value.

func (*StartExpenseAnalysisInput) SetNotificationChannel ¶

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

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartExpenseAnalysisInput) SetOutputConfig ¶

func (s *StartExpenseAnalysisInput) SetOutputConfig(v *OutputConfig) *StartExpenseAnalysisInput

SetOutputConfig sets the OutputConfig field's value.

func (StartExpenseAnalysisInput) String ¶

func (s StartExpenseAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExpenseAnalysisInput) Validate ¶

func (s *StartExpenseAnalysisInput) Validate() error

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

type StartExpenseAnalysisOutput ¶

type StartExpenseAnalysisOutput struct {

    // A unique identifier for the text detection job. The JobId is returned from
    // StartExpenseAnalysis. A JobId value is only valid for 7 days.
    JobId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartExpenseAnalysisOutput) GoString ¶

func (s StartExpenseAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExpenseAnalysisOutput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (StartExpenseAnalysisOutput) String ¶

func (s StartExpenseAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartLendingAnalysisInput ¶

type StartLendingAnalysisInput struct {

    // The idempotent token that you use to identify the start request. If you use
    // the same token with multiple StartLendingAnalysis 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 (https://docs.aws.amazon.com/textract/latest/dg/api-sync.html).
    ClientRequestToken *string `min:"1" type:"string"`

    // The Amazon S3 bucket that contains the document to be processed. It's used
    // by asynchronous operations.
    //
    // The input document can be an image file in JPEG or PNG format. It can also
    // be a file in PDF format.
    //
    // DocumentLocation is a required field
    DocumentLocation *DocumentLocation `type:"structure" required:"true"`

    // An identifier that you specify to be 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).
    JobTag *string `min:"1" type:"string"`

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

    // The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon
    // Textract publishes the completion status of an asynchronous document operation.
    NotificationChannel *NotificationChannel `type:"structure"`

    // 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 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. (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)
    //
    // For more information on data privacy, see the Data Privacy FAQ (https://aws.amazon.com/compliance/data-privacy-faq/).
    OutputConfig *OutputConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartLendingAnalysisInput) GoString ¶

func (s StartLendingAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLendingAnalysisInput) SetClientRequestToken ¶

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartLendingAnalysisInput) SetDocumentLocation ¶

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

SetDocumentLocation sets the DocumentLocation field's value.

func (*StartLendingAnalysisInput) SetJobTag ¶

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

SetJobTag sets the JobTag field's value.

func (*StartLendingAnalysisInput) SetKMSKeyId ¶

func (s *StartLendingAnalysisInput) SetKMSKeyId(v string) *StartLendingAnalysisInput

SetKMSKeyId sets the KMSKeyId field's value.

func (*StartLendingAnalysisInput) SetNotificationChannel ¶

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

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartLendingAnalysisInput) SetOutputConfig ¶

func (s *StartLendingAnalysisInput) SetOutputConfig(v *OutputConfig) *StartLendingAnalysisInput

SetOutputConfig sets the OutputConfig field's value.

func (StartLendingAnalysisInput) String ¶

func (s StartLendingAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLendingAnalysisInput) Validate ¶

func (s *StartLendingAnalysisInput) Validate() error

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

type StartLendingAnalysisOutput ¶

type StartLendingAnalysisOutput struct {

    // A unique identifier for the lending or text-detection job. The JobId is returned
    // from StartLendingAnalysis. A JobId value is only valid for 7 days.
    JobId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartLendingAnalysisOutput) GoString ¶

func (s StartLendingAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLendingAnalysisOutput) SetJobId ¶

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

SetJobId sets the JobId field's value.

func (StartLendingAnalysisOutput) String ¶

func (s StartLendingAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput ¶

type TagResourceInput struct {

    // The Amazon Resource Name (ARN) that specifies the resource to be tagged.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // A set of tags (key-value pairs) that you want to assign to the resource.
    //
    // Tags is a required field
    Tags map[string]*string `type:"map" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString ¶

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN ¶

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags ¶

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String ¶

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate ¶

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput ¶

type TagResourceOutput struct {
    // contains filtered or unexported fields
}

func (TagResourceOutput) GoString ¶

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String ¶

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Textract ¶

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 ¶

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:

mySession := session.Must(session.NewSession())

// 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 ¶

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:

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

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

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

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

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

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

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

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

The output is returned in a list of Block objects.

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

For more information, see Document Text Analysis (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 Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

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

func (*Textract) AnalyzeDocumentRequest ¶

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 ¶

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) AnalyzeExpense ¶

func (c *Textract) AnalyzeExpense(input *AnalyzeExpenseInput) (*AnalyzeExpenseOutput, error)

AnalyzeExpense API operation for Amazon Textract.

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

Information is returned as ExpenseDocuments and seperated as follows:

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

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

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 AnalyzeExpense for usage and error information.

Returned Error Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

func (*Textract) AnalyzeExpenseRequest ¶

func (c *Textract) AnalyzeExpenseRequest(input *AnalyzeExpenseInput) (req *request.Request, output *AnalyzeExpenseOutput)

AnalyzeExpenseRequest generates a "aws/request.Request" representing the client's request for the AnalyzeExpense 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 AnalyzeExpense for more information on using the AnalyzeExpense 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 AnalyzeExpenseRequest method.
req, resp := client.AnalyzeExpenseRequest(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/AnalyzeExpense

func (*Textract) AnalyzeExpenseWithContext ¶

func (c *Textract) AnalyzeExpenseWithContext(ctx aws.Context, input *AnalyzeExpenseInput, opts ...request.Option) (*AnalyzeExpenseOutput, error)

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

See AnalyzeExpense 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) AnalyzeID ¶

func (c *Textract) AnalyzeID(input *AnalyzeIDInput) (*AnalyzeIDOutput, error)

AnalyzeID API operation for Amazon Textract.

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

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 AnalyzeID for usage and error information.

Returned Error Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

func (*Textract) AnalyzeIDRequest ¶

func (c *Textract) AnalyzeIDRequest(input *AnalyzeIDInput) (req *request.Request, output *AnalyzeIDOutput)

AnalyzeIDRequest generates a "aws/request.Request" representing the client's request for the AnalyzeID 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 AnalyzeID for more information on using the AnalyzeID 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 AnalyzeIDRequest method.
req, resp := client.AnalyzeIDRequest(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/AnalyzeID

func (*Textract) AnalyzeIDWithContext ¶

func (c *Textract) AnalyzeIDWithContext(ctx aws.Context, input *AnalyzeIDInput, opts ...request.Option) (*AnalyzeIDOutput, error)

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

See AnalyzeID 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) CreateAdapter ¶

func (c *Textract) CreateAdapter(input *CreateAdapterInput) (*CreateAdapterOutput, error)

CreateAdapter API operation for Amazon Textract.

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

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 CreateAdapter for usage and error information.

Returned Error Types:

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

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

• ConflictException Updating or deleting a resource can cause an inconsistent state.

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

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

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

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

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

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

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

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

func (*Textract) CreateAdapterRequest ¶

func (c *Textract) CreateAdapterRequest(input *CreateAdapterInput) (req *request.Request, output *CreateAdapterOutput)

CreateAdapterRequest generates a "aws/request.Request" representing the client's request for the CreateAdapter 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 CreateAdapter for more information on using the CreateAdapter 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 CreateAdapterRequest method.
req, resp := client.CreateAdapterRequest(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/CreateAdapter

func (*Textract) CreateAdapterVersion ¶

func (c *Textract) CreateAdapterVersion(input *CreateAdapterVersionInput) (*CreateAdapterVersionOutput, error)

CreateAdapterVersion API operation for Amazon Textract.

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

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 CreateAdapterVersion for usage and error information.

Returned Error Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

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

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

• ConflictException Updating or deleting a resource can cause an inconsistent state.

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

func (*Textract) CreateAdapterVersionRequest ¶

func (c *Textract) CreateAdapterVersionRequest(input *CreateAdapterVersionInput) (req *request.Request, output *CreateAdapterVersionOutput)

CreateAdapterVersionRequest generates a "aws/request.Request" representing the client's request for the CreateAdapterVersion 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 CreateAdapterVersion for more information on using the CreateAdapterVersion 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 CreateAdapterVersionRequest method.
req, resp := client.CreateAdapterVersionRequest(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/CreateAdapterVersion

func (*Textract) CreateAdapterVersionWithContext ¶

func (c *Textract) CreateAdapterVersionWithContext(ctx aws.Context, input *CreateAdapterVersionInput, opts ...request.Option) (*CreateAdapterVersionOutput, error)

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

See CreateAdapterVersion 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) CreateAdapterWithContext ¶

func (c *Textract) CreateAdapterWithContext(ctx aws.Context, input *CreateAdapterInput, opts ...request.Option) (*CreateAdapterOutput, error)

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

See CreateAdapter 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) DeleteAdapter ¶

func (c *Textract) DeleteAdapter(input *DeleteAdapterInput) (*DeleteAdapterOutput, error)

DeleteAdapter API operation for Amazon Textract.

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

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 DeleteAdapter for usage and error information.

Returned Error Types:

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

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

• ConflictException Updating or deleting a resource can cause an inconsistent state.

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

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

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

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

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

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

func (*Textract) DeleteAdapterRequest ¶

func (c *Textract) DeleteAdapterRequest(input *DeleteAdapterInput) (req *request.Request, output *DeleteAdapterOutput)

DeleteAdapterRequest generates a "aws/request.Request" representing the client's request for the DeleteAdapter 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 DeleteAdapter for more information on using the DeleteAdapter 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 DeleteAdapterRequest method.
req, resp := client.DeleteAdapterRequest(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/DeleteAdapter

func (*Textract) DeleteAdapterVersion ¶

func (c *Textract) DeleteAdapterVersion(input *DeleteAdapterVersionInput) (*DeleteAdapterVersionOutput, error)

DeleteAdapterVersion API operation for Amazon Textract.

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

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 DeleteAdapterVersion for usage and error information.

Returned Error Types:

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

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

• ConflictException Updating or deleting a resource can cause an inconsistent state.

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

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

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

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

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

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

func (*Textract) DeleteAdapterVersionRequest ¶

func (c *Textract) DeleteAdapterVersionRequest(input *DeleteAdapterVersionInput) (req *request.Request, output *DeleteAdapterVersionOutput)

DeleteAdapterVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteAdapterVersion 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 DeleteAdapterVersion for more information on using the DeleteAdapterVersion 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 DeleteAdapterVersionRequest method.
req, resp := client.DeleteAdapterVersionRequest(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/DeleteAdapterVersion

func (*Textract) DeleteAdapterVersionWithContext ¶

func (c *Textract) DeleteAdapterVersionWithContext(ctx aws.Context, input *DeleteAdapterVersionInput, opts ...request.Option) (*DeleteAdapterVersionOutput, error)

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

See DeleteAdapterVersion 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) DeleteAdapterWithContext ¶

func (c *Textract) DeleteAdapterWithContext(ctx aws.Context, input *DeleteAdapterInput, opts ...request.Option) (*DeleteAdapterOutput, error)

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

See DeleteAdapter 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 ¶

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 in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

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

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

For more information, see Document Text Detection (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 Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

func (*Textract) DetectDocumentTextRequest ¶

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 ¶

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) GetAdapter ¶

func (c *Textract) GetAdapter(input *GetAdapterInput) (*GetAdapterOutput, error)

GetAdapter API operation for Amazon Textract.

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

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 GetAdapter for usage and error information.

Returned Error Types:

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

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

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

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

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

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

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

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

func (*Textract) GetAdapterRequest ¶

func (c *Textract) GetAdapterRequest(input *GetAdapterInput) (req *request.Request, output *GetAdapterOutput)

GetAdapterRequest generates a "aws/request.Request" representing the client's request for the GetAdapter 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 GetAdapter for more information on using the GetAdapter 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 GetAdapterRequest method.
req, resp := client.GetAdapterRequest(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/GetAdapter

func (*Textract) GetAdapterVersion ¶

func (c *Textract) GetAdapterVersion(input *GetAdapterVersionInput) (*GetAdapterVersionOutput, error)

GetAdapterVersion API operation for Amazon Textract.

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

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 GetAdapterVersion for usage and error information.

Returned Error Types:

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

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

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

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

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

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

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

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

func (*Textract) GetAdapterVersionRequest ¶

func (c *Textract) GetAdapterVersionRequest(input *GetAdapterVersionInput) (req *request.Request, output *GetAdapterVersionOutput)

GetAdapterVersionRequest generates a "aws/request.Request" representing the client's request for the GetAdapterVersion 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 GetAdapterVersion for more information on using the GetAdapterVersion 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 GetAdapterVersionRequest method.
req, resp := client.GetAdapterVersionRequest(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/GetAdapterVersion

func (*Textract) GetAdapterVersionWithContext ¶

func (c *Textract) GetAdapterVersionWithContext(ctx aws.Context, input *GetAdapterVersionInput, opts ...request.Option) (*GetAdapterVersionOutput, error)

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

See GetAdapterVersion 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) GetAdapterWithContext ¶

func (c *Textract) GetAdapterWithContext(ctx aws.Context, input *GetAdapterInput, opts ...request.Option) (*GetAdapterOutput, error)

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

See GetAdapter 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 ¶

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:

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

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

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

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

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

While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

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

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

For more information, see Document Text Analysis (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 Types:

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

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

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

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

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

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

func (*Textract) GetDocumentAnalysisRequest ¶

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 ¶

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 ¶

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 Types:

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

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

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

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

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

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

func (*Textract) GetDocumentTextDetectionRequest ¶

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 ¶

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) GetExpenseAnalysis ¶

func (c *Textract) GetExpenseAnalysis(input *GetExpenseAnalysisInput) (*GetExpenseAnalysisOutput, error)

GetExpenseAnalysis API operation for Amazon Textract.

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

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

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

For more information, see Analyzing Invoices and Receipts (https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.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 GetExpenseAnalysis for usage and error information.

Returned Error Types:

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

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

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

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

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

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

func (*Textract) GetExpenseAnalysisRequest ¶

func (c *Textract) GetExpenseAnalysisRequest(input *GetExpenseAnalysisInput) (req *request.Request, output *GetExpenseAnalysisOutput)

GetExpenseAnalysisRequest generates a "aws/request.Request" representing the client's request for the GetExpenseAnalysis 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 GetExpenseAnalysis for more information on using the GetExpenseAnalysis 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 GetExpenseAnalysisRequest method.
req, resp := client.GetExpenseAnalysisRequest(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/GetExpenseAnalysis

func (*Textract) GetExpenseAnalysisWithContext ¶

func (c *Textract) GetExpenseAnalysisWithContext(ctx aws.Context, input *GetExpenseAnalysisInput, opts ...request.Option) (*GetExpenseAnalysisOutput, error)

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

See GetExpenseAnalysis 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) GetLendingAnalysis ¶

func (c *Textract) GetLendingAnalysis(input *GetLendingAnalysisInput) (*GetLendingAnalysisOutput, error)

GetLendingAnalysis API operation for Amazon Textract.

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

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

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

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 GetLendingAnalysis for usage and error information.

Returned Error Types:

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

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

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

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

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

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

func (*Textract) GetLendingAnalysisRequest ¶

func (c *Textract) GetLendingAnalysisRequest(input *GetLendingAnalysisInput) (req *request.Request, output *GetLendingAnalysisOutput)

GetLendingAnalysisRequest generates a "aws/request.Request" representing the client's request for the GetLendingAnalysis 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 GetLendingAnalysis for more information on using the GetLendingAnalysis 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 GetLendingAnalysisRequest method.
req, resp := client.GetLendingAnalysisRequest(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/GetLendingAnalysis

func (*Textract) GetLendingAnalysisSummary ¶

func (c *Textract) GetLendingAnalysisSummary(input *GetLendingAnalysisSummaryInput) (*GetLendingAnalysisSummaryOutput, error)

GetLendingAnalysisSummary API operation for Amazon Textract.

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

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

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

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 GetLendingAnalysisSummary for usage and error information.

Returned Error Types:

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

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

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

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

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

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

func (*Textract) GetLendingAnalysisSummaryRequest ¶

func (c *Textract) GetLendingAnalysisSummaryRequest(input *GetLendingAnalysisSummaryInput) (req *request.Request, output *GetLendingAnalysisSummaryOutput)

GetLendingAnalysisSummaryRequest generates a "aws/request.Request" representing the client's request for the GetLendingAnalysisSummary 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 GetLendingAnalysisSummary for more information on using the GetLendingAnalysisSummary 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 GetLendingAnalysisSummaryRequest method.
req, resp := client.GetLendingAnalysisSummaryRequest(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/GetLendingAnalysisSummary

func (*Textract) GetLendingAnalysisSummaryWithContext ¶

func (c *Textract) GetLendingAnalysisSummaryWithContext(ctx aws.Context, input *GetLendingAnalysisSummaryInput, opts ...request.Option) (*GetLendingAnalysisSummaryOutput, error)

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

See GetLendingAnalysisSummary 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) GetLendingAnalysisWithContext ¶

func (c *Textract) GetLendingAnalysisWithContext(ctx aws.Context, input *GetLendingAnalysisInput, opts ...request.Option) (*GetLendingAnalysisOutput, error)

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

See GetLendingAnalysis 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) ListAdapterVersions ¶

func (c *Textract) ListAdapterVersions(input *ListAdapterVersionsInput) (*ListAdapterVersionsOutput, error)

ListAdapterVersions API operation for Amazon Textract.

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

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 ListAdapterVersions for usage and error information.

Returned Error Types:

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

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

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

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

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

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

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

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

func (*Textract) ListAdapterVersionsPages ¶

func (c *Textract) ListAdapterVersionsPages(input *ListAdapterVersionsInput, fn func(*ListAdapterVersionsOutput, bool) bool) error

ListAdapterVersionsPages iterates over the pages of a ListAdapterVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAdapterVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAdapterVersions operation.
pageNum := 0
err := client.ListAdapterVersionsPages(params,
    func(page *textract.ListAdapterVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Textract) ListAdapterVersionsPagesWithContext ¶

func (c *Textract) ListAdapterVersionsPagesWithContext(ctx aws.Context, input *ListAdapterVersionsInput, fn func(*ListAdapterVersionsOutput, bool) bool, opts ...request.Option) error

ListAdapterVersionsPagesWithContext same as ListAdapterVersionsPages except it takes a Context and allows setting request options on the pages.

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) ListAdapterVersionsRequest ¶

func (c *Textract) ListAdapterVersionsRequest(input *ListAdapterVersionsInput) (req *request.Request, output *ListAdapterVersionsOutput)

ListAdapterVersionsRequest generates a "aws/request.Request" representing the client's request for the ListAdapterVersions 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 ListAdapterVersions for more information on using the ListAdapterVersions 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 ListAdapterVersionsRequest method.
req, resp := client.ListAdapterVersionsRequest(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/ListAdapterVersions

func (*Textract) ListAdapterVersionsWithContext ¶

func (c *Textract) ListAdapterVersionsWithContext(ctx aws.Context, input *ListAdapterVersionsInput, opts ...request.Option) (*ListAdapterVersionsOutput, error)

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

See ListAdapterVersions 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) ListAdapters ¶

func (c *Textract) ListAdapters(input *ListAdaptersInput) (*ListAdaptersOutput, error)

ListAdapters API operation for Amazon Textract.

Lists all adapters that match the specified filtration criteria.

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 ListAdapters for usage and error information.

Returned Error Types:

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

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

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

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

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

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

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

func (*Textract) ListAdaptersPages ¶

func (c *Textract) ListAdaptersPages(input *ListAdaptersInput, fn func(*ListAdaptersOutput, bool) bool) error

ListAdaptersPages iterates over the pages of a ListAdapters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAdapters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAdapters operation.
pageNum := 0
err := client.ListAdaptersPages(params,
    func(page *textract.ListAdaptersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Textract) ListAdaptersPagesWithContext ¶

func (c *Textract) ListAdaptersPagesWithContext(ctx aws.Context, input *ListAdaptersInput, fn func(*ListAdaptersOutput, bool) bool, opts ...request.Option) error

ListAdaptersPagesWithContext same as ListAdaptersPages except it takes a Context and allows setting request options on the pages.

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) ListAdaptersRequest ¶

func (c *Textract) ListAdaptersRequest(input *ListAdaptersInput) (req *request.Request, output *ListAdaptersOutput)

ListAdaptersRequest generates a "aws/request.Request" representing the client's request for the ListAdapters 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 ListAdapters for more information on using the ListAdapters 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 ListAdaptersRequest method.
req, resp := client.ListAdaptersRequest(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/ListAdapters

func (*Textract) ListAdaptersWithContext ¶

func (c *Textract) ListAdaptersWithContext(ctx aws.Context, input *ListAdaptersInput, opts ...request.Option) (*ListAdaptersOutput, error)

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

See ListAdapters 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) ListTagsForResource ¶

func (c *Textract) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Textract.

Lists all tags for an Amazon Textract resource.

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 ListTagsForResource for usage and error information.

Returned Error Types:

• ResourceNotFoundException Returned when an operation tried to access a nonexistent resource.

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

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

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

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

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

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

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

func (*Textract) ListTagsForResourceRequest ¶

func (c *Textract) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*Textract) ListTagsForResourceWithContext ¶

func (c *Textract) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 ¶

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

StartDocumentAnalysis API operation for Amazon Textract.

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

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

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

For more information, see Document Text Analysis (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 Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

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

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

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

func (*Textract) StartDocumentAnalysisRequest ¶

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 ¶

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 ¶

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 JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

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

For more information, see Document Text Detection (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 Types:

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

• InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)

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

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

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

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

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

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

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

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

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

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

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