AWS SDK for C++  1.9.42
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::Image Class Reference

#include <Image.h>

Public Member Functions

 Image ()
 
 Image (Aws::Utils::Json::JsonView jsonValue)
 
Imageoperator= (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)
 
ImageWithBytes (const Aws::Utils::ByteBuffer &value)
 
ImageWithBytes (Aws::Utils::ByteBuffer &&value)
 
const S3ObjectGetS3Object () const
 
bool S3ObjectHasBeenSet () const
 
void SetS3Object (const S3Object &value)
 
void SetS3Object (S3Object &&value)
 
ImageWithS3Object (const S3Object &value)
 
ImageWithS3Object (S3Object &&value)
 

Detailed Description

Provides the input image either as bytes or an S3 object.

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

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.

See Also:

AWS API Reference

Definition at line 50 of file Image.h.

Constructor & Destructor Documentation

◆ Image() [1/2]

Aws::Rekognition::Model::Image::Image ( )

◆ Image() [2/2]

Aws::Rekognition::Model::Image::Image ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BytesHasBeenSet()

bool Aws::Rekognition::Model::Image::BytesHasBeenSet ( ) const
inline

Blob of image bytes up to 5 MBs.

Definition at line 67 of file Image.h.

◆ GetBytes()

const Aws::Utils::ByteBuffer& Aws::Rekognition::Model::Image::GetBytes ( ) const
inline

Blob of image bytes up to 5 MBs.

Definition at line 62 of file Image.h.

◆ GetS3Object()

const S3Object& Aws::Rekognition::Model::Image::GetS3Object ( ) const
inline

Identifies an S3 object as the image source.

Definition at line 93 of file Image.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Rekognition::Model::Image::Jsonize ( ) const

◆ operator=()

Image& Aws::Rekognition::Model::Image::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3ObjectHasBeenSet()

bool Aws::Rekognition::Model::Image::S3ObjectHasBeenSet ( ) const
inline

Identifies an S3 object as the image source.

Definition at line 98 of file Image.h.

◆ SetBytes() [1/2]

void Aws::Rekognition::Model::Image::SetBytes ( Aws::Utils::ByteBuffer &&  value)
inline

Blob of image bytes up to 5 MBs.

Definition at line 77 of file Image.h.

◆ SetBytes() [2/2]

void Aws::Rekognition::Model::Image::SetBytes ( const Aws::Utils::ByteBuffer value)
inline

Blob of image bytes up to 5 MBs.

Definition at line 72 of file Image.h.

◆ SetS3Object() [1/2]

void Aws::Rekognition::Model::Image::SetS3Object ( const S3Object value)
inline

Identifies an S3 object as the image source.

Definition at line 103 of file Image.h.

◆ SetS3Object() [2/2]

void Aws::Rekognition::Model::Image::SetS3Object ( S3Object &&  value)
inline

Identifies an S3 object as the image source.

Definition at line 108 of file Image.h.

◆ WithBytes() [1/2]

Image& Aws::Rekognition::Model::Image::WithBytes ( Aws::Utils::ByteBuffer &&  value)
inline

Blob of image bytes up to 5 MBs.

Definition at line 87 of file Image.h.

◆ WithBytes() [2/2]

Image& Aws::Rekognition::Model::Image::WithBytes ( const Aws::Utils::ByteBuffer value)
inline

Blob of image bytes up to 5 MBs.

Definition at line 82 of file Image.h.

◆ WithS3Object() [1/2]

Image& Aws::Rekognition::Model::Image::WithS3Object ( const S3Object value)
inline

Identifies an S3 object as the image source.

Definition at line 113 of file Image.h.

◆ WithS3Object() [2/2]

Image& Aws::Rekognition::Model::Image::WithS3Object ( S3Object &&  value)
inline

Identifies an S3 object as the image source.

Definition at line 118 of file Image.h.


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