Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Documentation
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: newImage
smart constructor.
Instances
ToJSON Image Source # | |
Defined in Amazonka.Rekognition.Types.Image | |
Generic Image Source # | |
Read Image Source # | |
Show Image Source # | |
NFData Image Source # | |
Defined in Amazonka.Rekognition.Types.Image | |
Eq Image Source # | |
Hashable Image Source # | |
Defined in Amazonka.Rekognition.Types.Image | |
type Rep Image Source # | |
Defined in Amazonka.Rekognition.Types.Image type Rep Image = D1 ('MetaData "Image" "Amazonka.Rekognition.Types.Image" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "Image'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object)))) |
Create a value of Image
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bytes:Image'
, image_bytes
- Blob of image bytes up to 5 MBs.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:s3Object:Image'
, image_s3Object
- Identifies an S3 object as the image source.
image_bytes :: Lens' Image (Maybe ByteString) Source #
Blob of image bytes up to 5 MBs.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.