com.amazonaws.services.rekognition.model

Class Image

java.lang.Object

com.amazonaws.services.rekognition.model.Image

All Implemented Interfaces:

java.io.Serializable

public class Image
extends java.lang.Object
implements java.io.Serializable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.nio.ByteBuffer	getBytes() Blob of image bytes up to 5 MBs.
S3Object	getS3Object() Identifies an S3 object as the image source.
int	hashCode()
void	setBytes(java.nio.ByteBuffer bytes) Blob of image bytes up to 5 MBs.
void	setS3Object(S3Object s3Object) Identifies an S3 object as the image source.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Image	withBytes(java.nio.ByteBuffer bytes) Blob of image bytes up to 5 MBs.
Image	withS3Object(S3Object s3Object) Identifies an S3 object as the image source.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Image

public Image()

Method Detail

getBytes

public java.nio.ByteBuffer getBytes()

Blob of image bytes up to 5 MBs.

Constraints:
Length: 1 - 5242880

Returns:

Blob of image bytes up to 5 MBs.

setBytes

public void setBytes(java.nio.ByteBuffer bytes)

Blob of image bytes up to 5 MBs.

Constraints:
Length: 1 - 5242880

Parameters:

bytes -

Blob of image bytes up to 5 MBs.

withBytes

public Image withBytes(java.nio.ByteBuffer bytes)

Blob of image bytes up to 5 MBs.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 5242880

Parameters:

bytes -

Blob of image bytes up to 5 MBs.

Returns:

A reference to this updated object so that method calls can be chained together.

getS3Object

public S3Object getS3Object()

Identifies an S3 object as the image source.

Returns:

Identifies an S3 object as the image source.

setS3Object

public void setS3Object(S3Object s3Object)

Identifies an S3 object as the image source.

Parameters:

s3Object -

Identifies an S3 object as the image source.

withS3Object

public Image withS3Object(S3Object s3Object)

Identifies an S3 object as the image source.

Returns a reference to this object so that method calls can be chained together.

Parameters:

s3Object -

Identifies an S3 object as the image source.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object