AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Image

import "github.com/aws/aws-sdk-go/service/rekognition"

type Image struct { Bytes []byte `min:"1" type:"blob"` S3Object *S3Object `type:"structure"` }

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.

Bytes

Type: []byte

Blob of image bytes up to 5 MBs.

Bytes is automatically base64 encoded/decoded by the SDK.

S3Object

Provides the S3 bucket name and object name.

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

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.

Method

GoString

func (s Image) GoString() string

GoString returns the string representation

SetBytes

func (s *Image) SetBytes(v []byte) *Image

SetBytes sets the Bytes field's value.

SetS3Object

func (s *Image) SetS3Object(v *S3Object) *Image

SetS3Object sets the S3Object field's value.

String

func (s Image) String() string

String returns the string representation

Validate

func (s *Image) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: