Class Image
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Image.Builder,
Image>
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 How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Image.Builder
builder()
final SdkBytes
bytes()
Blob of image bytes up to 5 MBs.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final S3Object
s3Object()
Identifies an S3 object as the image source.static Class
<? extends Image.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bytes
Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to
DetectCustomLabels
is 4MB.- Returns:
- Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to
DetectCustomLabels
is 4MB.
-
s3Object
Identifies an S3 object as the image source.
- Returns:
- Identifies an S3 object as the image source.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Image.Builder,
Image> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-