AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Textract::Model::Document Class Reference

#include <Document.h>

Public Member Functions

 Document ()
 
 Document (Aws::Utils::Json::JsonView jsonValue)
 
Documentoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Utils::ByteBufferGetBytes () const
 
bool BytesHasBeenSet () const
 
void SetBytes (const Aws::Utils::ByteBuffer &value)
 
void SetBytes (Aws::Utils::ByteBuffer &&value)
 
DocumentWithBytes (const Aws::Utils::ByteBuffer &value)
 
DocumentWithBytes (Aws::Utils::ByteBuffer &&value)
 
const S3ObjectGetS3Object () const
 
bool S3ObjectHasBeenSet () const
 
void SetS3Object (const S3Object &value)
 
void SetS3Object (S3Object &&value)
 
DocumentWithS3Object (const S3Object &value)
 
DocumentWithS3Object (S3Object &&value)
 

Detailed Description

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

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

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

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

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

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

See Also:

AWS API Reference

Definition at line 47 of file Document.h.

Constructor & Destructor Documentation

◆ Document() [1/2]

Aws::Textract::Model::Document::Document ( )

◆ Document() [2/2]

Aws::Textract::Model::Document::Document ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BytesHasBeenSet()

bool Aws::Textract::Model::Document::BytesHasBeenSet ( ) const
inline

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.

Definition at line 72 of file Document.h.

◆ GetBytes()

const Aws::Utils::ByteBuffer& Aws::Textract::Model::Document::GetBytes ( ) const
inline

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.

Definition at line 63 of file Document.h.

◆ GetS3Object()

const S3Object& Aws::Textract::Model::Document::GetS3Object ( ) const
inline

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Definition at line 115 of file Document.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Textract::Model::Document::Jsonize ( ) const

◆ operator=()

Document& Aws::Textract::Model::Document::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3ObjectHasBeenSet()

bool Aws::Textract::Model::Document::S3ObjectHasBeenSet ( ) const
inline

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Definition at line 121 of file Document.h.

◆ SetBytes() [1/2]

void Aws::Textract::Model::Document::SetBytes ( const Aws::Utils::ByteBuffer value)
inline

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.

Definition at line 81 of file Document.h.

◆ SetBytes() [2/2]

void Aws::Textract::Model::Document::SetBytes ( Aws::Utils::ByteBuffer &&  value)
inline

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.

Definition at line 90 of file Document.h.

◆ SetS3Object() [1/2]

void Aws::Textract::Model::Document::SetS3Object ( const S3Object value)
inline

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Definition at line 127 of file Document.h.

◆ SetS3Object() [2/2]

void Aws::Textract::Model::Document::SetS3Object ( S3Object &&  value)
inline

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Definition at line 133 of file Document.h.

◆ WithBytes() [1/2]

Document& Aws::Textract::Model::Document::WithBytes ( const Aws::Utils::ByteBuffer value)
inline

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.

Definition at line 99 of file Document.h.

◆ WithBytes() [2/2]

Document& Aws::Textract::Model::Document::WithBytes ( Aws::Utils::ByteBuffer &&  value)
inline

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.

Definition at line 108 of file Document.h.

◆ WithS3Object() [1/2]

Document& Aws::Textract::Model::Document::WithS3Object ( const S3Object value)
inline

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Definition at line 139 of file Document.h.

◆ WithS3Object() [2/2]

Document& Aws::Textract::Model::Document::WithS3Object ( S3Object &&  value)
inline

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Definition at line 145 of file Document.h.


The documentation for this class was generated from the following file: