@Generated(value="software.amazon.awssdk:codegen") public class Image extends Object implements StructuredPojo, ToCopyableBuilder<Image.Builder,Image>
Provides the input image either as bytes or an S3 object.
You pass image bytes to a 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 Rekognition API operations. For more information, see example4.
You pass images stored in an S3 bucket to a 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 Amazon 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 manage-access-resource-policies.
Modifier and Type | Class and Description |
---|---|
static interface |
Image.Builder |
Modifier and Type | Method and Description |
---|---|
static Image.Builder |
builder() |
ByteBuffer |
bytes()
Blob of image bytes up to 5 MBs.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
S3Object |
s3Object()
Identifies an S3 object as the image source.
|
static Class<? extends Image.Builder> |
serializableBuilderClass() |
Image.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public ByteBuffer bytes()
Blob of image bytes up to 5 MBs.
This method will return a new read-only ByteBuffer
each time it is invoked.
public S3Object s3Object()
Identifies an S3 object as the image source.
public Image.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Image.Builder,Image>
public static Image.Builder builder()
public static Class<? extends Image.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.