rekognition

package
v1.13.44 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package rekognition provides the client and types for making API requests to Amazon Rekognition.

This is the Amazon Rekognition API reference.

See rekognition package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/rekognition/

Using the Client

To contact Amazon Rekognition with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Rekognition client Rekognition for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/rekognition/#New

Index

Examples

Constants

View Source 
const (
	// AttributeDefault is a Attribute enum value
	AttributeDefault = "DEFAULT"

	// AttributeAll is a Attribute enum value
	AttributeAll = "ALL"
)
View Source 
const (
	// CelebrityRecognitionSortById is a CelebrityRecognitionSortBy enum value
	CelebrityRecognitionSortById = "ID"

	// CelebrityRecognitionSortByTimestamp is a CelebrityRecognitionSortBy enum value
	CelebrityRecognitionSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// ContentModerationSortByName is a ContentModerationSortBy enum value
	ContentModerationSortByName = "NAME"

	// ContentModerationSortByTimestamp is a ContentModerationSortBy enum value
	ContentModerationSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// EmotionNameHappy is a EmotionName enum value
	EmotionNameHappy = "HAPPY"

	// EmotionNameSad is a EmotionName enum value
	EmotionNameSad = "SAD"

	// EmotionNameAngry is a EmotionName enum value
	EmotionNameAngry = "ANGRY"

	// EmotionNameConfused is a EmotionName enum value
	EmotionNameConfused = "CONFUSED"

	// EmotionNameDisgusted is a EmotionName enum value
	EmotionNameDisgusted = "DISGUSTED"

	// EmotionNameSurprised is a EmotionName enum value
	EmotionNameSurprised = "SURPRISED"

	// EmotionNameCalm is a EmotionName enum value
	EmotionNameCalm = "CALM"

	// EmotionNameUnknown is a EmotionName enum value
	EmotionNameUnknown = "UNKNOWN"
)
View Source 
const (
	// FaceAttributesDefault is a FaceAttributes enum value
	FaceAttributesDefault = "DEFAULT"

	// FaceAttributesAll is a FaceAttributes enum value
	FaceAttributesAll = "ALL"
)
View Source 
const (
	// FaceSearchSortByIndex is a FaceSearchSortBy enum value
	FaceSearchSortByIndex = "INDEX"

	// FaceSearchSortByTimestamp is a FaceSearchSortBy enum value
	FaceSearchSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// GenderTypeMale is a GenderType enum value
	GenderTypeMale = "Male"

	// GenderTypeFemale is a GenderType enum value
	GenderTypeFemale = "Female"
)
View Source 
const (
	// LabelDetectionSortByName is a LabelDetectionSortBy enum value
	LabelDetectionSortByName = "NAME"

	// LabelDetectionSortByTimestamp is a LabelDetectionSortBy enum value
	LabelDetectionSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// LandmarkTypeEyeLeft is a LandmarkType enum value
	LandmarkTypeEyeLeft = "eyeLeft"

	// LandmarkTypeEyeRight is a LandmarkType enum value
	LandmarkTypeEyeRight = "eyeRight"

	// LandmarkTypeNose is a LandmarkType enum value
	LandmarkTypeNose = "nose"

	// LandmarkTypeMouthLeft is a LandmarkType enum value
	LandmarkTypeMouthLeft = "mouthLeft"

	// LandmarkTypeMouthRight is a LandmarkType enum value
	LandmarkTypeMouthRight = "mouthRight"

	// LandmarkTypeLeftEyeBrowLeft is a LandmarkType enum value
	LandmarkTypeLeftEyeBrowLeft = "leftEyeBrowLeft"

	// LandmarkTypeLeftEyeBrowRight is a LandmarkType enum value
	LandmarkTypeLeftEyeBrowRight = "leftEyeBrowRight"

	// LandmarkTypeLeftEyeBrowUp is a LandmarkType enum value
	LandmarkTypeLeftEyeBrowUp = "leftEyeBrowUp"

	// LandmarkTypeRightEyeBrowLeft is a LandmarkType enum value
	LandmarkTypeRightEyeBrowLeft = "rightEyeBrowLeft"

	// LandmarkTypeRightEyeBrowRight is a LandmarkType enum value
	LandmarkTypeRightEyeBrowRight = "rightEyeBrowRight"

	// LandmarkTypeRightEyeBrowUp is a LandmarkType enum value
	LandmarkTypeRightEyeBrowUp = "rightEyeBrowUp"

	// LandmarkTypeLeftEyeLeft is a LandmarkType enum value
	LandmarkTypeLeftEyeLeft = "leftEyeLeft"

	// LandmarkTypeLeftEyeRight is a LandmarkType enum value
	LandmarkTypeLeftEyeRight = "leftEyeRight"

	// LandmarkTypeLeftEyeUp is a LandmarkType enum value
	LandmarkTypeLeftEyeUp = "leftEyeUp"

	// LandmarkTypeLeftEyeDown is a LandmarkType enum value
	LandmarkTypeLeftEyeDown = "leftEyeDown"

	// LandmarkTypeRightEyeLeft is a LandmarkType enum value
	LandmarkTypeRightEyeLeft = "rightEyeLeft"

	// LandmarkTypeRightEyeRight is a LandmarkType enum value
	LandmarkTypeRightEyeRight = "rightEyeRight"

	// LandmarkTypeRightEyeUp is a LandmarkType enum value
	LandmarkTypeRightEyeUp = "rightEyeUp"

	// LandmarkTypeRightEyeDown is a LandmarkType enum value
	LandmarkTypeRightEyeDown = "rightEyeDown"

	// LandmarkTypeNoseLeft is a LandmarkType enum value
	LandmarkTypeNoseLeft = "noseLeft"

	// LandmarkTypeNoseRight is a LandmarkType enum value
	LandmarkTypeNoseRight = "noseRight"

	// LandmarkTypeMouthUp is a LandmarkType enum value
	LandmarkTypeMouthUp = "mouthUp"

	// LandmarkTypeMouthDown is a LandmarkType enum value
	LandmarkTypeMouthDown = "mouthDown"

	// LandmarkTypeLeftPupil is a LandmarkType enum value
	LandmarkTypeLeftPupil = "leftPupil"

	// LandmarkTypeRightPupil is a LandmarkType enum value
	LandmarkTypeRightPupil = "rightPupil"
)
View Source 
const (
	// OrientationCorrectionRotate0 is a OrientationCorrection enum value
	OrientationCorrectionRotate0 = "ROTATE_0"

	// OrientationCorrectionRotate90 is a OrientationCorrection enum value
	OrientationCorrectionRotate90 = "ROTATE_90"

	// OrientationCorrectionRotate180 is a OrientationCorrection enum value
	OrientationCorrectionRotate180 = "ROTATE_180"

	// OrientationCorrectionRotate270 is a OrientationCorrection enum value
	OrientationCorrectionRotate270 = "ROTATE_270"
)
View Source 
const (
	// PersonTrackingSortByIndex is a PersonTrackingSortBy enum value
	PersonTrackingSortByIndex = "INDEX"

	// PersonTrackingSortByTimestamp is a PersonTrackingSortBy enum value
	PersonTrackingSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// StreamProcessorStatusStopped is a StreamProcessorStatus enum value
	StreamProcessorStatusStopped = "STOPPED"

	// StreamProcessorStatusStarting is a StreamProcessorStatus enum value
	StreamProcessorStatusStarting = "STARTING"

	// StreamProcessorStatusRunning is a StreamProcessorStatus enum value
	StreamProcessorStatusRunning = "RUNNING"

	// StreamProcessorStatusFailed is a StreamProcessorStatus enum value
	StreamProcessorStatusFailed = "FAILED"

	// StreamProcessorStatusStopping is a StreamProcessorStatus enum value
	StreamProcessorStatusStopping = "STOPPING"
)
View Source 
const (
	// TextTypesLine is a TextTypes enum value
	TextTypesLine = "LINE"

	// TextTypesWord is a TextTypes enum value
	TextTypesWord = "WORD"
)
View Source 
const (
	// VideoJobStatusInProgress is a VideoJobStatus enum value
	VideoJobStatusInProgress = "IN_PROGRESS"

	// VideoJobStatusSucceeded is a VideoJobStatus enum value
	VideoJobStatusSucceeded = "SUCCEEDED"

	// VideoJobStatusFailed is a VideoJobStatus enum value
	VideoJobStatusFailed = "FAILED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You are not authorized to perform the action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeIdempotentParameterMismatchException for service response error code
	// "IdempotentParameterMismatchException".
	//
	// A ClientRequestToken input parameter was reused with an operation, but at
	// least one of the other input parameters is different from the previous call
	// to the operation.
	ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

	// ErrCodeImageTooLargeException for service response error code
	// "ImageTooLargeException".
	//
	// The input image size exceeds the allowed limit. For more information, see
	// limits.
	ErrCodeImageTooLargeException = "ImageTooLargeException"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// Amazon Rekognition experienced a service issue. Try your call again.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidImageFormatException for service response error code
	// "InvalidImageFormatException".
	//
	// The provided image format is not supported.
	ErrCodeInvalidImageFormatException = "InvalidImageFormatException"

	// ErrCodeInvalidPaginationTokenException for service response error code
	// "InvalidPaginationTokenException".
	//
	// Pagination token in the request is not valid.
	ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// Input parameter violated a constraint. Validate your parameter before calling
	// the API operation again.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidS3ObjectException for service response error code
	// "InvalidS3ObjectException".
	//
	// Amazon Rekognition is unable to access the S3 object specified in the request.
	ErrCodeInvalidS3ObjectException = "InvalidS3ObjectException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// An Amazon Rekognition service limit was exceeded. For example, if you start
	// too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection,
	// for example) will raise a LimitExceededException exception (HTTP status code:
	// 400) until the number of concurrently running jobs is below the Amazon Rekognition
	// service limit.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeProvisionedThroughputExceededException for service response error code
	// "ProvisionedThroughputExceededException".
	//
	// The number of requests exceeded your throughput limit. If you want to increase
	// this limit, contact Amazon Rekognition.
	ErrCodeProvisionedThroughputExceededException = "ProvisionedThroughputExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// A collection with the specified ID already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The collection specified in the request cannot be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Amazon Rekognition is temporarily unable to process the request. Try your
	// call again.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeVideoTooLargeException for service response error code
	// "VideoTooLargeException".
	//
	// The file size or duration of the supplied media is too large. The maximum
	// file size is 8GB. The maximum duration is 2 hours.
	ErrCodeVideoTooLargeException = "VideoTooLargeException"
)
View Source 
const (
	ServiceName = "rekognition" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName   // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AgeRange added in v1.6.20 

type AgeRange struct {

	// The highest estimated age.
	High *int64 `type:"integer"`

	// The lowest estimated age.
	Low *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Structure containing the estimated age range, in years, for a face.

Rekognition estimates an age-range for faces detected in the input image. Estimated age ranges can overlap; a face of a 5 year old may have an estimated range of 4-6 whilst the face of a 6 year old may have an estimated range of 4-8.

func (AgeRange) GoString added in v1.6.20 

func (s AgeRange) GoString() string

GoString returns the string representation

func (*AgeRange) SetHigh added in v1.6.20 

func (s *AgeRange) SetHigh(v int64) *AgeRange

SetHigh sets the High field's value.

func (*AgeRange) SetLow added in v1.6.20 

func (s *AgeRange) SetLow(v int64) *AgeRange

SetLow sets the Low field's value.

func (AgeRange) String added in v1.6.20 

func (s AgeRange) String() string

String returns the string representation

type Beard 

type Beard struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the face has beard or not.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the face has a beard, and the confidence level in the determination.

func (Beard) GoString 

func (s Beard) GoString() string

GoString returns the string representation

func (*Beard) SetConfidence 

func (s *Beard) SetConfidence(v float64) *Beard

SetConfidence sets the Confidence field's value.

func (*Beard) SetValue 

func (s *Beard) SetValue(v bool) *Beard

SetValue sets the Value field's value.

func (Beard) String 

func (s Beard) String() string

String returns the string representation

type BoundingBox 

type BoundingBox struct {

	// Height of the bounding box as a ratio of the overall image height.
	Height *float64 `type:"float"`

	// Left coordinate of the bounding box as a ratio of overall image width.
	Left *float64 `type:"float"`

	// Top coordinate of the bounding box as a ratio of overall image height.
	Top *float64 `type:"float"`

	// Width of the bounding box as a ratio of the overall image width.
	Width *float64 `type:"float"`
	// contains filtered or unexported fields
}

Identifies the bounding box around the object, face or text. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

func (BoundingBox) GoString 

func (s BoundingBox) GoString() string

GoString returns the string representation

func (*BoundingBox) SetHeight 

func (s *BoundingBox) SetHeight(v float64) *BoundingBox

SetHeight sets the Height field's value.

func (*BoundingBox) SetLeft 

func (s *BoundingBox) SetLeft(v float64) *BoundingBox

SetLeft sets the Left field's value.

func (*BoundingBox) SetTop 

func (s *BoundingBox) SetTop(v float64) *BoundingBox

SetTop sets the Top field's value.

func (*BoundingBox) SetWidth 

func (s *BoundingBox) SetWidth(v float64) *BoundingBox

SetWidth sets the Width field's value.

func (BoundingBox) String 

func (s BoundingBox) String() string

String returns the string representation

type Celebrity added in v1.8.38 

type Celebrity struct {

	// Provides information about the celebrity's face, such as its location on
	// the image.
	Face *ComparedFace `type:"structure"`

	// A unique identifier for the celebrity.
	Id *string `type:"string"`

	// The confidence, in percentage, that Rekognition has that the recognized face
	// is the celebrity.
	MatchConfidence *float64 `type:"float"`

	// The name of the celebrity.
	Name *string `type:"string"`

	// An array of URLs pointing to additional information about the celebrity.
	// If there is no additional information about the celebrity, this list is empty.
	Urls []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides information about a celebrity recognized by the operation.

func (Celebrity) GoString added in v1.8.38 

func (s Celebrity) GoString() string

GoString returns the string representation

func (*Celebrity) SetFace added in v1.8.38 

func (s *Celebrity) SetFace(v *ComparedFace) *Celebrity

SetFace sets the Face field's value.

func (*Celebrity) SetId added in v1.8.38 

func (s *Celebrity) SetId(v string) *Celebrity

SetId sets the Id field's value.

func (*Celebrity) SetMatchConfidence added in v1.8.38 

func (s *Celebrity) SetMatchConfidence(v float64) *Celebrity

SetMatchConfidence sets the MatchConfidence field's value.

func (*Celebrity) SetName added in v1.8.38 

func (s *Celebrity) SetName(v string) *Celebrity

SetName sets the Name field's value.

func (*Celebrity) SetUrls added in v1.8.38 

func (s *Celebrity) SetUrls(v []*string) *Celebrity

SetUrls sets the Urls field's value.

func (Celebrity) String added in v1.8.38 

func (s Celebrity) String() string

String returns the string representation

type CelebrityDetail added in v1.12.36 

type CelebrityDetail struct {

	// Bounding box around the body of a celebrity.
	BoundingBox *BoundingBox `type:"structure"`

	// The confidence, in percentage, that Amazon Rekognition has that the recognized
	// face is the celebrity.
	Confidence *float64 `type:"float"`

	// Face details for the recognized celebrity.
	Face *FaceDetail `type:"structure"`

	// The unique identifier for the celebrity.
	Id *string `type:"string"`

	// The name of the celebrity.
	Name *string `type:"string"`

	// An array of URLs pointing to additional celebrity information.
	Urls []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about a recognized celebrity.

func (CelebrityDetail) GoString added in v1.12.36 

func (s CelebrityDetail) GoString() string

GoString returns the string representation

func (*CelebrityDetail) SetBoundingBox added in v1.12.36 

func (s *CelebrityDetail) SetBoundingBox(v *BoundingBox) *CelebrityDetail

SetBoundingBox sets the BoundingBox field's value.

func (*CelebrityDetail) SetConfidence added in v1.12.36 

func (s *CelebrityDetail) SetConfidence(v float64) *CelebrityDetail

SetConfidence sets the Confidence field's value.

func (*CelebrityDetail) SetFace added in v1.12.36 

func (s *CelebrityDetail) SetFace(v *FaceDetail) *CelebrityDetail

SetFace sets the Face field's value.

func (*CelebrityDetail) SetId added in v1.12.36 

func (s *CelebrityDetail) SetId(v string) *CelebrityDetail

SetId sets the Id field's value.

func (*CelebrityDetail) SetName added in v1.12.36 

func (s *CelebrityDetail) SetName(v string) *CelebrityDetail

SetName sets the Name field's value.

func (*CelebrityDetail) SetUrls added in v1.12.36 

func (s *CelebrityDetail) SetUrls(v []*string) *CelebrityDetail

SetUrls sets the Urls field's value.

func (CelebrityDetail) String added in v1.12.36 

func (s CelebrityDetail) String() string

String returns the string representation

type CelebrityRecognition added in v1.12.36 

type CelebrityRecognition struct {

	// Information about a recognized celebrity.
	Celebrity *CelebrityDetail `type:"structure"`

	// The time, in milliseconds from the start of the video, that the celebrity
	// was recognized.
	Timestamp *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see .

func (CelebrityRecognition) GoString added in v1.12.36 

func (s CelebrityRecognition) GoString() string

GoString returns the string representation

func (*CelebrityRecognition) SetCelebrity added in v1.12.36 

func (s *CelebrityRecognition) SetCelebrity(v *CelebrityDetail) *CelebrityRecognition

SetCelebrity sets the Celebrity field's value.

func (*CelebrityRecognition) SetTimestamp added in v1.12.36 

func (s *CelebrityRecognition) SetTimestamp(v int64) *CelebrityRecognition

SetTimestamp sets the Timestamp field's value.

func (CelebrityRecognition) String added in v1.12.36 

func (s CelebrityRecognition) String() string

String returns the string representation

type CompareFacesInput 

type CompareFacesInput struct {

	// The minimum level of confidence in the face matches that a match must meet
	// to be included in the FaceMatches array.
	SimilarityThreshold *float64 `type:"float"`

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// SourceImage is a required field
	SourceImage *Image `type:"structure" required:"true"`

	// The target image as base64-encoded bytes or an S3 object. If you use the
	// AWS CLI to call Amazon Rekognition operations, passing base64-encoded image
	// bytes is not supported.
	//
	// TargetImage is a required field
	TargetImage *Image `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CompareFacesInput) GoString 

func (s CompareFacesInput) GoString() string

GoString returns the string representation

func (*CompareFacesInput) SetSimilarityThreshold 

func (s *CompareFacesInput) SetSimilarityThreshold(v float64) *CompareFacesInput

SetSimilarityThreshold sets the SimilarityThreshold field's value.

func (*CompareFacesInput) SetSourceImage 

func (s *CompareFacesInput) SetSourceImage(v *Image) *CompareFacesInput

SetSourceImage sets the SourceImage field's value.

func (*CompareFacesInput) SetTargetImage 

func (s *CompareFacesInput) SetTargetImage(v *Image) *CompareFacesInput

SetTargetImage sets the TargetImage field's value.

func (CompareFacesInput) String 

func (s CompareFacesInput) String() string

String returns the string representation

func (*CompareFacesInput) Validate 

func (s *CompareFacesInput) Validate() error

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

type CompareFacesMatch 

type CompareFacesMatch struct {

	// Provides face metadata (bounding box and confidence that the bounding box
	// actually contains a face).
	Face *ComparedFace `type:"structure"`

	// Level of confidence that the faces match.
	Similarity *float64 `type:"float"`
	// contains filtered or unexported fields
}

Provides information about a face in a target image that matches the source image face analysed by CompareFaces. The Face property contains the bounding box of the face in the target image. The Similarity property is the confidence that the source image face matches the face in the bounding box.

func (CompareFacesMatch) GoString 

func (s CompareFacesMatch) GoString() string

GoString returns the string representation

func (*CompareFacesMatch) SetFace 

func (s *CompareFacesMatch) SetFace(v *ComparedFace) *CompareFacesMatch

SetFace sets the Face field's value.

func (*CompareFacesMatch) SetSimilarity 

func (s *CompareFacesMatch) SetSimilarity(v float64) *CompareFacesMatch

SetSimilarity sets the Similarity field's value.

func (CompareFacesMatch) String 

func (s CompareFacesMatch) String() string

String returns the string representation

type CompareFacesOutput 

type CompareFacesOutput struct {

	// An array of faces in the target image that match the source image face. Each
	// CompareFacesMatch object provides the bounding box, the confidence level
	// that the bounding box contains a face, and the similarity score for the face
	// in the bounding box and the face in the source image.
	FaceMatches []*CompareFacesMatch `type:"list"`

	// The face in the source image that was used for comparison.
	SourceImageFace *ComparedSourceImageFace `type:"structure"`

	// The orientation of the source image (counterclockwise direction). If your
	// application displays the source image, you can use this value to correct
	// image orientation. The bounding box coordinates returned in SourceImageFace
	// represent the location of the face before the image orientation is corrected.
	//
	// If the source image is in .jpeg format, it might contain exchangeable image
	// (Exif) metadata that includes the image's orientation. If the Exif metadata
	// for the source image populates the orientation field, the value of OrientationCorrection
	// is null and the SourceImageFace bounding box coordinates represent the location
	// of the face after Exif metadata is used to correct the orientation. Images
	// in .png format don't contain Exif metadata.
	SourceImageOrientationCorrection *string `type:"string" enum:"OrientationCorrection"`

	// The orientation of the target image (in counterclockwise direction). If your
	// application displays the target image, you can use this value to correct
	// the orientation of the image. The bounding box coordinates returned in FaceMatches
	// and UnmatchedFaces represent face locations before the image orientation
	// is corrected.
	//
	// If the target image is in .jpg format, it might contain Exif metadata that
	// includes the orientation of the image. If the Exif metadata for the target
	// image populates the orientation field, the value of OrientationCorrection
	// is null and the bounding box coordinates in FaceMatches and UnmatchedFaces
	// represent the location of the face after Exif metadata is used to correct
	// the orientation. Images in .png format don't contain Exif metadata.
	TargetImageOrientationCorrection *string `type:"string" enum:"OrientationCorrection"`

	// An array of faces in the target image that did not match the source image
	// face.
	UnmatchedFaces []*ComparedFace `type:"list"`
	// contains filtered or unexported fields
}

func (CompareFacesOutput) GoString 

func (s CompareFacesOutput) GoString() string

GoString returns the string representation

func (*CompareFacesOutput) SetFaceMatches 

func (s *CompareFacesOutput) SetFaceMatches(v []*CompareFacesMatch) *CompareFacesOutput

SetFaceMatches sets the FaceMatches field's value.

func (*CompareFacesOutput) SetSourceImageFace 

func (s *CompareFacesOutput) SetSourceImageFace(v *ComparedSourceImageFace) *CompareFacesOutput

SetSourceImageFace sets the SourceImageFace field's value.

func (*CompareFacesOutput) SetSourceImageOrientationCorrection added in v1.8.30 

func (s *CompareFacesOutput) SetSourceImageOrientationCorrection(v string) *CompareFacesOutput

SetSourceImageOrientationCorrection sets the SourceImageOrientationCorrection field's value.

func (*CompareFacesOutput) SetTargetImageOrientationCorrection added in v1.8.30 

func (s *CompareFacesOutput) SetTargetImageOrientationCorrection(v string) *CompareFacesOutput

SetTargetImageOrientationCorrection sets the TargetImageOrientationCorrection field's value.

func (*CompareFacesOutput) SetUnmatchedFaces added in v1.8.30 

func (s *CompareFacesOutput) SetUnmatchedFaces(v []*ComparedFace) *CompareFacesOutput

SetUnmatchedFaces sets the UnmatchedFaces field's value.

func (CompareFacesOutput) String 

func (s CompareFacesOutput) String() string

String returns the string representation

type ComparedFace 

type ComparedFace struct {

	// Bounding box of the face.
	BoundingBox *BoundingBox `type:"structure"`

	// Level of confidence that what the bounding box contains is a face.
	Confidence *float64 `type:"float"`

	// An array of facial landmarks.
	Landmarks []*Landmark `type:"list"`

	// Indicates the pose of the face as determined by its pitch, roll, and yaw.
	Pose *Pose `type:"structure"`

	// Identifies face image brightness and sharpness.
	Quality *ImageQuality `type:"structure"`
	// contains filtered or unexported fields
}

Provides face metadata for target image faces that are analysed by CompareFaces and RecognizeCelebrities.

func (ComparedFace) GoString 

func (s ComparedFace) GoString() string

GoString returns the string representation

func (*ComparedFace) SetBoundingBox 

func (s *ComparedFace) SetBoundingBox(v *BoundingBox) *ComparedFace

SetBoundingBox sets the BoundingBox field's value.

func (*ComparedFace) SetConfidence 

func (s *ComparedFace) SetConfidence(v float64) *ComparedFace

SetConfidence sets the Confidence field's value.

func (*ComparedFace) SetLandmarks added in v1.8.30 

func (s *ComparedFace) SetLandmarks(v []*Landmark) *ComparedFace

SetLandmarks sets the Landmarks field's value.

func (*ComparedFace) SetPose added in v1.8.30 

func (s *ComparedFace) SetPose(v *Pose) *ComparedFace

SetPose sets the Pose field's value.

func (*ComparedFace) SetQuality added in v1.8.30 

func (s *ComparedFace) SetQuality(v *ImageQuality) *ComparedFace

SetQuality sets the Quality field's value.

func (ComparedFace) String 

func (s ComparedFace) String() string

String returns the string representation

type ComparedSourceImageFace 

type ComparedSourceImageFace struct {

	// Bounding box of the face.
	BoundingBox *BoundingBox `type:"structure"`

	// Confidence level that the selected bounding box contains a face.
	Confidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.

func (ComparedSourceImageFace) GoString 

func (s ComparedSourceImageFace) GoString() string

GoString returns the string representation

func (*ComparedSourceImageFace) SetBoundingBox 

func (s *ComparedSourceImageFace) SetBoundingBox(v *BoundingBox) *ComparedSourceImageFace

SetBoundingBox sets the BoundingBox field's value.

func (*ComparedSourceImageFace) SetConfidence 

func (s *ComparedSourceImageFace) SetConfidence(v float64) *ComparedSourceImageFace

SetConfidence sets the Confidence field's value.

func (ComparedSourceImageFace) String 

func (s ComparedSourceImageFace) String() string

String returns the string representation

type ContentModerationDetection added in v1.12.36 

type ContentModerationDetection struct {

	// The moderation label detected by in the stored video.
	ModerationLabel *ModerationLabel `type:"structure"`

	// Time, in milliseconds from the beginning of the video, that the moderation
	// label was detected.
	Timestamp *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a moderation label detection in a stored video.

func (ContentModerationDetection) GoString added in v1.12.36 

func (s ContentModerationDetection) GoString() string

GoString returns the string representation

func (*ContentModerationDetection) SetModerationLabel added in v1.12.36 

func (s *ContentModerationDetection) SetModerationLabel(v *ModerationLabel) *ContentModerationDetection

SetModerationLabel sets the ModerationLabel field's value.

func (*ContentModerationDetection) SetTimestamp added in v1.12.36 

func (s *ContentModerationDetection) SetTimestamp(v int64) *ContentModerationDetection

SetTimestamp sets the Timestamp field's value.

func (ContentModerationDetection) String added in v1.12.36 

func (s ContentModerationDetection) String() string

String returns the string representation

type CreateCollectionInput 

type CreateCollectionInput struct {

	// ID for the collection that you are creating.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCollectionInput) GoString 

func (s CreateCollectionInput) GoString() string

GoString returns the string representation

func (*CreateCollectionInput) SetCollectionId 

func (s *CreateCollectionInput) SetCollectionId(v string) *CreateCollectionInput

SetCollectionId sets the CollectionId field's value.

func (CreateCollectionInput) String 

func (s CreateCollectionInput) String() string

String returns the string representation

func (*CreateCollectionInput) Validate 

func (s *CreateCollectionInput) Validate() error

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

type CreateCollectionOutput 

type CreateCollectionOutput struct {

	// Amazon Resource Name (ARN) of the collection. You can use this to manage
	// permissions on your resources.
	CollectionArn *string `type:"string"`

	// Version number of the face detection model associated with the collection
	// you are creating.
	FaceModelVersion *string `type:"string"`

	// HTTP status code indicating the result of the operation.
	StatusCode *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (CreateCollectionOutput) GoString 

func (s CreateCollectionOutput) GoString() string

GoString returns the string representation

func (*CreateCollectionOutput) SetCollectionArn 

func (s *CreateCollectionOutput) SetCollectionArn(v string) *CreateCollectionOutput

SetCollectionArn sets the CollectionArn field's value.

func (*CreateCollectionOutput) SetFaceModelVersion added in v1.12.32 

func (s *CreateCollectionOutput) SetFaceModelVersion(v string) *CreateCollectionOutput

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*CreateCollectionOutput) SetStatusCode 

func (s *CreateCollectionOutput) SetStatusCode(v int64) *CreateCollectionOutput

SetStatusCode sets the StatusCode field's value.

func (CreateCollectionOutput) String 

func (s CreateCollectionOutput) String() string

String returns the string representation

type CreateStreamProcessorInput added in v1.12.36 

type CreateStreamProcessorInput struct {

	// Kinesis video stream stream that provides the source streaming video. If
	// you are using the AWS CLI, the parameter name is StreamProcessorInput.
	//
	// Input is a required field
	Input *StreamProcessorInput `type:"structure" required:"true"`

	// An identifier you assign to the stream processor. You can use Name to manage
	// the stream processor. For example, you can get the current status of the
	// stream processor by calling . Name is idempotent.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Kinesis data stream stream to which Rekognition Video puts the analysis results.
	// If you are using the AWS CLI, the parameter name is StreamProcessorOutput.
	//
	// Output is a required field
	Output *StreamProcessorOutput `type:"structure" required:"true"`

	// ARN of the IAM role that allows access to the stream processor.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// Face recognition input parameters to be used by the stream processor. Includes
	// the collection to use for face recognition and the face attributes to detect.
	//
	// Settings is a required field
	Settings *StreamProcessorSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateStreamProcessorInput) GoString added in v1.12.36 

func (s CreateStreamProcessorInput) GoString() string

GoString returns the string representation

func (*CreateStreamProcessorInput) SetInput added in v1.12.36 

func (s *CreateStreamProcessorInput) SetInput(v *StreamProcessorInput) *CreateStreamProcessorInput

SetInput sets the Input field's value.

func (*CreateStreamProcessorInput) SetName added in v1.12.36 

func (s *CreateStreamProcessorInput) SetName(v string) *CreateStreamProcessorInput

SetName sets the Name field's value.

func (*CreateStreamProcessorInput) SetOutput added in v1.12.36 

func (s *CreateStreamProcessorInput) SetOutput(v *StreamProcessorOutput) *CreateStreamProcessorInput

SetOutput sets the Output field's value.

func (*CreateStreamProcessorInput) SetRoleArn added in v1.12.36 

func (s *CreateStreamProcessorInput) SetRoleArn(v string) *CreateStreamProcessorInput

SetRoleArn sets the RoleArn field's value.

func (*CreateStreamProcessorInput) SetSettings added in v1.12.36 

func (s *CreateStreamProcessorInput) SetSettings(v *StreamProcessorSettings) *CreateStreamProcessorInput

SetSettings sets the Settings field's value.

func (CreateStreamProcessorInput) String added in v1.12.36 

func (s CreateStreamProcessorInput) String() string

String returns the string representation

func (*CreateStreamProcessorInput) Validate added in v1.12.36 

func (s *CreateStreamProcessorInput) Validate() error

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

type CreateStreamProcessorOutput added in v1.12.36 

type CreateStreamProcessorOutput struct {

	// ARN for the newly create stream processor.
	StreamProcessorArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateStreamProcessorOutput) GoString added in v1.12.36 

func (s CreateStreamProcessorOutput) GoString() string

GoString returns the string representation

func (*CreateStreamProcessorOutput) SetStreamProcessorArn added in v1.12.36 

func (s *CreateStreamProcessorOutput) SetStreamProcessorArn(v string) *CreateStreamProcessorOutput

SetStreamProcessorArn sets the StreamProcessorArn field's value.

func (CreateStreamProcessorOutput) String added in v1.12.36 

func (s CreateStreamProcessorOutput) String() string

String returns the string representation

type DeleteCollectionInput 

type DeleteCollectionInput struct {

	// ID of the collection to delete.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCollectionInput) GoString 

func (s DeleteCollectionInput) GoString() string

GoString returns the string representation

func (*DeleteCollectionInput) SetCollectionId 

func (s *DeleteCollectionInput) SetCollectionId(v string) *DeleteCollectionInput

SetCollectionId sets the CollectionId field's value.

func (DeleteCollectionInput) String 

func (s DeleteCollectionInput) String() string

String returns the string representation

func (*DeleteCollectionInput) Validate 

func (s *DeleteCollectionInput) Validate() error

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

type DeleteCollectionOutput 

type DeleteCollectionOutput struct {

	// HTTP status code that indicates the result of the operation.
	StatusCode *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DeleteCollectionOutput) GoString 

func (s DeleteCollectionOutput) GoString() string

GoString returns the string representation

func (*DeleteCollectionOutput) SetStatusCode 

func (s *DeleteCollectionOutput) SetStatusCode(v int64) *DeleteCollectionOutput

SetStatusCode sets the StatusCode field's value.

func (DeleteCollectionOutput) String 

func (s DeleteCollectionOutput) String() string

String returns the string representation

type DeleteFacesInput 

type DeleteFacesInput struct {

	// Collection from which to remove the specific faces.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// An array of face IDs to delete.
	//
	// FaceIds is a required field
	FaceIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFacesInput) GoString 

func (s DeleteFacesInput) GoString() string

GoString returns the string representation

func (*DeleteFacesInput) SetCollectionId 

func (s *DeleteFacesInput) SetCollectionId(v string) *DeleteFacesInput

SetCollectionId sets the CollectionId field's value.

func (*DeleteFacesInput) SetFaceIds 

func (s *DeleteFacesInput) SetFaceIds(v []*string) *DeleteFacesInput

SetFaceIds sets the FaceIds field's value.

func (DeleteFacesInput) String 

func (s DeleteFacesInput) String() string

String returns the string representation

func (*DeleteFacesInput) Validate 

func (s *DeleteFacesInput) Validate() error

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

type DeleteFacesOutput 

type DeleteFacesOutput struct {

	// An array of strings (face IDs) of the faces that were deleted.
	DeletedFaces []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteFacesOutput) GoString 

func (s DeleteFacesOutput) GoString() string

GoString returns the string representation

func (*DeleteFacesOutput) SetDeletedFaces 

func (s *DeleteFacesOutput) SetDeletedFaces(v []*string) *DeleteFacesOutput

SetDeletedFaces sets the DeletedFaces field's value.

func (DeleteFacesOutput) String 

func (s DeleteFacesOutput) String() string

String returns the string representation

type DeleteStreamProcessorInput added in v1.12.36 

type DeleteStreamProcessorInput struct {

	// The name of the stream processor you want to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStreamProcessorInput) GoString added in v1.12.36 

func (s DeleteStreamProcessorInput) GoString() string

GoString returns the string representation

func (*DeleteStreamProcessorInput) SetName added in v1.12.36 

func (s *DeleteStreamProcessorInput) SetName(v string) *DeleteStreamProcessorInput

SetName sets the Name field's value.

func (DeleteStreamProcessorInput) String added in v1.12.36 

func (s DeleteStreamProcessorInput) String() string

String returns the string representation

func (*DeleteStreamProcessorInput) Validate added in v1.12.36 

func (s *DeleteStreamProcessorInput) Validate() error

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

type DeleteStreamProcessorOutput added in v1.12.36 

type DeleteStreamProcessorOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStreamProcessorOutput) GoString added in v1.12.36 

func (s DeleteStreamProcessorOutput) GoString() string

GoString returns the string representation

func (DeleteStreamProcessorOutput) String added in v1.12.36 

func (s DeleteStreamProcessorOutput) String() string

String returns the string representation

type DescribeStreamProcessorInput added in v1.12.36 

type DescribeStreamProcessorInput struct {

	// Name of the stream processor for which you want information.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStreamProcessorInput) GoString added in v1.12.36 

func (s DescribeStreamProcessorInput) GoString() string

GoString returns the string representation

func (*DescribeStreamProcessorInput) SetName added in v1.12.36 

func (s *DescribeStreamProcessorInput) SetName(v string) *DescribeStreamProcessorInput

SetName sets the Name field's value.

func (DescribeStreamProcessorInput) String added in v1.12.36 

func (s DescribeStreamProcessorInput) String() string

String returns the string representation

func (*DescribeStreamProcessorInput) Validate added in v1.12.36 

func (s *DescribeStreamProcessorInput) Validate() error

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

type DescribeStreamProcessorOutput added in v1.12.36 

type DescribeStreamProcessorOutput struct {

	// Date and time the stream processor was created
	CreationTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Kinesis video stream that provides the source streaming video.
	Input *StreamProcessorInput `type:"structure"`

	// The time, in Unix format, the stream processor was last updated. For example,
	// when the stream processor moves from a running state to a failed state, or
	// when the user starts or stops the stream processor.
	LastUpdateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Name of the stream processor.
	Name *string `min:"1" type:"string"`

	// Kinesis data stream to which Rekognition Video puts the analysis results.
	Output *StreamProcessorOutput `type:"structure"`

	// ARN of the IAM role that allows access to the stream processor.
	RoleArn *string `type:"string"`

	// Face recognition input parameters that are being used by the stream processor.
	// Includes the collection to use for face recognition and the face attributes
	// to detect.
	Settings *StreamProcessorSettings `type:"structure"`

	// Current status of the stream processor.
	Status *string `type:"string" enum:"StreamProcessorStatus"`

	// Detailed status message about the stream processor.
	StatusMessage *string `type:"string"`

	// ARN of the stream processor.
	StreamProcessorArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeStreamProcessorOutput) GoString added in v1.12.36 

func (s DescribeStreamProcessorOutput) GoString() string

GoString returns the string representation

func (*DescribeStreamProcessorOutput) SetCreationTimestamp added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetCreationTimestamp(v time.Time) *DescribeStreamProcessorOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeStreamProcessorOutput) SetInput added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetInput(v *StreamProcessorInput) *DescribeStreamProcessorOutput

SetInput sets the Input field's value.

func (*DescribeStreamProcessorOutput) SetLastUpdateTimestamp added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetLastUpdateTimestamp(v time.Time) *DescribeStreamProcessorOutput

SetLastUpdateTimestamp sets the LastUpdateTimestamp field's value.

func (*DescribeStreamProcessorOutput) SetName added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetName(v string) *DescribeStreamProcessorOutput

SetName sets the Name field's value.

func (*DescribeStreamProcessorOutput) SetOutput added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetOutput(v *StreamProcessorOutput) *DescribeStreamProcessorOutput

SetOutput sets the Output field's value.

func (*DescribeStreamProcessorOutput) SetRoleArn added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetRoleArn(v string) *DescribeStreamProcessorOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeStreamProcessorOutput) SetSettings added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetSettings(v *StreamProcessorSettings) *DescribeStreamProcessorOutput

SetSettings sets the Settings field's value.

func (*DescribeStreamProcessorOutput) SetStatus added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetStatus(v string) *DescribeStreamProcessorOutput

SetStatus sets the Status field's value.

func (*DescribeStreamProcessorOutput) SetStatusMessage added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetStatusMessage(v string) *DescribeStreamProcessorOutput

SetStatusMessage sets the StatusMessage field's value.

func (*DescribeStreamProcessorOutput) SetStreamProcessorArn added in v1.12.36 

func (s *DescribeStreamProcessorOutput) SetStreamProcessorArn(v string) *DescribeStreamProcessorOutput

SetStreamProcessorArn sets the StreamProcessorArn field's value.

func (DescribeStreamProcessorOutput) String added in v1.12.36 

func (s DescribeStreamProcessorOutput) String() string

String returns the string representation

type DetectFacesInput 

type DetectFacesInput struct {

	// An array of facial attributes you want to be returned. This can be the default
	// list of attributes or all attributes. If you don't specify a value for Attributes
	// or if you specify ["DEFAULT"], the API returns the following subset of facial
	// attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you
	// provide ["ALL"], all facial attributes are returned but the operation will
	// take longer to complete.
	//
	// If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator
	// to determine which attributes to return (in this case, all attributes).
	Attributes []*string `type:"list"`

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetectFacesInput) GoString 

func (s DetectFacesInput) GoString() string

GoString returns the string representation

func (*DetectFacesInput) SetAttributes 

func (s *DetectFacesInput) SetAttributes(v []*string) *DetectFacesInput

SetAttributes sets the Attributes field's value.

func (*DetectFacesInput) SetImage 

func (s *DetectFacesInput) SetImage(v *Image) *DetectFacesInput

SetImage sets the Image field's value.

func (DetectFacesInput) String 

func (s DetectFacesInput) String() string

String returns the string representation

func (*DetectFacesInput) Validate 

func (s *DetectFacesInput) Validate() error

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

type DetectFacesOutput 

type DetectFacesOutput struct {

	// Details of each face found in the image.
	FaceDetails []*FaceDetail `type:"list"`

	// The orientation of the input image (counter-clockwise direction). If your
	// application displays the image, you can use this value to correct image orientation.
	// The bounding box coordinates returned in FaceDetails represent face locations
	// before the image orientation is corrected.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// (Exif) metadata that includes the image's orientation. If so, and the Exif
	// metadata for the input image populates the orientation field, the value of
	// OrientationCorrection is null and the FaceDetails bounding box coordinates
	// represent face locations after Exif metadata is used to correct the image
	// orientation. Images in .png format don't contain Exif metadata.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`
	// contains filtered or unexported fields
}

func (DetectFacesOutput) GoString 

func (s DetectFacesOutput) GoString() string

GoString returns the string representation

func (*DetectFacesOutput) SetFaceDetails 

func (s *DetectFacesOutput) SetFaceDetails(v []*FaceDetail) *DetectFacesOutput

SetFaceDetails sets the FaceDetails field's value.

func (*DetectFacesOutput) SetOrientationCorrection 

func (s *DetectFacesOutput) SetOrientationCorrection(v string) *DetectFacesOutput

SetOrientationCorrection sets the OrientationCorrection field's value.

func (DetectFacesOutput) String 

func (s DetectFacesOutput) String() string

String returns the string representation

type DetectLabelsInput 

type DetectLabelsInput struct {

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

	// Maximum number of labels you want the service to return in the response.
	// The service returns the specified number of highest confidence labels.
	MaxLabels *int64 `type:"integer"`

	// Specifies the minimum confidence level for the labels to return. Amazon Rekognition
	// doesn't return any labels with confidence lower than this specified value.
	//
	// If MinConfidence is not specified, the operation returns labels with a confidence
	// values greater than or equal to 50 percent.
	MinConfidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (DetectLabelsInput) GoString 

func (s DetectLabelsInput) GoString() string

GoString returns the string representation

func (*DetectLabelsInput) SetImage 

func (s *DetectLabelsInput) SetImage(v *Image) *DetectLabelsInput

SetImage sets the Image field's value.

func (*DetectLabelsInput) SetMaxLabels 

func (s *DetectLabelsInput) SetMaxLabels(v int64) *DetectLabelsInput

SetMaxLabels sets the MaxLabels field's value.

func (*DetectLabelsInput) SetMinConfidence 

func (s *DetectLabelsInput) SetMinConfidence(v float64) *DetectLabelsInput

SetMinConfidence sets the MinConfidence field's value.

func (DetectLabelsInput) String 

func (s DetectLabelsInput) String() string

String returns the string representation

func (*DetectLabelsInput) Validate 

func (s *DetectLabelsInput) Validate() error

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

type DetectLabelsOutput 

type DetectLabelsOutput struct {

	// An array of labels for the real-world objects detected.
	Labels []*Label `type:"list"`

	// The orientation of the input image (counter-clockwise direction). If your
	// application displays the image, you can use this value to correct the orientation.
	// If Amazon Rekognition detects that the input image was rotated (for example,
	// by 90 degrees), it first corrects the orientation before detecting the labels.
	//
	// If the input image Exif metadata populates the orientation field, Amazon
	// Rekognition does not perform orientation correction and the value of OrientationCorrection
	// will be null.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`
	// contains filtered or unexported fields
}

func (DetectLabelsOutput) GoString 

func (s DetectLabelsOutput) GoString() string

GoString returns the string representation

func (*DetectLabelsOutput) SetLabels 

func (s *DetectLabelsOutput) SetLabels(v []*Label) *DetectLabelsOutput

SetLabels sets the Labels field's value.

func (*DetectLabelsOutput) SetOrientationCorrection 

func (s *DetectLabelsOutput) SetOrientationCorrection(v string) *DetectLabelsOutput

SetOrientationCorrection sets the OrientationCorrection field's value.

func (DetectLabelsOutput) String 

func (s DetectLabelsOutput) String() string

String returns the string representation

type DetectModerationLabelsInput added in v1.8.14 

type DetectModerationLabelsInput struct {

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

	// Specifies the minimum confidence level for the labels to return. Amazon Rekognition
	// doesn't return any labels with a confidence level lower than this specified
	// value.
	//
	// If you don't specify MinConfidence, the operation returns labels with confidence
	// values greater than or equal to 50 percent.
	MinConfidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (DetectModerationLabelsInput) GoString added in v1.8.14 

func (s DetectModerationLabelsInput) GoString() string

GoString returns the string representation

func (*DetectModerationLabelsInput) SetImage added in v1.8.14 

func (s *DetectModerationLabelsInput) SetImage(v *Image) *DetectModerationLabelsInput

SetImage sets the Image field's value.

func (*DetectModerationLabelsInput) SetMinConfidence added in v1.8.14 

func (s *DetectModerationLabelsInput) SetMinConfidence(v float64) *DetectModerationLabelsInput

SetMinConfidence sets the MinConfidence field's value.

func (DetectModerationLabelsInput) String added in v1.8.14 

func (s DetectModerationLabelsInput) String() string

String returns the string representation

func (*DetectModerationLabelsInput) Validate added in v1.8.14 

func (s *DetectModerationLabelsInput) Validate() error

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

type DetectModerationLabelsOutput added in v1.8.14 

type DetectModerationLabelsOutput struct {

	// Array of detected Moderation labels and the time, in millseconds from the
	// start of the video, they were detected.
	ModerationLabels []*ModerationLabel `type:"list"`
	// contains filtered or unexported fields
}

func (DetectModerationLabelsOutput) GoString added in v1.8.14 

func (s DetectModerationLabelsOutput) GoString() string

GoString returns the string representation

func (*DetectModerationLabelsOutput) SetModerationLabels added in v1.8.14 

func (s *DetectModerationLabelsOutput) SetModerationLabels(v []*ModerationLabel) *DetectModerationLabelsOutput

SetModerationLabels sets the ModerationLabels field's value.

func (DetectModerationLabelsOutput) String added in v1.8.14 

func (s DetectModerationLabelsOutput) String() string

String returns the string representation

type DetectTextInput added in v1.12.32 

type DetectTextInput struct {

	// The input image as base64-encoded bytes or an Amazon S3 object. If you use
	// the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetectTextInput) GoString added in v1.12.32 

func (s DetectTextInput) GoString() string

GoString returns the string representation

func (*DetectTextInput) SetImage added in v1.12.32 

func (s *DetectTextInput) SetImage(v *Image) *DetectTextInput

SetImage sets the Image field's value.

func (DetectTextInput) String added in v1.12.32 

func (s DetectTextInput) String() string

String returns the string representation

func (*DetectTextInput) Validate added in v1.12.32 

func (s *DetectTextInput) Validate() error

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

type DetectTextOutput added in v1.12.32 

type DetectTextOutput struct {

	// An array of text that was detected in the input image.
	TextDetections []*TextDetection `type:"list"`
	// contains filtered or unexported fields
}

func (DetectTextOutput) GoString added in v1.12.32 

func (s DetectTextOutput) GoString() string

GoString returns the string representation

func (*DetectTextOutput) SetTextDetections added in v1.12.32 

func (s *DetectTextOutput) SetTextDetections(v []*TextDetection) *DetectTextOutput

SetTextDetections sets the TextDetections field's value.

func (DetectTextOutput) String added in v1.12.32 

func (s DetectTextOutput) String() string

String returns the string representation

type Emotion 

type Emotion struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Type of emotion detected.
	Type *string `type:"string" enum:"EmotionName"`
	// contains filtered or unexported fields
}

The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

func (Emotion) GoString 

func (s Emotion) GoString() string

GoString returns the string representation

func (*Emotion) SetConfidence 

func (s *Emotion) SetConfidence(v float64) *Emotion

SetConfidence sets the Confidence field's value.

func (*Emotion) SetType 

func (s *Emotion) SetType(v string) *Emotion

SetType sets the Type field's value.

func (Emotion) String 

func (s Emotion) String() string

String returns the string representation

type EyeOpen 

type EyeOpen struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the eyes on the face are open.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

func (EyeOpen) GoString 

func (s EyeOpen) GoString() string

GoString returns the string representation

func (*EyeOpen) SetConfidence 

func (s *EyeOpen) SetConfidence(v float64) *EyeOpen

SetConfidence sets the Confidence field's value.

func (*EyeOpen) SetValue 

func (s *EyeOpen) SetValue(v bool) *EyeOpen

SetValue sets the Value field's value.

func (EyeOpen) String 

func (s EyeOpen) String() string

String returns the string representation

type Eyeglasses 

type Eyeglasses struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the face is wearing eye glasses or not.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

func (Eyeglasses) GoString 

func (s Eyeglasses) GoString() string

GoString returns the string representation

func (*Eyeglasses) SetConfidence 

func (s *Eyeglasses) SetConfidence(v float64) *Eyeglasses

SetConfidence sets the Confidence field's value.

func (*Eyeglasses) SetValue 

func (s *Eyeglasses) SetValue(v bool) *Eyeglasses

SetValue sets the Value field's value.

func (Eyeglasses) String 

func (s Eyeglasses) String() string

String returns the string representation

type Face 

type Face struct {

	// Bounding box of the face.
	BoundingBox *BoundingBox `type:"structure"`

	// Confidence level that the bounding box contains a face (and not a different
	// object such as a tree).
	Confidence *float64 `type:"float"`

	// Identifier that you assign to all the faces in the input image.
	ExternalImageId *string `min:"1" type:"string"`

	// Unique identifier that Amazon Rekognition assigns to the face.
	FaceId *string `type:"string"`

	// Unique identifier that Amazon Rekognition assigns to the input image.
	ImageId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

func (Face) GoString 

func (s Face) GoString() string

GoString returns the string representation

func (*Face) SetBoundingBox 

func (s *Face) SetBoundingBox(v *BoundingBox) *Face

SetBoundingBox sets the BoundingBox field's value.

func (*Face) SetConfidence 

func (s *Face) SetConfidence(v float64) *Face

SetConfidence sets the Confidence field's value.

func (*Face) SetExternalImageId 

func (s *Face) SetExternalImageId(v string) *Face

SetExternalImageId sets the ExternalImageId field's value.

func (*Face) SetFaceId 

func (s *Face) SetFaceId(v string) *Face

SetFaceId sets the FaceId field's value.

func (*Face) SetImageId 

func (s *Face) SetImageId(v string) *Face

SetImageId sets the ImageId field's value.

func (Face) String 

func (s Face) String() string

String returns the string representation

type FaceDetail 

type FaceDetail struct {

	// The estimated age range, in years, for the face. Low represents the lowest
	// estimated age and High represents the highest estimated age.
	AgeRange *AgeRange `type:"structure"`

	// Indicates whether or not the face has a beard, and the confidence level in
	// the determination.
	Beard *Beard `type:"structure"`

	// Bounding box of the face. Default attribute.
	BoundingBox *BoundingBox `type:"structure"`

	// Confidence level that the bounding box contains a face (and not a different
	// object such as a tree). Default attribute.
	Confidence *float64 `type:"float"`

	// The emotions detected on the face, and the confidence level in the determination.
	// For example, HAPPY, SAD, and ANGRY.
	Emotions []*Emotion `type:"list"`

	// Indicates whether or not the face is wearing eye glasses, and the confidence
	// level in the determination.
	Eyeglasses *Eyeglasses `type:"structure"`

	// Indicates whether or not the eyes on the face are open, and the confidence
	// level in the determination.
	EyesOpen *EyeOpen `type:"structure"`

	// Gender of the face and the confidence level in the determination.
	Gender *Gender `type:"structure"`

	// Indicates the location of landmarks on the face. Default attribute.
	Landmarks []*Landmark `type:"list"`

	// Indicates whether or not the mouth on the face is open, and the confidence
	// level in the determination.
	MouthOpen *MouthOpen `type:"structure"`

	// Indicates whether or not the face has a mustache, and the confidence level
	// in the determination.
	Mustache *Mustache `type:"structure"`

	// Indicates the pose of the face as determined by its pitch, roll, and yaw.
	// Default attribute.
	Pose *Pose `type:"structure"`

	// Identifies image brightness and sharpness. Default attribute.
	Quality *ImageQuality `type:"structure"`

	// Indicates whether or not the face is smiling, and the confidence level in
	// the determination.
	Smile *Smile `type:"structure"`

	// Indicates whether or not the face is wearing sunglasses, and the confidence
	// level in the determination.
	Sunglasses *Sunglasses `type:"structure"`
	// contains filtered or unexported fields
}

Structure containing attributes of the face that the algorithm detected.

A FaceDetail object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox, Confidence, Landmarks, Pose, and Quality.

is the only Rekognition Video stored video operation that can return a FaceDetail object with all attributes. To specify which attributes to return, use the FaceAttributes input parameter for . The following Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes input parameter.

  • GetCelebrityRecognition

  • GetPersonTracking

  • GetFaceSearch

The Rekognition Image and operations can return all facial attributes. To specify which attributes to return, use the Attributes input parameter for DetectFaces. For IndexFaces, use the DetectAttributes input parameter.

func (FaceDetail) GoString 

func (s FaceDetail) GoString() string

GoString returns the string representation

func (*FaceDetail) SetAgeRange added in v1.6.20 

func (s *FaceDetail) SetAgeRange(v *AgeRange) *FaceDetail

SetAgeRange sets the AgeRange field's value.

func (*FaceDetail) SetBeard 

func (s *FaceDetail) SetBeard(v *Beard) *FaceDetail

SetBeard sets the Beard field's value.

func (*FaceDetail) SetBoundingBox 

func (s *FaceDetail) SetBoundingBox(v *BoundingBox) *FaceDetail

SetBoundingBox sets the BoundingBox field's value.

func (*FaceDetail) SetConfidence 

func (s *FaceDetail) SetConfidence(v float64) *FaceDetail

SetConfidence sets the Confidence field's value.

func (*FaceDetail) SetEmotions 

func (s *FaceDetail) SetEmotions(v []*Emotion) *FaceDetail

SetEmotions sets the Emotions field's value.

func (*FaceDetail) SetEyeglasses 

func (s *FaceDetail) SetEyeglasses(v *Eyeglasses) *FaceDetail

SetEyeglasses sets the Eyeglasses field's value.

func (*FaceDetail) SetEyesOpen 

func (s *FaceDetail) SetEyesOpen(v *EyeOpen) *FaceDetail

SetEyesOpen sets the EyesOpen field's value.

func (*FaceDetail) SetGender 

func (s *FaceDetail) SetGender(v *Gender) *FaceDetail

SetGender sets the Gender field's value.

func (*FaceDetail) SetLandmarks 

func (s *FaceDetail) SetLandmarks(v []*Landmark) *FaceDetail

SetLandmarks sets the Landmarks field's value.

func (*FaceDetail) SetMouthOpen 

func (s *FaceDetail) SetMouthOpen(v *MouthOpen) *FaceDetail

SetMouthOpen sets the MouthOpen field's value.

func (*FaceDetail) SetMustache 

func (s *FaceDetail) SetMustache(v *Mustache) *FaceDetail

SetMustache sets the Mustache field's value.

func (*FaceDetail) SetPose 

func (s *FaceDetail) SetPose(v *Pose) *FaceDetail

SetPose sets the Pose field's value.

func (*FaceDetail) SetQuality 

func (s *FaceDetail) SetQuality(v *ImageQuality) *FaceDetail

SetQuality sets the Quality field's value.

func (*FaceDetail) SetSmile 

func (s *FaceDetail) SetSmile(v *Smile) *FaceDetail

SetSmile sets the Smile field's value.

func (*FaceDetail) SetSunglasses 

func (s *FaceDetail) SetSunglasses(v *Sunglasses) *FaceDetail

SetSunglasses sets the Sunglasses field's value.

func (FaceDetail) String 

func (s FaceDetail) String() string

String returns the string representation

type FaceDetection added in v1.12.36 

type FaceDetection struct {

	// The face properties for the detected face.
	Face *FaceDetail `type:"structure"`

	// Time, in milliseconds from the start of the video, that the face was detected.
	Timestamp *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a face detected in a video analysis request and the time the face was detected in the video.

func (FaceDetection) GoString added in v1.12.36 

func (s FaceDetection) GoString() string

GoString returns the string representation

func (*FaceDetection) SetFace added in v1.12.36 

func (s *FaceDetection) SetFace(v *FaceDetail) *FaceDetection

SetFace sets the Face field's value.

func (*FaceDetection) SetTimestamp added in v1.12.36 

func (s *FaceDetection) SetTimestamp(v int64) *FaceDetection

SetTimestamp sets the Timestamp field's value.

func (FaceDetection) String added in v1.12.36 

func (s FaceDetection) String() string

String returns the string representation

type FaceMatch 

type FaceMatch struct {

	// Describes the face properties such as the bounding box, face ID, image ID
	// of the source image, and external image ID that you assigned.
	Face *Face `type:"structure"`

	// Confidence in the match of this face with the input face.
	Similarity *float64 `type:"float"`
	// contains filtered or unexported fields
}

Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

func (FaceMatch) GoString 

func (s FaceMatch) GoString() string

GoString returns the string representation

func (*FaceMatch) SetFace 

func (s *FaceMatch) SetFace(v *Face) *FaceMatch

SetFace sets the Face field's value.

func (*FaceMatch) SetSimilarity 

func (s *FaceMatch) SetSimilarity(v float64) *FaceMatch

SetSimilarity sets the Similarity field's value.

func (FaceMatch) String 

func (s FaceMatch) String() string

String returns the string representation

type FaceRecord 

type FaceRecord struct {

	// Describes the face properties such as the bounding box, face ID, image ID
	// of the input image, and external image ID that you assigned.
	Face *Face `type:"structure"`

	// Structure containing attributes of the face that the algorithm detected.
	FaceDetail *FaceDetail `type:"structure"`
	// contains filtered or unexported fields
}

Object containing both the face metadata (stored in the back-end database) and facial attributes that are detected but aren't stored in the database.

func (FaceRecord) GoString 

func (s FaceRecord) GoString() string

GoString returns the string representation

func (*FaceRecord) SetFace 

func (s *FaceRecord) SetFace(v *Face) *FaceRecord

SetFace sets the Face field's value.

func (*FaceRecord) SetFaceDetail 

func (s *FaceRecord) SetFaceDetail(v *FaceDetail) *FaceRecord

SetFaceDetail sets the FaceDetail field's value.

func (FaceRecord) String 

func (s FaceRecord) String() string

String returns the string representation

type FaceSearchSettings added in v1.12.36 

type FaceSearchSettings struct {

	// The ID of a collection that contains faces that you want to search for.
	CollectionId *string `min:"1" type:"string"`

	// Minimum face match confidence score that must be met to return a result for
	// a recognized face. Default is 70. 0 is the lowest confidence. 100 is the
	// highest confidence.
	FaceMatchThreshold *float64 `type:"float"`
	// contains filtered or unexported fields
}

Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings is a request parameter for .

func (FaceSearchSettings) GoString added in v1.12.36 

func (s FaceSearchSettings) GoString() string

GoString returns the string representation

func (*FaceSearchSettings) SetCollectionId added in v1.12.36 

func (s *FaceSearchSettings) SetCollectionId(v string) *FaceSearchSettings

SetCollectionId sets the CollectionId field's value.

func (*FaceSearchSettings) SetFaceMatchThreshold added in v1.12.36 

func (s *FaceSearchSettings) SetFaceMatchThreshold(v float64) *FaceSearchSettings

SetFaceMatchThreshold sets the FaceMatchThreshold field's value.

func (FaceSearchSettings) String added in v1.12.36 

func (s FaceSearchSettings) String() string

String returns the string representation

func (*FaceSearchSettings) Validate added in v1.12.36 

func (s *FaceSearchSettings) Validate() error

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

type Gender 

type Gender struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Gender of the face.
	Value *string `type:"string" enum:"GenderType"`
	// contains filtered or unexported fields
}

Gender of the face and the confidence level in the determination.

func (Gender) GoString 

func (s Gender) GoString() string

GoString returns the string representation

func (*Gender) SetConfidence 

func (s *Gender) SetConfidence(v float64) *Gender

SetConfidence sets the Confidence field's value.

func (*Gender) SetValue 

func (s *Gender) SetValue(v string) *Gender

SetValue sets the Value field's value.

func (Gender) String 

func (s Gender) String() string

String returns the string representation

type Geometry added in v1.12.32 

type Geometry struct {

	// An axis-aligned coarse representation of the detected text's location on
	// the image.
	BoundingBox *BoundingBox `type:"structure"`

	// Within the bounding box, a fine-grained polygon around the detected text.
	Polygon []*Point `type:"list"`
	// contains filtered or unexported fields
}

Information about where text detected by is located on an image.

func (Geometry) GoString added in v1.12.32 

func (s Geometry) GoString() string

GoString returns the string representation

func (*Geometry) SetBoundingBox added in v1.12.32 

func (s *Geometry) SetBoundingBox(v *BoundingBox) *Geometry

SetBoundingBox sets the BoundingBox field's value.

func (*Geometry) SetPolygon added in v1.12.32 

func (s *Geometry) SetPolygon(v []*Point) *Geometry

SetPolygon sets the Polygon field's value.

func (Geometry) String added in v1.12.32 

func (s Geometry) String() string

String returns the string representation

type GetCelebrityInfoInput added in v1.8.38 

type GetCelebrityInfoInput struct {

	// The ID for the celebrity. You get the celebrity ID from a call to the operation,
	// which recognizes celebrities in an image.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCelebrityInfoInput) GoString added in v1.8.38 

func (s GetCelebrityInfoInput) GoString() string

GoString returns the string representation

func (*GetCelebrityInfoInput) SetId added in v1.8.38 

func (s *GetCelebrityInfoInput) SetId(v string) *GetCelebrityInfoInput

SetId sets the Id field's value.

func (GetCelebrityInfoInput) String added in v1.8.38 

func (s GetCelebrityInfoInput) String() string

String returns the string representation

func (*GetCelebrityInfoInput) Validate added in v1.8.38 

func (s *GetCelebrityInfoInput) Validate() error

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

type GetCelebrityInfoOutput added in v1.8.38 

type GetCelebrityInfoOutput struct {

	// The name of the celebrity.
	Name *string `type:"string"`

	// An array of URLs pointing to additional celebrity information.
	Urls []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetCelebrityInfoOutput) GoString added in v1.8.38 

func (s GetCelebrityInfoOutput) GoString() string

GoString returns the string representation

func (*GetCelebrityInfoOutput) SetName added in v1.8.38 

func (s *GetCelebrityInfoOutput) SetName(v string) *GetCelebrityInfoOutput

SetName sets the Name field's value.

func (*GetCelebrityInfoOutput) SetUrls added in v1.8.38 

func (s *GetCelebrityInfoOutput) SetUrls(v []*string) *GetCelebrityInfoOutput

SetUrls sets the Urls field's value.

func (GetCelebrityInfoOutput) String added in v1.8.38 

func (s GetCelebrityInfoOutput) String() string

String returns the string representation

type GetCelebrityRecognitionInput added in v1.12.36 

type GetCelebrityRecognitionInput struct {

	// Job identifier for the required celebrity recognition analysis. You can get
	// the job identifer from a call to StartCelebrityRecognition.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000. If you specify a value greater than 1000, a maximum
	// of 1000 results is returned. The default value is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more recognized
	// celebrities to retrieve), Rekognition Video returns a pagination token in
	// the response. You can use this pagination token to retrieve the next set
	// of celebrities.
	NextToken *string `type:"string"`

	// Sort to use for celebrities returned in Celebrities field. Specify ID to
	// sort by the celebrity identifier, specify TIMESTAMP to sort by the time the
	// celebrity was recognized.
	SortBy *string `type:"string" enum:"CelebrityRecognitionSortBy"`
	// contains filtered or unexported fields
}

func (GetCelebrityRecognitionInput) GoString added in v1.12.36 

func (s GetCelebrityRecognitionInput) GoString() string

GoString returns the string representation

func (*GetCelebrityRecognitionInput) SetJobId added in v1.12.36 

func (s *GetCelebrityRecognitionInput) SetJobId(v string) *GetCelebrityRecognitionInput

SetJobId sets the JobId field's value.

func (*GetCelebrityRecognitionInput) SetMaxResults added in v1.12.36 

func (s *GetCelebrityRecognitionInput) SetMaxResults(v int64) *GetCelebrityRecognitionInput

SetMaxResults sets the MaxResults field's value.

func (*GetCelebrityRecognitionInput) SetNextToken added in v1.12.36 

func (s *GetCelebrityRecognitionInput) SetNextToken(v string) *GetCelebrityRecognitionInput

SetNextToken sets the NextToken field's value.

func (*GetCelebrityRecognitionInput) SetSortBy added in v1.12.36 

func (s *GetCelebrityRecognitionInput) SetSortBy(v string) *GetCelebrityRecognitionInput

SetSortBy sets the SortBy field's value.

func (GetCelebrityRecognitionInput) String added in v1.12.36 

func (s GetCelebrityRecognitionInput) String() string

String returns the string representation

func (*GetCelebrityRecognitionInput) Validate added in v1.12.36 

func (s *GetCelebrityRecognitionInput) Validate() error

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

type GetCelebrityRecognitionOutput added in v1.12.36 

type GetCelebrityRecognitionOutput struct {

	// Array of celebrities recognized in the video.
	Celebrities []*CelebrityRecognition `type:"list"`

	// The current status of the celebrity recognition job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

	// If the response is truncated, Rekognition Video returns this token that you
	// can use in the subsequent request to retrieve the next set of celebrities.
	NextToken *string `type:"string"`

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string `type:"string"`

	// Information about a video that Rekognition Video analyzed. Videometadata
	// is returned in every page of paginated responses from a Rekognition Video
	// operation.
	VideoMetadata *VideoMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetCelebrityRecognitionOutput) GoString added in v1.12.36 

func (s GetCelebrityRecognitionOutput) GoString() string

GoString returns the string representation

func (*GetCelebrityRecognitionOutput) SetCelebrities added in v1.12.36 

func (s *GetCelebrityRecognitionOutput) SetCelebrities(v []*CelebrityRecognition) *GetCelebrityRecognitionOutput

SetCelebrities sets the Celebrities field's value.

func (*GetCelebrityRecognitionOutput) SetJobStatus added in v1.12.36 

func (s *GetCelebrityRecognitionOutput) SetJobStatus(v string) *GetCelebrityRecognitionOutput

SetJobStatus sets the JobStatus field's value.

func (*GetCelebrityRecognitionOutput) SetNextToken added in v1.12.36 

func (s *GetCelebrityRecognitionOutput) SetNextToken(v string) *GetCelebrityRecognitionOutput

SetNextToken sets the NextToken field's value.

func (*GetCelebrityRecognitionOutput) SetStatusMessage added in v1.12.36 

func (s *GetCelebrityRecognitionOutput) SetStatusMessage(v string) *GetCelebrityRecognitionOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetCelebrityRecognitionOutput) SetVideoMetadata added in v1.12.36 

func (s *GetCelebrityRecognitionOutput) SetVideoMetadata(v *VideoMetadata) *GetCelebrityRecognitionOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetCelebrityRecognitionOutput) String added in v1.12.36 

func (s GetCelebrityRecognitionOutput) String() string

String returns the string representation

type GetContentModerationInput added in v1.12.36 

type GetContentModerationInput struct {

	// The identifier for the content moderation job. Use JobId to identify the
	// job in a subsequent call to GetContentModeration.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000. If you specify a value greater than 1000, a maximum
	// of 1000 results is returned. The default value is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Rekognition returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of content moderation labels.
	NextToken *string `type:"string"`

	// Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP
	// to sort array elements by the time labels are detected. Use NAME to alphabetically
	// group elements for a label together. Within each label group, the array element
	// are sorted by detection confidence. The default sort is by TIMESTAMP.
	SortBy *string `type:"string" enum:"ContentModerationSortBy"`
	// contains filtered or unexported fields
}

func (GetContentModerationInput) GoString added in v1.12.36 

func (s GetContentModerationInput) GoString() string

GoString returns the string representation

func (*GetContentModerationInput) SetJobId added in v1.12.36 

func (s *GetContentModerationInput) SetJobId(v string) *GetContentModerationInput

SetJobId sets the JobId field's value.

func (*GetContentModerationInput) SetMaxResults added in v1.12.36 

func (s *GetContentModerationInput) SetMaxResults(v int64) *GetContentModerationInput

SetMaxResults sets the MaxResults field's value.

func (*GetContentModerationInput) SetNextToken added in v1.12.36 

func (s *GetContentModerationInput) SetNextToken(v string) *GetContentModerationInput

SetNextToken sets the NextToken field's value.

func (*GetContentModerationInput) SetSortBy added in v1.12.36 

func (s *GetContentModerationInput) SetSortBy(v string) *GetContentModerationInput

SetSortBy sets the SortBy field's value.

func (GetContentModerationInput) String added in v1.12.36 

func (s GetContentModerationInput) String() string

String returns the string representation

func (*GetContentModerationInput) Validate added in v1.12.36 

func (s *GetContentModerationInput) Validate() error

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

type GetContentModerationOutput added in v1.12.36 

type GetContentModerationOutput struct {

	// The current status of the content moderation job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

	// The detected moderation labels and the time(s) they were detected.
	ModerationLabels []*ContentModerationDetection `type:"list"`

	// If the response is truncated, Rekognition Video returns this token that you
	// can use in the subsequent request to retrieve the next set of moderation
	// labels.
	NextToken *string `type:"string"`

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string `type:"string"`

	// Information about a video that Amazon Rekognition analyzed. Videometadata
	// is returned in every page of paginated responses from GetContentModeration.
	VideoMetadata *VideoMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetContentModerationOutput) GoString added in v1.12.36 

func (s GetContentModerationOutput) GoString() string

GoString returns the string representation

func (*GetContentModerationOutput) SetJobStatus added in v1.12.36 

func (s *GetContentModerationOutput) SetJobStatus(v string) *GetContentModerationOutput

SetJobStatus sets the JobStatus field's value.

func (*GetContentModerationOutput) SetModerationLabels added in v1.12.36 

func (s *GetContentModerationOutput) SetModerationLabels(v []*ContentModerationDetection) *GetContentModerationOutput

SetModerationLabels sets the ModerationLabels field's value.

func (*GetContentModerationOutput) SetNextToken added in v1.12.36 

func (s *GetContentModerationOutput) SetNextToken(v string) *GetContentModerationOutput

SetNextToken sets the NextToken field's value.

func (*GetContentModerationOutput) SetStatusMessage added in v1.12.36 

func (s *GetContentModerationOutput) SetStatusMessage(v string) *GetContentModerationOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetContentModerationOutput) SetVideoMetadata added in v1.12.36 

func (s *GetContentModerationOutput) SetVideoMetadata(v *VideoMetadata) *GetContentModerationOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetContentModerationOutput) String added in v1.12.36 

func (s GetContentModerationOutput) String() string

String returns the string representation

type GetFaceDetectionInput added in v1.12.36 

type GetFaceDetectionInput struct {

	// Unique identifier for the face detection job. The JobId is returned from
	// StartFaceDetection.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000. If you specify a value greater than 1000, a maximum
	// of 1000 results is returned. The default value is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there are more faces to
	// retrieve), Rekognition Video returns a pagination token in the response.
	// You can use this pagination token to retrieve the next set of faces.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetFaceDetectionInput) GoString added in v1.12.36 

func (s GetFaceDetectionInput) GoString() string

GoString returns the string representation

func (*GetFaceDetectionInput) SetJobId added in v1.12.36 

func (s *GetFaceDetectionInput) SetJobId(v string) *GetFaceDetectionInput

SetJobId sets the JobId field's value.

func (*GetFaceDetectionInput) SetMaxResults added in v1.12.36 

func (s *GetFaceDetectionInput) SetMaxResults(v int64) *GetFaceDetectionInput

SetMaxResults sets the MaxResults field's value.

func (*GetFaceDetectionInput) SetNextToken added in v1.12.36 

func (s *GetFaceDetectionInput) SetNextToken(v string) *GetFaceDetectionInput

SetNextToken sets the NextToken field's value.

func (GetFaceDetectionInput) String added in v1.12.36 

func (s GetFaceDetectionInput) String() string

String returns the string representation

func (*GetFaceDetectionInput) Validate added in v1.12.36 

func (s *GetFaceDetectionInput) Validate() error

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

type GetFaceDetectionOutput added in v1.12.36 

type GetFaceDetectionOutput struct {

	// An array of faces detected in the video. Each element contains a detected
	// face's details and the time, in milliseconds from the start of the video,
	// the face was detected.
	Faces []*FaceDetection `type:"list"`

	// The current status of the face detection job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

	// If the response is truncated, Amazon Rekognition returns this token that
	// you can use in the subsequent request to retrieve the next set of faces.
	NextToken *string `type:"string"`

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string `type:"string"`

	// Information about a video that Rekognition Video analyzed. Videometadata
	// is returned in every page of paginated responses from a Amazon Rekognition
	// video operation.
	VideoMetadata *VideoMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetFaceDetectionOutput) GoString added in v1.12.36 

func (s GetFaceDetectionOutput) GoString() string

GoString returns the string representation

func (*GetFaceDetectionOutput) SetFaces added in v1.12.36 

func (s *GetFaceDetectionOutput) SetFaces(v []*FaceDetection) *GetFaceDetectionOutput

SetFaces sets the Faces field's value.

func (*GetFaceDetectionOutput) SetJobStatus added in v1.12.36 

func (s *GetFaceDetectionOutput) SetJobStatus(v string) *GetFaceDetectionOutput

SetJobStatus sets the JobStatus field's value.

func (*GetFaceDetectionOutput) SetNextToken added in v1.12.36 

func (s *GetFaceDetectionOutput) SetNextToken(v string) *GetFaceDetectionOutput

SetNextToken sets the NextToken field's value.

func (*GetFaceDetectionOutput) SetStatusMessage added in v1.12.36 

func (s *GetFaceDetectionOutput) SetStatusMessage(v string) *GetFaceDetectionOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetFaceDetectionOutput) SetVideoMetadata added in v1.12.36 

func (s *GetFaceDetectionOutput) SetVideoMetadata(v *VideoMetadata) *GetFaceDetectionOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetFaceDetectionOutput) String added in v1.12.36 

func (s GetFaceDetectionOutput) String() string

String returns the string representation

type GetFaceSearchInput added in v1.12.36 

type GetFaceSearchInput struct {

	// The job identifer for the search request. You get the job identifier from
	// an initial call to StartFaceSearch.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000. If you specify a value greater than 1000, a maximum
	// of 1000 results is returned. The default value is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more search results
	// to retrieve), Rekognition Video returns a pagination token in the response.
	// You can use this pagination token to retrieve the next set of search results.
	NextToken *string `type:"string"`

	// Sort to use for grouping faces in the response. Use TIMESTAMP to group faces
	// by the time that they are recognized. Use INDEX to sort by recognized faces.
	SortBy *string `type:"string" enum:"FaceSearchSortBy"`
	// contains filtered or unexported fields
}

func (GetFaceSearchInput) GoString added in v1.12.36 

func (s GetFaceSearchInput) GoString() string

GoString returns the string representation

func (*GetFaceSearchInput) SetJobId added in v1.12.36 

func (s *GetFaceSearchInput) SetJobId(v string) *GetFaceSearchInput

SetJobId sets the JobId field's value.

func (*GetFaceSearchInput) SetMaxResults added in v1.12.36 

func (s *GetFaceSearchInput) SetMaxResults(v int64) *GetFaceSearchInput

SetMaxResults sets the MaxResults field's value.

func (*GetFaceSearchInput) SetNextToken added in v1.12.36 

func (s *GetFaceSearchInput) SetNextToken(v string) *GetFaceSearchInput

SetNextToken sets the NextToken field's value.

func (*GetFaceSearchInput) SetSortBy added in v1.12.36 

func (s *GetFaceSearchInput) SetSortBy(v string) *GetFaceSearchInput

SetSortBy sets the SortBy field's value.

func (GetFaceSearchInput) String added in v1.12.36 

func (s GetFaceSearchInput) String() string

String returns the string representation

func (*GetFaceSearchInput) Validate added in v1.12.36 

func (s *GetFaceSearchInput) Validate() error

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

type GetFaceSearchOutput added in v1.12.36 

type GetFaceSearchOutput struct {

	// The current status of the face search job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

	// If the response is truncated, Rekognition Video returns this token that you
	// can use in the subsequent request to retrieve the next set of search results.
	NextToken *string `type:"string"`

	// An array of persons, , in the video whose face(s) match the face(s) in an
	// Amazon Rekognition collection. It also includes time information for when
	// persons are matched in the video. You specify the input collection in an
	// initial call to StartFaceSearch. Each Persons element includes a time the
	// person was matched, face match details (FaceMatches) for matching faces in
	// the collection, and person information (Person) for the matched person.
	Persons []*PersonMatch `type:"list"`

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string `type:"string"`

	// Information about a video that Amazon Rekognition analyzed. Videometadata
	// is returned in every page of paginated responses from a Rekognition Video
	// operation.
	VideoMetadata *VideoMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetFaceSearchOutput) GoString added in v1.12.36 

func (s GetFaceSearchOutput) GoString() string

GoString returns the string representation

func (*GetFaceSearchOutput) SetJobStatus added in v1.12.36 

func (s *GetFaceSearchOutput) SetJobStatus(v string) *GetFaceSearchOutput

SetJobStatus sets the JobStatus field's value.

func (*GetFaceSearchOutput) SetNextToken added in v1.12.36 

func (s *GetFaceSearchOutput) SetNextToken(v string) *GetFaceSearchOutput

SetNextToken sets the NextToken field's value.

func (*GetFaceSearchOutput) SetPersons added in v1.12.36 

func (s *GetFaceSearchOutput) SetPersons(v []*PersonMatch) *GetFaceSearchOutput

SetPersons sets the Persons field's value.

func (*GetFaceSearchOutput) SetStatusMessage added in v1.12.36 

func (s *GetFaceSearchOutput) SetStatusMessage(v string) *GetFaceSearchOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetFaceSearchOutput) SetVideoMetadata added in v1.12.36 

func (s *GetFaceSearchOutput) SetVideoMetadata(v *VideoMetadata) *GetFaceSearchOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetFaceSearchOutput) String added in v1.12.36 

func (s GetFaceSearchOutput) String() string

String returns the string representation

type GetLabelDetectionInput added in v1.12.36 

type GetLabelDetectionInput struct {

	// Job identifier for the label detection operation for which you want results
	// returned. You get the job identifer from an initial call to StartlabelDetection.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000. If you specify a value greater than 1000, a maximum
	// of 1000 results is returned. The default value is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there are more labels to
	// retrieve), Rekognition Video returns a pagination token in the response.
	// You can use this pagination token to retrieve the next set of labels.
	NextToken *string `type:"string"`

	// Sort to use for elements in the Labels array. Use TIMESTAMP to sort array
	// elements by the time labels are detected. Use NAME to alphabetically group
	// elements for a label together. Within each label group, the array element
	// are sorted by detection confidence. The default sort is by TIMESTAMP.
	SortBy *string `type:"string" enum:"LabelDetectionSortBy"`
	// contains filtered or unexported fields
}

func (GetLabelDetectionInput) GoString added in v1.12.36 

func (s GetLabelDetectionInput) GoString() string

GoString returns the string representation

func (*GetLabelDetectionInput) SetJobId added in v1.12.36 

func (s *GetLabelDetectionInput) SetJobId(v string) *GetLabelDetectionInput

SetJobId sets the JobId field's value.

func (*GetLabelDetectionInput) SetMaxResults added in v1.12.36 

func (s *GetLabelDetectionInput) SetMaxResults(v int64) *GetLabelDetectionInput

SetMaxResults sets the MaxResults field's value.

func (*GetLabelDetectionInput) SetNextToken added in v1.12.36 

func (s *GetLabelDetectionInput) SetNextToken(v string) *GetLabelDetectionInput

SetNextToken sets the NextToken field's value.

func (*GetLabelDetectionInput) SetSortBy added in v1.12.36 

func (s *GetLabelDetectionInput) SetSortBy(v string) *GetLabelDetectionInput

SetSortBy sets the SortBy field's value.

func (GetLabelDetectionInput) String added in v1.12.36 

func (s GetLabelDetectionInput) String() string

String returns the string representation

func (*GetLabelDetectionInput) Validate added in v1.12.36 

func (s *GetLabelDetectionInput) Validate() error

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

type GetLabelDetectionOutput added in v1.12.36 

type GetLabelDetectionOutput struct {

	// The current status of the label detection job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

	// An array of labels detected in the video. Each element contains the detected
	// label and the time, in milliseconds from the start of the video, that the
	// label was detected.
	Labels []*LabelDetection `type:"list"`

	// If the response is truncated, Rekognition Video returns this token that you
	// can use in the subsequent request to retrieve the next set of labels.
	NextToken *string `type:"string"`

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string `type:"string"`

	// Information about a video that Rekognition Video analyzed. Videometadata
	// is returned in every page of paginated responses from a Amazon Rekognition
	// video operation.
	VideoMetadata *VideoMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetLabelDetectionOutput) GoString added in v1.12.36 

func (s GetLabelDetectionOutput) GoString() string

GoString returns the string representation

func (*GetLabelDetectionOutput) SetJobStatus added in v1.12.36 

func (s *GetLabelDetectionOutput) SetJobStatus(v string) *GetLabelDetectionOutput

SetJobStatus sets the JobStatus field's value.

func (*GetLabelDetectionOutput) SetLabels added in v1.12.36 

func (s *GetLabelDetectionOutput) SetLabels(v []*LabelDetection) *GetLabelDetectionOutput

SetLabels sets the Labels field's value.

func (*GetLabelDetectionOutput) SetNextToken added in v1.12.36 

func (s *GetLabelDetectionOutput) SetNextToken(v string) *GetLabelDetectionOutput

SetNextToken sets the NextToken field's value.

func (*GetLabelDetectionOutput) SetStatusMessage added in v1.12.36 

func (s *GetLabelDetectionOutput) SetStatusMessage(v string) *GetLabelDetectionOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetLabelDetectionOutput) SetVideoMetadata added in v1.12.36 

func (s *GetLabelDetectionOutput) SetVideoMetadata(v *VideoMetadata) *GetLabelDetectionOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetLabelDetectionOutput) String added in v1.12.36 

func (s GetLabelDetectionOutput) String() string

String returns the string representation

type GetPersonTrackingInput added in v1.12.36 

type GetPersonTrackingInput struct {

	// The identifier for a job that tracks persons in a video. You get the JobId
	// from a call to StartPersonTracking.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000. If you specify a value greater than 1000, a maximum
	// of 1000 results is returned. The default value is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there are more persons to
	// retrieve), Rekognition Video returns a pagination token in the response.
	// You can use this pagination token to retrieve the next set of persons.
	NextToken *string `type:"string"`

	// Sort to use for elements in the Persons array. Use TIMESTAMP to sort array
	// elements by the time persons are detected. Use INDEX to sort by the tracked
	// persons. If you sort by INDEX, the array elements for each person are sorted
	// by detection confidence. The default sort is by TIMESTAMP.
	SortBy *string `type:"string" enum:"PersonTrackingSortBy"`
	// contains filtered or unexported fields
}

func (GetPersonTrackingInput) GoString added in v1.12.36 

func (s GetPersonTrackingInput) GoString() string

GoString returns the string representation

func (*GetPersonTrackingInput) SetJobId added in v1.12.36 

func (s *GetPersonTrackingInput) SetJobId(v string) *GetPersonTrackingInput

SetJobId sets the JobId field's value.

func (*GetPersonTrackingInput) SetMaxResults added in v1.12.36 

func (s *GetPersonTrackingInput) SetMaxResults(v int64) *GetPersonTrackingInput

SetMaxResults sets the MaxResults field's value.

func (*GetPersonTrackingInput) SetNextToken added in v1.12.36 

func (s *GetPersonTrackingInput) SetNextToken(v string) *GetPersonTrackingInput

SetNextToken sets the NextToken field's value.

func (*GetPersonTrackingInput) SetSortBy added in v1.12.36 

func (s *GetPersonTrackingInput) SetSortBy(v string) *GetPersonTrackingInput

SetSortBy sets the SortBy field's value.

func (GetPersonTrackingInput) String added in v1.12.36 

func (s GetPersonTrackingInput) String() string

String returns the string representation

func (*GetPersonTrackingInput) Validate added in v1.12.36 

func (s *GetPersonTrackingInput) Validate() error

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

type GetPersonTrackingOutput added in v1.12.36 

type GetPersonTrackingOutput struct {

	// The current status of the person tracking job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

	// If the response is truncated, Rekognition Video returns this token that you
	// can use in the subsequent request to retrieve the next set of persons.
	NextToken *string `type:"string"`

	// An array of the persons detected in the video and the times they are tracked
	// throughout the video. An array element will exist for each time the person
	// is tracked.
	Persons []*PersonDetection `type:"list"`

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string `type:"string"`

	// Information about a video that Rekognition Video analyzed. Videometadata
	// is returned in every page of paginated responses from a Rekognition Video
	// operation.
	VideoMetadata *VideoMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPersonTrackingOutput) GoString added in v1.12.36 

func (s GetPersonTrackingOutput) GoString() string

GoString returns the string representation

func (*GetPersonTrackingOutput) SetJobStatus added in v1.12.36 

func (s *GetPersonTrackingOutput) SetJobStatus(v string) *GetPersonTrackingOutput

SetJobStatus sets the JobStatus field's value.

func (*GetPersonTrackingOutput) SetNextToken added in v1.12.36 

func (s *GetPersonTrackingOutput) SetNextToken(v string) *GetPersonTrackingOutput

SetNextToken sets the NextToken field's value.

func (*GetPersonTrackingOutput) SetPersons added in v1.12.36 

func (s *GetPersonTrackingOutput) SetPersons(v []*PersonDetection) *GetPersonTrackingOutput

SetPersons sets the Persons field's value.

func (*GetPersonTrackingOutput) SetStatusMessage added in v1.12.36 

func (s *GetPersonTrackingOutput) SetStatusMessage(v string) *GetPersonTrackingOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetPersonTrackingOutput) SetVideoMetadata added in v1.12.36 

func (s *GetPersonTrackingOutput) SetVideoMetadata(v *VideoMetadata) *GetPersonTrackingOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetPersonTrackingOutput) String added in v1.12.36 

func (s GetPersonTrackingOutput) String() string

String returns the string representation

type Image 

type Image struct {

	// Blob of image bytes up to 5 MBs.
	//
	// Bytes is automatically base64 encoded/decoded by the SDK.
	Bytes []byte `min:"1" type:"blob"`

	// Identifies an S3 object as the image source.
	S3Object *S3Object `type:"structure"`
	// contains filtered or unexported fields
}

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 images-bytes.

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.

func (Image) GoString 

func (s Image) GoString() string

GoString returns the string representation

func (*Image) SetBytes 

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

SetBytes sets the Bytes field's value.

func (*Image) SetS3Object 

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

SetS3Object sets the S3Object field's value.

func (Image) String 

func (s Image) String() string

String returns the string representation

func (*Image) Validate 

func (s *Image) Validate() error

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

type ImageQuality 

type ImageQuality struct {

	// Value representing brightness of the face. The service returns a value between
	// 0 and 100 (inclusive). A higher value indicates a brighter face image.
	Brightness *float64 `type:"float"`

	// Value representing sharpness of the face. The service returns a value between
	// 0 and 100 (inclusive). A higher value indicates a sharper face image.
	Sharpness *float64 `type:"float"`
	// contains filtered or unexported fields
}

Identifies face image brightness and sharpness.

func (ImageQuality) GoString 

func (s ImageQuality) GoString() string

GoString returns the string representation

func (*ImageQuality) SetBrightness 

func (s *ImageQuality) SetBrightness(v float64) *ImageQuality

SetBrightness sets the Brightness field's value.

func (*ImageQuality) SetSharpness 

func (s *ImageQuality) SetSharpness(v float64) *ImageQuality

SetSharpness sets the Sharpness field's value.

func (ImageQuality) String 

func (s ImageQuality) String() string

String returns the string representation

type IndexFacesInput 

type IndexFacesInput struct {

	// The ID of an existing collection to which you want to add the faces that
	// are detected in the input images.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// An array of facial attributes that you want to be returned. This can be the
	// default list of attributes or all attributes. If you don't specify a value
	// for Attributes or if you specify ["DEFAULT"], the API returns the following
	// subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks.
	// If you provide ["ALL"], all facial attributes are returned but the operation
	// will take longer to complete.
	//
	// If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator
	// to determine which attributes to return (in this case, all attributes).
	DetectionAttributes []*string `type:"list"`

	// ID you want to assign to all the faces detected in the image.
	ExternalImageId *string `min:"1" type:"string"`

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (IndexFacesInput) GoString 

func (s IndexFacesInput) GoString() string

GoString returns the string representation

func (*IndexFacesInput) SetCollectionId 

func (s *IndexFacesInput) SetCollectionId(v string) *IndexFacesInput

SetCollectionId sets the CollectionId field's value.

func (*IndexFacesInput) SetDetectionAttributes 

func (s *IndexFacesInput) SetDetectionAttributes(v []*string) *IndexFacesInput

SetDetectionAttributes sets the DetectionAttributes field's value.

func (*IndexFacesInput) SetExternalImageId 

func (s *IndexFacesInput) SetExternalImageId(v string) *IndexFacesInput

SetExternalImageId sets the ExternalImageId field's value.

func (*IndexFacesInput) SetImage 

func (s *IndexFacesInput) SetImage(v *Image) *IndexFacesInput

SetImage sets the Image field's value.

func (IndexFacesInput) String 

func (s IndexFacesInput) String() string

String returns the string representation

func (*IndexFacesInput) Validate 

func (s *IndexFacesInput) Validate() error

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

type IndexFacesOutput 

type IndexFacesOutput struct {

	// Version number of the face detection model associated with the input collection
	// (CollectionId).
	FaceModelVersion *string `type:"string"`

	// An array of faces detected and added to the collection. For more information,
	// see collections-index-faces.
	FaceRecords []*FaceRecord `type:"list"`

	// The orientation of the input image (counterclockwise direction). If your
	// application displays the image, you can use this value to correct image orientation.
	// The bounding box coordinates returned in FaceRecords represent face locations
	// before the image orientation is corrected.
	//
	// If the input image is in jpeg format, it might contain exchangeable image
	// (Exif) metadata. If so, and the Exif metadata populates the orientation field,
	// the value of OrientationCorrection is null and the bounding box coordinates
	// in FaceRecords represent face locations after Exif metadata is used to correct
	// the image orientation. Images in .png format don't contain Exif metadata.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`
	// contains filtered or unexported fields
}

func (IndexFacesOutput) GoString 

func (s IndexFacesOutput) GoString() string

GoString returns the string representation

func (*IndexFacesOutput) SetFaceModelVersion added in v1.12.32 

func (s *IndexFacesOutput) SetFaceModelVersion(v string) *IndexFacesOutput

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*IndexFacesOutput) SetFaceRecords 

func (s *IndexFacesOutput) SetFaceRecords(v []*FaceRecord) *IndexFacesOutput

SetFaceRecords sets the FaceRecords field's value.

func (*IndexFacesOutput) SetOrientationCorrection 

func (s *IndexFacesOutput) SetOrientationCorrection(v string) *IndexFacesOutput

SetOrientationCorrection sets the OrientationCorrection field's value.

func (IndexFacesOutput) String 

func (s IndexFacesOutput) String() string

String returns the string representation

type KinesisDataStream added in v1.12.36 

type KinesisDataStream struct {

	// ARN of the output Amazon Kinesis Data Streams stream.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see .

func (KinesisDataStream) GoString added in v1.12.36 

func (s KinesisDataStream) GoString() string

GoString returns the string representation

func (*KinesisDataStream) SetArn added in v1.12.36 

func (s *KinesisDataStream) SetArn(v string) *KinesisDataStream

SetArn sets the Arn field's value.

func (KinesisDataStream) String added in v1.12.36 

func (s KinesisDataStream) String() string

String returns the string representation

type KinesisVideoStream added in v1.12.36 

type KinesisVideoStream struct {

	// ARN of the Kinesis video stream stream that streams the source video.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

Kinesis video stream stream that provides the source streaming video for a Rekognition Video stream processor. For more information, see .

func (KinesisVideoStream) GoString added in v1.12.36 

func (s KinesisVideoStream) GoString() string

GoString returns the string representation

func (*KinesisVideoStream) SetArn added in v1.12.36 

func (s *KinesisVideoStream) SetArn(v string) *KinesisVideoStream

SetArn sets the Arn field's value.

func (KinesisVideoStream) String added in v1.12.36 

func (s KinesisVideoStream) String() string

String returns the string representation

type Label 

type Label struct {

	// Level of confidence.
	Confidence *float64 `type:"float"`

	// The name (label) of the object.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Structure containing details about the detected label, including name, and level of confidence.

func (Label) GoString 

func (s Label) GoString() string

GoString returns the string representation

func (*Label) SetConfidence 

func (s *Label) SetConfidence(v float64) *Label

SetConfidence sets the Confidence field's value.

func (*Label) SetName 

func (s *Label) SetName(v string) *Label

SetName sets the Name field's value.

func (Label) String 

func (s Label) String() string

String returns the string representation

type LabelDetection added in v1.12.36 

type LabelDetection struct {

	// Details about the detected label.
	Label *Label `type:"structure"`

	// Time, in milliseconds from the start of the video, that the label was detected.
	Timestamp *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a label detected in a video analysis request and the time the label was detected in the video.

func (LabelDetection) GoString added in v1.12.36 

func (s LabelDetection) GoString() string

GoString returns the string representation

func (*LabelDetection) SetLabel added in v1.12.36 

func (s *LabelDetection) SetLabel(v *Label) *LabelDetection

SetLabel sets the Label field's value.

func (*LabelDetection) SetTimestamp added in v1.12.36 

func (s *LabelDetection) SetTimestamp(v int64) *LabelDetection

SetTimestamp sets the Timestamp field's value.

func (LabelDetection) String added in v1.12.36 

func (s LabelDetection) String() string

String returns the string representation

type Landmark 

type Landmark struct {

	// Type of the landmark.
	Type *string `type:"string" enum:"LandmarkType"`

	// x-coordinate from the top left of the landmark expressed as the ratio of
	// the width of the image. For example, if the images is 700x200 and the x-coordinate
	// of the landmark is at 350 pixels, this value is 0.5.
	X *float64 `type:"float"`

	// y-coordinate from the top left of the landmark expressed as the ratio of
	// the height of the image. For example, if the images is 700x200 and the y-coordinate
	// of the landmark is at 100 pixels, this value is 0.5.
	Y *float64 `type:"float"`
	// contains filtered or unexported fields
}

Indicates the location of the landmark on the face.

func (Landmark) GoString 

func (s Landmark) GoString() string

GoString returns the string representation

func (*Landmark) SetType 

func (s *Landmark) SetType(v string) *Landmark

SetType sets the Type field's value.

func (*Landmark) SetX 

func (s *Landmark) SetX(v float64) *Landmark

SetX sets the X field's value.

func (*Landmark) SetY 

func (s *Landmark) SetY(v float64) *Landmark

SetY sets the Y field's value.

func (Landmark) String 

func (s Landmark) String() string

String returns the string representation

type ListCollectionsInput 

type ListCollectionsInput struct {

	// Maximum number of collection IDs to return.
	MaxResults *int64 `type:"integer"`

	// Pagination token from the previous response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCollectionsInput) GoString 

func (s ListCollectionsInput) GoString() string

GoString returns the string representation

func (*ListCollectionsInput) SetMaxResults 

func (s *ListCollectionsInput) SetMaxResults(v int64) *ListCollectionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCollectionsInput) SetNextToken 

func (s *ListCollectionsInput) SetNextToken(v string) *ListCollectionsInput

SetNextToken sets the NextToken field's value.

func (ListCollectionsInput) String 

func (s ListCollectionsInput) String() string

String returns the string representation

type ListCollectionsOutput 

type ListCollectionsOutput struct {

	// An array of collection IDs.
	CollectionIds []*string `type:"list"`

	// Version numbers of the face detection models associated with the collections
	// in the array CollectionIds. For example, the value of FaceModelVersions[2]
	// is the version number for the face detection model used by the collection
	// in CollectionId[2].
	FaceModelVersions []*string `type:"list"`

	// If the result is truncated, the response provides a NextToken that you can
	// use in the subsequent request to fetch the next set of collection IDs.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCollectionsOutput) GoString 

func (s ListCollectionsOutput) GoString() string

GoString returns the string representation

func (*ListCollectionsOutput) SetCollectionIds 

func (s *ListCollectionsOutput) SetCollectionIds(v []*string) *ListCollectionsOutput

SetCollectionIds sets the CollectionIds field's value.

func (*ListCollectionsOutput) SetFaceModelVersions added in v1.12.32 

func (s *ListCollectionsOutput) SetFaceModelVersions(v []*string) *ListCollectionsOutput

SetFaceModelVersions sets the FaceModelVersions field's value.

func (*ListCollectionsOutput) SetNextToken 

func (s *ListCollectionsOutput) SetNextToken(v string) *ListCollectionsOutput

SetNextToken sets the NextToken field's value.

func (ListCollectionsOutput) String 

func (s ListCollectionsOutput) String() string

String returns the string representation

type ListFacesInput 

type ListFacesInput struct {

	// ID of the collection from which to list the faces.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// Maximum number of faces to return.
	MaxResults *int64 `type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Rekognition returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of faces.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFacesInput) GoString 

func (s ListFacesInput) GoString() string

GoString returns the string representation

func (*ListFacesInput) SetCollectionId 

func (s *ListFacesInput) SetCollectionId(v string) *ListFacesInput

SetCollectionId sets the CollectionId field's value.

func (*ListFacesInput) SetMaxResults 

func (s *ListFacesInput) SetMaxResults(v int64) *ListFacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListFacesInput) SetNextToken 

func (s *ListFacesInput) SetNextToken(v string) *ListFacesInput

SetNextToken sets the NextToken field's value.

func (ListFacesInput) String 

func (s ListFacesInput) String() string

String returns the string representation

func (*ListFacesInput) Validate 

func (s *ListFacesInput) Validate() error

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

type ListFacesOutput 

type ListFacesOutput struct {

	// Version number of the face detection model associated with the input collection
	// (CollectionId).
	FaceModelVersion *string `type:"string"`

	// An array of Face objects.
	Faces []*Face `type:"list"`

	// If the response is truncated, Amazon Rekognition returns this token that
	// you can use in the subsequent request to retrieve the next set of faces.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFacesOutput) GoString 

func (s ListFacesOutput) GoString() string

GoString returns the string representation

func (*ListFacesOutput) SetFaceModelVersion added in v1.12.32 

func (s *ListFacesOutput) SetFaceModelVersion(v string) *ListFacesOutput

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*ListFacesOutput) SetFaces 

func (s *ListFacesOutput) SetFaces(v []*Face) *ListFacesOutput

SetFaces sets the Faces field's value.

func (*ListFacesOutput) SetNextToken 

func (s *ListFacesOutput) SetNextToken(v string) *ListFacesOutput

SetNextToken sets the NextToken field's value.

func (ListFacesOutput) String 

func (s ListFacesOutput) String() string

String returns the string representation

type ListStreamProcessorsInput added in v1.12.36 

type ListStreamProcessorsInput struct {

	// Maximum number of stream processors you want Rekognition Video to return
	// in the response. The default is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there are more stream processors
	// to retrieve), Rekognition Video returns a pagination token in the response.
	// You can use this pagination token to retrieve the next set of stream processors.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListStreamProcessorsInput) GoString added in v1.12.36 

func (s ListStreamProcessorsInput) GoString() string

GoString returns the string representation

func (*ListStreamProcessorsInput) SetMaxResults added in v1.12.36 

func (s *ListStreamProcessorsInput) SetMaxResults(v int64) *ListStreamProcessorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamProcessorsInput) SetNextToken added in v1.12.36 

func (s *ListStreamProcessorsInput) SetNextToken(v string) *ListStreamProcessorsInput

SetNextToken sets the NextToken field's value.

func (ListStreamProcessorsInput) String added in v1.12.36 

func (s ListStreamProcessorsInput) String() string

String returns the string representation

func (*ListStreamProcessorsInput) Validate added in v1.12.36 

func (s *ListStreamProcessorsInput) Validate() error

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

type ListStreamProcessorsOutput added in v1.12.36 

type ListStreamProcessorsOutput struct {

	// If the response is truncated, Rekognition Video returns this token that you
	// can use in the subsequent request to retrieve the next set of stream processors.
	NextToken *string `type:"string"`

	// List of stream processors that you have created.
	StreamProcessors []*StreamProcessor `type:"list"`
	// contains filtered or unexported fields
}

func (ListStreamProcessorsOutput) GoString added in v1.12.36 

func (s ListStreamProcessorsOutput) GoString() string

GoString returns the string representation

func (*ListStreamProcessorsOutput) SetNextToken added in v1.12.36 

func (s *ListStreamProcessorsOutput) SetNextToken(v string) *ListStreamProcessorsOutput

SetNextToken sets the NextToken field's value.

func (*ListStreamProcessorsOutput) SetStreamProcessors added in v1.12.36 

func (s *ListStreamProcessorsOutput) SetStreamProcessors(v []*StreamProcessor) *ListStreamProcessorsOutput

SetStreamProcessors sets the StreamProcessors field's value.

func (ListStreamProcessorsOutput) String added in v1.12.36 

func (s ListStreamProcessorsOutput) String() string

String returns the string representation

type ModerationLabel added in v1.8.14 

type ModerationLabel struct {

	// Specifies the confidence that Amazon Rekognition has that the label has been
	// correctly identified.
	//
	// If you don't specify the MinConfidence parameter in the call to DetectModerationLabels,
	// the operation returns labels with a confidence value greater than or equal
	// to 50 percent.
	Confidence *float64 `type:"float"`

	// The label name for the type of content detected in the image.
	Name *string `type:"string"`

	// The name for the parent label. Labels at the top-level of the hierarchy have
	// the parent label "".
	ParentName *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a single type of moderated content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see moderation.

func (ModerationLabel) GoString added in v1.8.14 

func (s ModerationLabel) GoString() string

GoString returns the string representation

func (*ModerationLabel) SetConfidence added in v1.8.14 

func (s *ModerationLabel) SetConfidence(v float64) *ModerationLabel

SetConfidence sets the Confidence field's value.

func (*ModerationLabel) SetName added in v1.8.14 

func (s *ModerationLabel) SetName(v string) *ModerationLabel

SetName sets the Name field's value.

func (*ModerationLabel) SetParentName added in v1.8.14 

func (s *ModerationLabel) SetParentName(v string) *ModerationLabel

SetParentName sets the ParentName field's value.

func (ModerationLabel) String added in v1.8.14 

func (s ModerationLabel) String() string

String returns the string representation

type MouthOpen 

type MouthOpen struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the mouth on the face is open or not.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

func (MouthOpen) GoString 

func (s MouthOpen) GoString() string

GoString returns the string representation

func (*MouthOpen) SetConfidence 

func (s *MouthOpen) SetConfidence(v float64) *MouthOpen

SetConfidence sets the Confidence field's value.

func (*MouthOpen) SetValue 

func (s *MouthOpen) SetValue(v bool) *MouthOpen

SetValue sets the Value field's value.

func (MouthOpen) String 

func (s MouthOpen) String() string

String returns the string representation

type Mustache 

type Mustache struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the face has mustache or not.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the face has a mustache, and the confidence level in the determination.

func (Mustache) GoString 

func (s Mustache) GoString() string

GoString returns the string representation

func (*Mustache) SetConfidence 

func (s *Mustache) SetConfidence(v float64) *Mustache

SetConfidence sets the Confidence field's value.

func (*Mustache) SetValue 

func (s *Mustache) SetValue(v bool) *Mustache

SetValue sets the Value field's value.

func (Mustache) String 

func (s Mustache) String() string

String returns the string representation

type NotificationChannel added in v1.12.36 

type NotificationChannel struct {

	// The ARN of an IAM role that gives Amazon Rekognition publishing permissions
	// to the Amazon SNS topic.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The Amazon SNS topic to which Amazon Rekognition to posts the completion
	// status.
	//
	// SNSTopicArn is a required field
	SNSTopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.

func (NotificationChannel) GoString added in v1.12.36 

func (s NotificationChannel) GoString() string

GoString returns the string representation

func (*NotificationChannel) SetRoleArn added in v1.12.36 

func (s *NotificationChannel) SetRoleArn(v string) *NotificationChannel

SetRoleArn sets the RoleArn field's value.

func (*NotificationChannel) SetSNSTopicArn added in v1.12.36 

func (s *NotificationChannel) SetSNSTopicArn(v string) *NotificationChannel

SetSNSTopicArn sets the SNSTopicArn field's value.

func (NotificationChannel) String added in v1.12.36 

func (s NotificationChannel) String() string

String returns the string representation

func (*NotificationChannel) Validate added in v1.12.36 

func (s *NotificationChannel) Validate() error

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

type PersonDetail added in v1.12.36 

type PersonDetail struct {

	// Bounding box around the detected person.
	BoundingBox *BoundingBox `type:"structure"`

	// Face details for the detected person.
	Face *FaceDetail `type:"structure"`

	// Identifier for the person detected person within a video. Use to keep track
	// of the person throughout the video. The identifier is not stored by Amazon
	// Rekognition.
	Index *int64 `type:"long"`
	// contains filtered or unexported fields
}

Details about a person detected in a video analysis request.

func (PersonDetail) GoString added in v1.12.36 

func (s PersonDetail) GoString() string

GoString returns the string representation

func (*PersonDetail) SetBoundingBox added in v1.12.36 

func (s *PersonDetail) SetBoundingBox(v *BoundingBox) *PersonDetail

SetBoundingBox sets the BoundingBox field's value.

func (*PersonDetail) SetFace added in v1.12.36 

func (s *PersonDetail) SetFace(v *FaceDetail) *PersonDetail

SetFace sets the Face field's value.

func (*PersonDetail) SetIndex added in v1.12.36 

func (s *PersonDetail) SetIndex(v int64) *PersonDetail

SetIndex sets the Index field's value.

func (PersonDetail) String added in v1.12.36 

func (s PersonDetail) String() string

String returns the string representation

type PersonDetection added in v1.12.36 

type PersonDetection struct {

	// Details about a person tracked in a video.
	Person *PersonDetail `type:"structure"`

	// The time, in milliseconds from the start of the video, that the person was
	// tracked.
	Timestamp *int64 `type:"long"`
	// contains filtered or unexported fields
}

Details and tracking information for a single time a person is tracked in a video. Amazon Rekognition operations that track persons return an array of PersonDetection objects with elements for each time a person is tracked in a video. For more information, see .

func (PersonDetection) GoString added in v1.12.36 

func (s PersonDetection) GoString() string

GoString returns the string representation

func (*PersonDetection) SetPerson added in v1.12.36 

func (s *PersonDetection) SetPerson(v *PersonDetail) *PersonDetection

SetPerson sets the Person field's value.

func (*PersonDetection) SetTimestamp added in v1.12.36 

func (s *PersonDetection) SetTimestamp(v int64) *PersonDetection

SetTimestamp sets the Timestamp field's value.

func (PersonDetection) String added in v1.12.36 

func (s PersonDetection) String() string

String returns the string representation

type PersonMatch added in v1.12.36 

type PersonMatch struct {

	// Information about the faces in the input collection that match the face of
	// a person in the video.
	FaceMatches []*FaceMatch `type:"list"`

	// Information about the matched person.
	Person *PersonDetail `type:"structure"`

	// The time, in milliseconds from the beginning of the video, that the person
	// was matched in the video.
	Timestamp *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a person whose face matches a face(s) in a Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (, information about the person (PersonDetail) and the timestamp for when the person was detected in a video. An array of PersonMatch objects is returned by .

func (PersonMatch) GoString added in v1.12.36 

func (s PersonMatch) GoString() string

GoString returns the string representation

func (*PersonMatch) SetFaceMatches added in v1.12.36 

func (s *PersonMatch) SetFaceMatches(v []*FaceMatch) *PersonMatch

SetFaceMatches sets the FaceMatches field's value.

func (*PersonMatch) SetPerson added in v1.12.36 

func (s *PersonMatch) SetPerson(v *PersonDetail) *PersonMatch

SetPerson sets the Person field's value.

func (*PersonMatch) SetTimestamp added in v1.12.36 

func (s *PersonMatch) SetTimestamp(v int64) *PersonMatch

SetTimestamp sets the Timestamp field's value.

func (PersonMatch) String added in v1.12.36 

func (s PersonMatch) String() string

String returns the string representation

type Point added in v1.12.32 

type Point struct {

	// The value of the X coordinate for a point on a Polygon.
	X *float64 `type:"float"`

	// The value of the Y coordinate for a point on a Polygon.
	Y *float64 `type:"float"`
	// contains filtered or unexported fields
}

The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.

An array of Point objects, Polygon, is returned by . Polygon represents a fine-grained polygon around detected text. For more information, see .

func (Point) GoString added in v1.12.32 

func (s Point) GoString() string

GoString returns the string representation

func (*Point) SetX added in v1.12.32 

func (s *Point) SetX(v float64) *Point

SetX sets the X field's value.

func (*Point) SetY added in v1.12.32 

func (s *Point) SetY(v float64) *Point

SetY sets the Y field's value.

func (Point) String added in v1.12.32 

func (s Point) String() string

String returns the string representation

type Pose 

type Pose struct {

	// Value representing the face rotation on the pitch axis.
	Pitch *float64 `type:"float"`

	// Value representing the face rotation on the roll axis.
	Roll *float64 `type:"float"`

	// Value representing the face rotation on the yaw axis.
	Yaw *float64 `type:"float"`
	// contains filtered or unexported fields
}

Indicates the pose of the face as determined by its pitch, roll, and yaw.

func (Pose) GoString 

func (s Pose) GoString() string

GoString returns the string representation

func (*Pose) SetPitch 

func (s *Pose) SetPitch(v float64) *Pose

SetPitch sets the Pitch field's value.

func (*Pose) SetRoll 

func (s *Pose) SetRoll(v float64) *Pose

SetRoll sets the Roll field's value.

func (*Pose) SetYaw 

func (s *Pose) SetYaw(v float64) *Pose

SetYaw sets the Yaw field's value.

func (Pose) String 

func (s Pose) String() string

String returns the string representation

type RecognizeCelebritiesInput added in v1.8.38 

type RecognizeCelebritiesInput struct {

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RecognizeCelebritiesInput) GoString added in v1.8.38 

func (s RecognizeCelebritiesInput) GoString() string

GoString returns the string representation

func (*RecognizeCelebritiesInput) SetImage added in v1.8.38 

func (s *RecognizeCelebritiesInput) SetImage(v *Image) *RecognizeCelebritiesInput

SetImage sets the Image field's value.

func (RecognizeCelebritiesInput) String added in v1.8.38 

func (s RecognizeCelebritiesInput) String() string

String returns the string representation

func (*RecognizeCelebritiesInput) Validate added in v1.8.38 

func (s *RecognizeCelebritiesInput) Validate() error

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

type RecognizeCelebritiesOutput added in v1.8.38 

type RecognizeCelebritiesOutput struct {

	// Details about each celebrity found in the image. Amazon Rekognition can detect
	// a maximum of 15 celebrities in an image.
	CelebrityFaces []*Celebrity `type:"list"`

	// The orientation of the input image (counterclockwise direction). If your
	// application displays the image, you can use this value to correct the orientation.
	// The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces
	// represent face locations before the image orientation is corrected.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// (Exif) metadata that includes the image's orientation. If so, and the Exif
	// metadata for the input image populates the orientation field, the value of
	// OrientationCorrection is null and the CelebrityFaces and UnrecognizedFaces
	// bounding box coordinates represent face locations after Exif metadata is
	// used to correct the image orientation. Images in .png format don't contain
	// Exif metadata.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`

	// Details about each unrecognized face in the image.
	UnrecognizedFaces []*ComparedFace `type:"list"`
	// contains filtered or unexported fields
}

func (RecognizeCelebritiesOutput) GoString added in v1.8.38 

func (s RecognizeCelebritiesOutput) GoString() string

GoString returns the string representation

func (*RecognizeCelebritiesOutput) SetCelebrityFaces added in v1.8.38 

func (s *RecognizeCelebritiesOutput) SetCelebrityFaces(v []*Celebrity) *RecognizeCelebritiesOutput

SetCelebrityFaces sets the CelebrityFaces field's value.

func (*RecognizeCelebritiesOutput) SetOrientationCorrection added in v1.8.38 

func (s *RecognizeCelebritiesOutput) SetOrientationCorrection(v string) *RecognizeCelebritiesOutput

SetOrientationCorrection sets the OrientationCorrection field's value.

func (*RecognizeCelebritiesOutput) SetUnrecognizedFaces added in v1.8.38 

func (s *RecognizeCelebritiesOutput) SetUnrecognizedFaces(v []*ComparedFace) *RecognizeCelebritiesOutput

SetUnrecognizedFaces sets the UnrecognizedFaces field's value.

func (RecognizeCelebritiesOutput) String added in v1.8.38 

func (s RecognizeCelebritiesOutput) String() string

String returns the string representation

type Rekognition 

type Rekognition struct {
	*client.Client
}

Rekognition provides the API operation methods for making requests to Amazon Rekognition. See this package's package overview docs for details on the service.

Rekognition methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Rekognition

New creates a new instance of the Rekognition client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a Rekognition client from just a session.
svc := rekognition.New(mySession)

// Create a Rekognition client with additional configuration
svc := rekognition.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Rekognition) CompareFaces 

func (c *Rekognition) CompareFaces(input *CompareFacesInput) (*CompareFacesOutput, error)

CompareFaces API operation for Amazon Rekognition.

Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.

You pass the input and target images either as base64-encoded image bytes or as a references to images in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter.

CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.

If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error.

This is a stateless API operation. That is, data returned by this operation doesn't persist.

For an example, see faces-compare-images.

This operation requires permissions to perform the rekognition:CompareFaces action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation CompareFaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

Example (Shared00)

To compare two images

This operation compares the largest face detected in the source image with each face detected in the target image. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.CompareFacesInput{
		SimilarityThreshold: aws.Float64(90.000000),
		SourceImage: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("mysourceimage"),
			},
		},
		TargetImage: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("mytargetimage"),
			},
		},
	}

	result, err := svc.CompareFaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeInvalidS3ObjectException:
				fmt.Println(rekognition.ErrCodeInvalidS3ObjectException, aerr.Error())
			case rekognition.ErrCodeImageTooLargeException:
				fmt.Println(rekognition.ErrCodeImageTooLargeException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeInvalidImageFormatException:
				fmt.Println(rekognition.ErrCodeInvalidImageFormatException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) CompareFacesRequest 

func (c *Rekognition) CompareFacesRequest(input *CompareFacesInput) (req *request.Request, output *CompareFacesOutput)

CompareFacesRequest generates a "aws/request.Request" representing the client's request for the CompareFaces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CompareFaces for more information on using the CompareFaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CompareFacesRequest method.
req, resp := client.CompareFacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) CompareFacesWithContext added in v1.8.0 

func (c *Rekognition) CompareFacesWithContext(ctx aws.Context, input *CompareFacesInput, opts ...request.Option) (*CompareFacesOutput, error)

CompareFacesWithContext is the same as CompareFaces with the addition of the ability to pass a context and additional request options.

See CompareFaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) CreateCollection 

func (c *Rekognition) CreateCollection(input *CreateCollectionInput) (*CreateCollectionOutput, error)

CreateCollection API operation for Amazon Rekognition.

Creates a collection in an AWS Region. You can add faces to the collection using the operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation CreateCollection for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" A collection with the specified ID already exists.

Example (Shared00)

To create a collection

This operation creates a Rekognition collection for storing image data. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.CreateCollectionInput{
		CollectionId: aws.String("myphotos"),
	}

	result, err := svc.CreateCollection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeResourceAlreadyExistsException:
				fmt.Println(rekognition.ErrCodeResourceAlreadyExistsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) CreateCollectionRequest 

func (c *Rekognition) CreateCollectionRequest(input *CreateCollectionInput) (req *request.Request, output *CreateCollectionOutput)

CreateCollectionRequest generates a "aws/request.Request" representing the client's request for the CreateCollection operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCollection for more information on using the CreateCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateCollectionRequest method.
req, resp := client.CreateCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) CreateCollectionWithContext added in v1.8.0 

func (c *Rekognition) CreateCollectionWithContext(ctx aws.Context, input *CreateCollectionInput, opts ...request.Option) (*CreateCollectionOutput, error)

CreateCollectionWithContext is the same as CreateCollection with the addition of the ability to pass a context and additional request options.

See CreateCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) CreateStreamProcessor added in v1.12.36 

func (c *Rekognition) CreateStreamProcessor(input *CreateStreamProcessorInput) (*CreateStreamProcessorOutput, error)

CreateStreamProcessor API operation for Amazon Rekognition.

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.

Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Rekognition Video sends analysis results to Amazon Kinesis Data Streams.

You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling with the Name field.

After you have finished analyzing a streaming video, use to stop processing. You can delete the stream processor by calling .

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation CreateStreamProcessor for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeResourceInUseException "ResourceInUseException"

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

func (*Rekognition) CreateStreamProcessorRequest added in v1.12.36 

func (c *Rekognition) CreateStreamProcessorRequest(input *CreateStreamProcessorInput) (req *request.Request, output *CreateStreamProcessorOutput)

CreateStreamProcessorRequest generates a "aws/request.Request" representing the client's request for the CreateStreamProcessor operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStreamProcessor for more information on using the CreateStreamProcessor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStreamProcessorRequest method.
req, resp := client.CreateStreamProcessorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) CreateStreamProcessorWithContext added in v1.12.36 

func (c *Rekognition) CreateStreamProcessorWithContext(ctx aws.Context, input *CreateStreamProcessorInput, opts ...request.Option) (*CreateStreamProcessorOutput, error)

CreateStreamProcessorWithContext is the same as CreateStreamProcessor with the addition of the ability to pass a context and additional request options.

See CreateStreamProcessor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DeleteCollection 

func (c *Rekognition) DeleteCollection(input *DeleteCollectionInput) (*DeleteCollectionOutput, error)

DeleteCollection API operation for Amazon Rekognition.

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.

This operation requires permissions to perform the rekognition:DeleteCollection action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DeleteCollection for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

Example (Shared00)

To delete a collection

This operation deletes a Rekognition collection. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.DeleteCollectionInput{
		CollectionId: aws.String("myphotos"),
	}

	result, err := svc.DeleteCollection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) DeleteCollectionRequest 

func (c *Rekognition) DeleteCollectionRequest(input *DeleteCollectionInput) (req *request.Request, output *DeleteCollectionOutput)

DeleteCollectionRequest generates a "aws/request.Request" representing the client's request for the DeleteCollection operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCollection for more information on using the DeleteCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteCollectionRequest method.
req, resp := client.DeleteCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DeleteCollectionWithContext added in v1.8.0 

func (c *Rekognition) DeleteCollectionWithContext(ctx aws.Context, input *DeleteCollectionInput, opts ...request.Option) (*DeleteCollectionOutput, error)

DeleteCollectionWithContext is the same as DeleteCollection with the addition of the ability to pass a context and additional request options.

See DeleteCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DeleteFaces 

func (c *Rekognition) DeleteFaces(input *DeleteFacesInput) (*DeleteFacesOutput, error)

DeleteFaces API operation for Amazon Rekognition.

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

This operation requires permissions to perform the rekognition:DeleteFaces action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DeleteFaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

Example (Shared00)

To delete a face

This operation deletes one or more faces from a Rekognition collection. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.DeleteFacesInput{
		CollectionId: aws.String("myphotos"),
		FaceIds: []*string{
			aws.String("ff43d742-0c13-5d16-a3e8-03d3f58e980b"),
		},
	}

	result, err := svc.DeleteFaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) DeleteFacesRequest 

func (c *Rekognition) DeleteFacesRequest(input *DeleteFacesInput) (req *request.Request, output *DeleteFacesOutput)

DeleteFacesRequest generates a "aws/request.Request" representing the client's request for the DeleteFaces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFaces for more information on using the DeleteFaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFacesRequest method.
req, resp := client.DeleteFacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DeleteFacesWithContext added in v1.8.0 

func (c *Rekognition) DeleteFacesWithContext(ctx aws.Context, input *DeleteFacesInput, opts ...request.Option) (*DeleteFacesOutput, error)

DeleteFacesWithContext is the same as DeleteFaces with the addition of the ability to pass a context and additional request options.

See DeleteFaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DeleteStreamProcessor added in v1.12.36 

func (c *Rekognition) DeleteStreamProcessor(input *DeleteStreamProcessorInput) (*DeleteStreamProcessorOutput, error)

DeleteStreamProcessor API operation for Amazon Rekognition.

Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with . You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DeleteStreamProcessor for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeResourceInUseException "ResourceInUseException"

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

func (*Rekognition) DeleteStreamProcessorRequest added in v1.12.36 

func (c *Rekognition) DeleteStreamProcessorRequest(input *DeleteStreamProcessorInput) (req *request.Request, output *DeleteStreamProcessorOutput)

DeleteStreamProcessorRequest generates a "aws/request.Request" representing the client's request for the DeleteStreamProcessor operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStreamProcessor for more information on using the DeleteStreamProcessor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteStreamProcessorRequest method.
req, resp := client.DeleteStreamProcessorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DeleteStreamProcessorWithContext added in v1.12.36 

func (c *Rekognition) DeleteStreamProcessorWithContext(ctx aws.Context, input *DeleteStreamProcessorInput, opts ...request.Option) (*DeleteStreamProcessorOutput, error)

DeleteStreamProcessorWithContext is the same as DeleteStreamProcessor with the addition of the ability to pass a context and additional request options.

See DeleteStreamProcessor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DescribeStreamProcessor added in v1.12.36 

func (c *Rekognition) DescribeStreamProcessor(input *DescribeStreamProcessorInput) (*DescribeStreamProcessorOutput, error)

DescribeStreamProcessor API operation for Amazon Rekognition.

Provides information about a stream processor created by . You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DescribeStreamProcessor for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

func (*Rekognition) DescribeStreamProcessorRequest added in v1.12.36 

func (c *Rekognition) DescribeStreamProcessorRequest(input *DescribeStreamProcessorInput) (req *request.Request, output *DescribeStreamProcessorOutput)

DescribeStreamProcessorRequest generates a "aws/request.Request" representing the client's request for the DescribeStreamProcessor operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStreamProcessor for more information on using the DescribeStreamProcessor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStreamProcessorRequest method.
req, resp := client.DescribeStreamProcessorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DescribeStreamProcessorWithContext added in v1.12.36 

func (c *Rekognition) DescribeStreamProcessorWithContext(ctx aws.Context, input *DescribeStreamProcessorInput, opts ...request.Option) (*DescribeStreamProcessorOutput, error)

DescribeStreamProcessorWithContext is the same as DescribeStreamProcessor with the addition of the ability to pass a context and additional request options.

See DescribeStreamProcessor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DetectFaces 

func (c *Rekognition) DetectFaces(input *DetectFacesInput) (*DetectFacesOutput, error)

DetectFaces API operation for Amazon Rekognition.

Detects faces within an image that is provided as input.

DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc.

The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

This is a stateless API operation. That is, the operation does not persist any data.

For an example, see procedure-detecting-faces-in-images.

This operation requires permissions to perform the rekognition:DetectFaces action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DetectFaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

Example (Shared00)

To detect faces in an image

This operation detects faces in an image stored in an AWS S3 bucket. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.DetectFacesInput{
		Image: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("myphoto"),
			},
		},
	}

	result, err := svc.DetectFaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidS3ObjectException:
				fmt.Println(rekognition.ErrCodeInvalidS3ObjectException, aerr.Error())
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeImageTooLargeException:
				fmt.Println(rekognition.ErrCodeImageTooLargeException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeInvalidImageFormatException:
				fmt.Println(rekognition.ErrCodeInvalidImageFormatException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) DetectFacesRequest 

func (c *Rekognition) DetectFacesRequest(input *DetectFacesInput) (req *request.Request, output *DetectFacesOutput)

DetectFacesRequest generates a "aws/request.Request" representing the client's request for the DetectFaces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectFaces for more information on using the DetectFaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectFacesRequest method.
req, resp := client.DetectFacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DetectFacesWithContext added in v1.8.0 

func (c *Rekognition) DetectFacesWithContext(ctx aws.Context, input *DetectFacesInput, opts ...request.Option) (*DetectFacesOutput, error)

DetectFacesWithContext is the same as DetectFaces with the addition of the ability to pass a context and additional request options.

See DetectFaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DetectLabels 

func (c *Rekognition) DetectLabels(input *DetectLabelsInput) (*DetectLabelsOutput, error)

DetectLabels API operation for Amazon Rekognition.

Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see images-s3.

DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see .

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels parameter to limit the number of labels returned.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DetectLabels for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

Example (Shared00)

To detect labels

This operation detects labels in the supplied image 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.DetectLabelsInput{
		Image: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("myphoto"),
			},
		},
		MaxLabels:     aws.Int64(123),
		MinConfidence: aws.Float64(70.000000),
	}

	result, err := svc.DetectLabels(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidS3ObjectException:
				fmt.Println(rekognition.ErrCodeInvalidS3ObjectException, aerr.Error())
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeImageTooLargeException:
				fmt.Println(rekognition.ErrCodeImageTooLargeException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeInvalidImageFormatException:
				fmt.Println(rekognition.ErrCodeInvalidImageFormatException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) DetectLabelsRequest 

func (c *Rekognition) DetectLabelsRequest(input *DetectLabelsInput) (req *request.Request, output *DetectLabelsOutput)

DetectLabelsRequest generates a "aws/request.Request" representing the client's request for the DetectLabels operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectLabels for more information on using the DetectLabels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectLabelsRequest method.
req, resp := client.DetectLabelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DetectLabelsWithContext added in v1.8.0 

func (c *Rekognition) DetectLabelsWithContext(ctx aws.Context, input *DetectLabelsInput, opts ...request.Option) (*DetectLabelsOutput, error)

DetectLabelsWithContext is the same as DetectLabels with the addition of the ability to pass a context and additional request options.

See DetectLabels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DetectModerationLabels added in v1.8.14 

func (c *Rekognition) DetectModerationLabels(input *DetectModerationLabelsInput) (*DetectModerationLabelsOutput, error)

DetectModerationLabels API operation for Amazon Rekognition.

Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see moderation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DetectModerationLabels for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

func (*Rekognition) DetectModerationLabelsRequest added in v1.8.14 

func (c *Rekognition) DetectModerationLabelsRequest(input *DetectModerationLabelsInput) (req *request.Request, output *DetectModerationLabelsOutput)

DetectModerationLabelsRequest generates a "aws/request.Request" representing the client's request for the DetectModerationLabels operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectModerationLabels for more information on using the DetectModerationLabels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectModerationLabelsRequest method.
req, resp := client.DetectModerationLabelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DetectModerationLabelsWithContext added in v1.8.14 

func (c *Rekognition) DetectModerationLabelsWithContext(ctx aws.Context, input *DetectModerationLabelsInput, opts ...request.Option) (*DetectModerationLabelsOutput, error)

DetectModerationLabelsWithContext is the same as DetectModerationLabels with the addition of the ability to pass a context and additional request options.

See DetectModerationLabels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) DetectText added in v1.12.32 

func (c *Rekognition) DetectText(input *DetectTextInput) (*DetectTextOutput, error)

DetectText API operation for Amazon Rekognition.

Detects text in the input image and converts it into machine-readable text.

Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.

The DetectText operation returns text in an array of elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image.

A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image.

A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

To be detected, text must be within +/- 30 degrees orientation of the horizontal axis.

For more information, see text-detection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation DetectText for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

func (*Rekognition) DetectTextRequest added in v1.12.32 

func (c *Rekognition) DetectTextRequest(input *DetectTextInput) (req *request.Request, output *DetectTextOutput)

DetectTextRequest generates a "aws/request.Request" representing the client's request for the DetectText operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectText for more information on using the DetectText API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectTextRequest method.
req, resp := client.DetectTextRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) DetectTextWithContext added in v1.12.32 

func (c *Rekognition) DetectTextWithContext(ctx aws.Context, input *DetectTextInput, opts ...request.Option) (*DetectTextOutput, error)

DetectTextWithContext is the same as DetectText with the addition of the ability to pass a context and additional request options.

See DetectText for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetCelebrityInfo added in v1.8.38 

func (c *Rekognition) GetCelebrityInfo(input *GetCelebrityInfoInput) (*GetCelebrityInfoOutput, error)

GetCelebrityInfo API operation for Amazon Rekognition.

Gets the name and additional information about a celebrity based on his or her Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see get-celebrity-info-procedure.

This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetCelebrityInfo for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

func (*Rekognition) GetCelebrityInfoRequest added in v1.8.38 

func (c *Rekognition) GetCelebrityInfoRequest(input *GetCelebrityInfoInput) (req *request.Request, output *GetCelebrityInfoOutput)

GetCelebrityInfoRequest generates a "aws/request.Request" representing the client's request for the GetCelebrityInfo operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCelebrityInfo for more information on using the GetCelebrityInfo API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetCelebrityInfoRequest method.
req, resp := client.GetCelebrityInfoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetCelebrityInfoWithContext added in v1.8.38 

func (c *Rekognition) GetCelebrityInfoWithContext(ctx aws.Context, input *GetCelebrityInfoInput, opts ...request.Option) (*GetCelebrityInfoOutput, error)

GetCelebrityInfoWithContext is the same as GetCelebrityInfo with the addition of the ability to pass a context and additional request options.

See GetCelebrityInfo for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetCelebrityRecognition added in v1.12.36 

func (c *Rekognition) GetCelebrityRecognition(input *GetCelebrityRecognitionInput) (*GetCelebrityRecognitionOutput, error)

GetCelebrityRecognition API operation for Amazon Rekognition.

Gets the celebrity recognition results for a Rekognition Video analysis started by .

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to which returns a job identifier (JobId). When the celebrity recognition operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see video.

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of objects. Each CelebrityRecognition contains information about the celebrity in a object and the time, Timestamp, the celebrity was detected.

GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see .

By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling with the celebrity identifer.

No information is returned for faces not recognized as celebrities.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetCelebrityRecognition for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) GetCelebrityRecognitionPages added in v1.12.36 

func (c *Rekognition) GetCelebrityRecognitionPages(input *GetCelebrityRecognitionInput, fn func(*GetCelebrityRecognitionOutput, bool) bool) error

GetCelebrityRecognitionPages iterates over the pages of a GetCelebrityRecognition operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetCelebrityRecognition method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetCelebrityRecognition operation.
pageNum := 0
err := client.GetCelebrityRecognitionPages(params,
    func(page *GetCelebrityRecognitionOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetCelebrityRecognitionPagesWithContext added in v1.12.36 

func (c *Rekognition) GetCelebrityRecognitionPagesWithContext(ctx aws.Context, input *GetCelebrityRecognitionInput, fn func(*GetCelebrityRecognitionOutput, bool) bool, opts ...request.Option) error

GetCelebrityRecognitionPagesWithContext same as GetCelebrityRecognitionPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetCelebrityRecognitionRequest added in v1.12.36 

func (c *Rekognition) GetCelebrityRecognitionRequest(input *GetCelebrityRecognitionInput) (req *request.Request, output *GetCelebrityRecognitionOutput)

GetCelebrityRecognitionRequest generates a "aws/request.Request" representing the client's request for the GetCelebrityRecognition operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCelebrityRecognition for more information on using the GetCelebrityRecognition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetCelebrityRecognitionRequest method.
req, resp := client.GetCelebrityRecognitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetCelebrityRecognitionWithContext added in v1.12.36 

func (c *Rekognition) GetCelebrityRecognitionWithContext(ctx aws.Context, input *GetCelebrityRecognitionInput, opts ...request.Option) (*GetCelebrityRecognitionOutput, error)

GetCelebrityRecognitionWithContext is the same as GetCelebrityRecognition with the addition of the ability to pass a context and additional request options.

See GetCelebrityRecognition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetContentModeration added in v1.12.36 

func (c *Rekognition) GetContentModeration(input *GetContentModerationInput) (*GetContentModerationOutput, error)

GetContentModeration API operation for Amazon Rekognition.

Gets the content moderation analysis results for a Rekognition Video analysis started by .

Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . which returns a job identifier (JobId). When analysis finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see video.

GetContentModeration returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels, of objects.

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.

For more information, see moderation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetContentModeration for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) GetContentModerationPages added in v1.12.36 

func (c *Rekognition) GetContentModerationPages(input *GetContentModerationInput, fn func(*GetContentModerationOutput, bool) bool) error

GetContentModerationPages iterates over the pages of a GetContentModeration operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetContentModeration method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetContentModeration operation.
pageNum := 0
err := client.GetContentModerationPages(params,
    func(page *GetContentModerationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetContentModerationPagesWithContext added in v1.12.36 

func (c *Rekognition) GetContentModerationPagesWithContext(ctx aws.Context, input *GetContentModerationInput, fn func(*GetContentModerationOutput, bool) bool, opts ...request.Option) error

GetContentModerationPagesWithContext same as GetContentModerationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetContentModerationRequest added in v1.12.36 

func (c *Rekognition) GetContentModerationRequest(input *GetContentModerationInput) (req *request.Request, output *GetContentModerationOutput)

GetContentModerationRequest generates a "aws/request.Request" representing the client's request for the GetContentModeration operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContentModeration for more information on using the GetContentModeration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetContentModerationRequest method.
req, resp := client.GetContentModerationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetContentModerationWithContext added in v1.12.36 

func (c *Rekognition) GetContentModerationWithContext(ctx aws.Context, input *GetContentModerationInput, opts ...request.Option) (*GetContentModerationOutput, error)

GetContentModerationWithContext is the same as GetContentModeration with the addition of the ability to pass a context and additional request options.

See GetContentModeration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetFaceDetection added in v1.12.36 

func (c *Rekognition) GetFaceDetection(input *GetFaceDetectionInput) (*GetFaceDetectionOutput, error)

GetFaceDetection API operation for Amazon Rekognition.

Gets face detection results for a Rekognition Video analysis started by .

Face detection with Rekognition Video is an asynchronous operation. You start face detection by calling which returns a job identifier (JobId). When the face detection operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartFaceDetection.

GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetFaceDetection for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) GetFaceDetectionPages added in v1.12.36 

func (c *Rekognition) GetFaceDetectionPages(input *GetFaceDetectionInput, fn func(*GetFaceDetectionOutput, bool) bool) error

GetFaceDetectionPages iterates over the pages of a GetFaceDetection operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetFaceDetection method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetFaceDetection operation.
pageNum := 0
err := client.GetFaceDetectionPages(params,
    func(page *GetFaceDetectionOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetFaceDetectionPagesWithContext added in v1.12.36 

func (c *Rekognition) GetFaceDetectionPagesWithContext(ctx aws.Context, input *GetFaceDetectionInput, fn func(*GetFaceDetectionOutput, bool) bool, opts ...request.Option) error

GetFaceDetectionPagesWithContext same as GetFaceDetectionPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetFaceDetectionRequest added in v1.12.36 

func (c *Rekognition) GetFaceDetectionRequest(input *GetFaceDetectionInput) (req *request.Request, output *GetFaceDetectionOutput)

GetFaceDetectionRequest generates a "aws/request.Request" representing the client's request for the GetFaceDetection operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFaceDetection for more information on using the GetFaceDetection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFaceDetectionRequest method.
req, resp := client.GetFaceDetectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetFaceDetectionWithContext added in v1.12.36 

func (c *Rekognition) GetFaceDetectionWithContext(ctx aws.Context, input *GetFaceDetectionInput, opts ...request.Option) (*GetFaceDetectionOutput, error)

GetFaceDetectionWithContext is the same as GetFaceDetection with the addition of the ability to pass a context and additional request options.

See GetFaceDetection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetFaceSearch added in v1.12.36 

func (c *Rekognition) GetFaceSearch(input *GetFaceSearchInput) (*GetFaceSearchOutput, error)

GetFaceSearch API operation for Amazon Rekognition.

Gets the face search results for Rekognition Video face search started by . The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to which returns a job identifier (JobId). When the search operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see collections.

The search results are retured in an array, Persons, of objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see .

By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetFaceSearch for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) GetFaceSearchPages added in v1.12.36 

func (c *Rekognition) GetFaceSearchPages(input *GetFaceSearchInput, fn func(*GetFaceSearchOutput, bool) bool) error

GetFaceSearchPages iterates over the pages of a GetFaceSearch operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetFaceSearch method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetFaceSearch operation.
pageNum := 0
err := client.GetFaceSearchPages(params,
    func(page *GetFaceSearchOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetFaceSearchPagesWithContext added in v1.12.36 

func (c *Rekognition) GetFaceSearchPagesWithContext(ctx aws.Context, input *GetFaceSearchInput, fn func(*GetFaceSearchOutput, bool) bool, opts ...request.Option) error

GetFaceSearchPagesWithContext same as GetFaceSearchPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetFaceSearchRequest added in v1.12.36 

func (c *Rekognition) GetFaceSearchRequest(input *GetFaceSearchInput) (req *request.Request, output *GetFaceSearchOutput)

GetFaceSearchRequest generates a "aws/request.Request" representing the client's request for the GetFaceSearch operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFaceSearch for more information on using the GetFaceSearch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFaceSearchRequest method.
req, resp := client.GetFaceSearchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetFaceSearchWithContext added in v1.12.36 

func (c *Rekognition) GetFaceSearchWithContext(ctx aws.Context, input *GetFaceSearchInput, opts ...request.Option) (*GetFaceSearchOutput, error)

GetFaceSearchWithContext is the same as GetFaceSearch with the addition of the ability to pass a context and additional request options.

See GetFaceSearch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetLabelDetection added in v1.12.36 

func (c *Rekognition) GetLabelDetection(input *GetLabelDetectionInput) (*GetLabelDetectionOutput, error)

GetLabelDetection API operation for Amazon Rekognition.

Gets the label detection results of a Rekognition Video analysis started by .

The label detection operation is started by a call to which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartLabelDetection.

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter.

The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetLabelDetection for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) GetLabelDetectionPages added in v1.12.36 

func (c *Rekognition) GetLabelDetectionPages(input *GetLabelDetectionInput, fn func(*GetLabelDetectionOutput, bool) bool) error

GetLabelDetectionPages iterates over the pages of a GetLabelDetection operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetLabelDetection method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetLabelDetection operation.
pageNum := 0
err := client.GetLabelDetectionPages(params,
    func(page *GetLabelDetectionOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetLabelDetectionPagesWithContext added in v1.12.36 

func (c *Rekognition) GetLabelDetectionPagesWithContext(ctx aws.Context, input *GetLabelDetectionInput, fn func(*GetLabelDetectionOutput, bool) bool, opts ...request.Option) error

GetLabelDetectionPagesWithContext same as GetLabelDetectionPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetLabelDetectionRequest added in v1.12.36 

func (c *Rekognition) GetLabelDetectionRequest(input *GetLabelDetectionInput) (req *request.Request, output *GetLabelDetectionOutput)

GetLabelDetectionRequest generates a "aws/request.Request" representing the client's request for the GetLabelDetection operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLabelDetection for more information on using the GetLabelDetection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetLabelDetectionRequest method.
req, resp := client.GetLabelDetectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetLabelDetectionWithContext added in v1.12.36 

func (c *Rekognition) GetLabelDetectionWithContext(ctx aws.Context, input *GetLabelDetectionInput, opts ...request.Option) (*GetLabelDetectionOutput, error)

GetLabelDetectionWithContext is the same as GetLabelDetection with the addition of the ability to pass a context and additional request options.

See GetLabelDetection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetPersonTracking added in v1.12.36 

func (c *Rekognition) GetPersonTracking(input *GetPersonTrackingInput) (*GetPersonTrackingOutput, error)

GetPersonTracking API operation for Amazon Rekognition.

Gets the person tracking results of a Rekognition Video analysis started by .

The person detection operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the person detection operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

To get the results of the person tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartPersonTracking.

GetPersonTracking returns an array, Persons, of tracked persons and the time(s) they were tracked in the video.

GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see .

By default, the array is sorted by the time(s) a person is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation GetPersonTracking for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) GetPersonTrackingPages added in v1.12.36 

func (c *Rekognition) GetPersonTrackingPages(input *GetPersonTrackingInput, fn func(*GetPersonTrackingOutput, bool) bool) error

GetPersonTrackingPages iterates over the pages of a GetPersonTracking operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetPersonTracking method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetPersonTracking operation.
pageNum := 0
err := client.GetPersonTrackingPages(params,
    func(page *GetPersonTrackingOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetPersonTrackingPagesWithContext added in v1.12.36 

func (c *Rekognition) GetPersonTrackingPagesWithContext(ctx aws.Context, input *GetPersonTrackingInput, fn func(*GetPersonTrackingOutput, bool) bool, opts ...request.Option) error

GetPersonTrackingPagesWithContext same as GetPersonTrackingPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) GetPersonTrackingRequest added in v1.12.36 

func (c *Rekognition) GetPersonTrackingRequest(input *GetPersonTrackingInput) (req *request.Request, output *GetPersonTrackingOutput)

GetPersonTrackingRequest generates a "aws/request.Request" representing the client's request for the GetPersonTracking operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPersonTracking for more information on using the GetPersonTracking API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetPersonTrackingRequest method.
req, resp := client.GetPersonTrackingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) GetPersonTrackingWithContext added in v1.12.36 

func (c *Rekognition) GetPersonTrackingWithContext(ctx aws.Context, input *GetPersonTrackingInput, opts ...request.Option) (*GetPersonTrackingOutput, error)

GetPersonTrackingWithContext is the same as GetPersonTracking with the addition of the ability to pass a context and additional request options.

See GetPersonTracking for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) IndexFaces 

func (c *Rekognition) IndexFaces(input *IndexFacesInput) (*IndexFacesOutput, error)

IndexFaces API operation for Amazon Rekognition.

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.

If you are using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. To determine which version of the model you are using, check the the value of FaceModelVersion in the response from IndexFaces. For more information, see face-detection-model.

If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

The input image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

This operation requires permissions to perform the rekognition:IndexFaces action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation IndexFaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

Example (Shared00)

To add a face to a collection

This operation detects faces in an image and adds them to the specified Rekognition collection. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.IndexFacesInput{
		CollectionId:    aws.String("myphotos"),
		ExternalImageId: aws.String("myphotoid"),
		Image: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("myphoto"),
			},
		},
	}

	result, err := svc.IndexFaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidS3ObjectException:
				fmt.Println(rekognition.ErrCodeInvalidS3ObjectException, aerr.Error())
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeImageTooLargeException:
				fmt.Println(rekognition.ErrCodeImageTooLargeException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			case rekognition.ErrCodeInvalidImageFormatException:
				fmt.Println(rekognition.ErrCodeInvalidImageFormatException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) IndexFacesRequest 

func (c *Rekognition) IndexFacesRequest(input *IndexFacesInput) (req *request.Request, output *IndexFacesOutput)

IndexFacesRequest generates a "aws/request.Request" representing the client's request for the IndexFaces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IndexFaces for more information on using the IndexFaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the IndexFacesRequest method.
req, resp := client.IndexFacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) IndexFacesWithContext added in v1.8.0 

func (c *Rekognition) IndexFacesWithContext(ctx aws.Context, input *IndexFacesInput, opts ...request.Option) (*IndexFacesOutput, error)

IndexFacesWithContext is the same as IndexFaces with the addition of the ability to pass a context and additional request options.

See IndexFaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) ListCollections 

func (c *Rekognition) ListCollections(input *ListCollectionsInput) (*ListCollectionsOutput, error)

ListCollections API operation for Amazon Rekognition.

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see list-collection-procedure.

This operation requires permissions to perform the rekognition:ListCollections action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation ListCollections for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

Example (Shared00)

To list the collections

This operation returns a list of Rekognition collections. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.ListCollectionsInput{}

	result, err := svc.ListCollections(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeInvalidPaginationTokenException:
				fmt.Println(rekognition.ErrCodeInvalidPaginationTokenException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) ListCollectionsPages 

func (c *Rekognition) ListCollectionsPages(input *ListCollectionsInput, fn func(*ListCollectionsOutput, bool) bool) error

ListCollectionsPages iterates over the pages of a ListCollections operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCollections method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListCollections operation.
pageNum := 0
err := client.ListCollectionsPages(params,
    func(page *ListCollectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) ListCollectionsPagesWithContext added in v1.8.0 

func (c *Rekognition) ListCollectionsPagesWithContext(ctx aws.Context, input *ListCollectionsInput, fn func(*ListCollectionsOutput, bool) bool, opts ...request.Option) error

ListCollectionsPagesWithContext same as ListCollectionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) ListCollectionsRequest 

func (c *Rekognition) ListCollectionsRequest(input *ListCollectionsInput) (req *request.Request, output *ListCollectionsOutput)

ListCollectionsRequest generates a "aws/request.Request" representing the client's request for the ListCollections operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCollections for more information on using the ListCollections API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListCollectionsRequest method.
req, resp := client.ListCollectionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) ListCollectionsWithContext added in v1.8.0 

func (c *Rekognition) ListCollectionsWithContext(ctx aws.Context, input *ListCollectionsInput, opts ...request.Option) (*ListCollectionsOutput, error)

ListCollectionsWithContext is the same as ListCollections with the addition of the ability to pass a context and additional request options.

See ListCollections for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) ListFaces 

func (c *Rekognition) ListFaces(input *ListFacesInput) (*ListFacesOutput, error)

ListFaces API operation for Amazon Rekognition.

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see list-faces-in-collection-procedure.

This operation requires permissions to perform the rekognition:ListFaces action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation ListFaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

Example (Shared00)

To list the faces in a collection

This operation lists the faces in a Rekognition collection. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.ListFacesInput{
		CollectionId: aws.String("myphotos"),
		MaxResults:   aws.Int64(20),
	}

	result, err := svc.ListFaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeInvalidPaginationTokenException:
				fmt.Println(rekognition.ErrCodeInvalidPaginationTokenException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) ListFacesPages 

func (c *Rekognition) ListFacesPages(input *ListFacesInput, fn func(*ListFacesOutput, bool) bool) error

ListFacesPages iterates over the pages of a ListFaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFaces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFaces operation.
pageNum := 0
err := client.ListFacesPages(params,
    func(page *ListFacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) ListFacesPagesWithContext added in v1.8.0 

func (c *Rekognition) ListFacesPagesWithContext(ctx aws.Context, input *ListFacesInput, fn func(*ListFacesOutput, bool) bool, opts ...request.Option) error

ListFacesPagesWithContext same as ListFacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) ListFacesRequest 

func (c *Rekognition) ListFacesRequest(input *ListFacesInput) (req *request.Request, output *ListFacesOutput)

ListFacesRequest generates a "aws/request.Request" representing the client's request for the ListFaces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFaces for more information on using the ListFaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFacesRequest method.
req, resp := client.ListFacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) ListFacesWithContext added in v1.8.0 

func (c *Rekognition) ListFacesWithContext(ctx aws.Context, input *ListFacesInput, opts ...request.Option) (*ListFacesOutput, error)

ListFacesWithContext is the same as ListFaces with the addition of the ability to pass a context and additional request options.

See ListFaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) ListStreamProcessors added in v1.12.36 

func (c *Rekognition) ListStreamProcessors(input *ListStreamProcessorsInput) (*ListStreamProcessorsOutput, error)

ListStreamProcessors API operation for Amazon Rekognition.

Gets a list of stream processors that you have created with .

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation ListStreamProcessors for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException" Pagination token in the request is not valid.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

func (*Rekognition) ListStreamProcessorsPages added in v1.12.36 

func (c *Rekognition) ListStreamProcessorsPages(input *ListStreamProcessorsInput, fn func(*ListStreamProcessorsOutput, bool) bool) error

ListStreamProcessorsPages iterates over the pages of a ListStreamProcessors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStreamProcessors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStreamProcessors operation.
pageNum := 0
err := client.ListStreamProcessorsPages(params,
    func(page *ListStreamProcessorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) ListStreamProcessorsPagesWithContext added in v1.12.36 

func (c *Rekognition) ListStreamProcessorsPagesWithContext(ctx aws.Context, input *ListStreamProcessorsInput, fn func(*ListStreamProcessorsOutput, bool) bool, opts ...request.Option) error

ListStreamProcessorsPagesWithContext same as ListStreamProcessorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) ListStreamProcessorsRequest added in v1.12.36 

func (c *Rekognition) ListStreamProcessorsRequest(input *ListStreamProcessorsInput) (req *request.Request, output *ListStreamProcessorsOutput)

ListStreamProcessorsRequest generates a "aws/request.Request" representing the client's request for the ListStreamProcessors operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStreamProcessors for more information on using the ListStreamProcessors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStreamProcessorsRequest method.
req, resp := client.ListStreamProcessorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) ListStreamProcessorsWithContext added in v1.12.36 

func (c *Rekognition) ListStreamProcessorsWithContext(ctx aws.Context, input *ListStreamProcessorsInput, opts ...request.Option) (*ListStreamProcessorsOutput, error)

ListStreamProcessorsWithContext is the same as ListStreamProcessors with the addition of the ability to pass a context and additional request options.

See ListStreamProcessors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) RecognizeCelebrities added in v1.8.38 

func (c *Rekognition) RecognizeCelebrities(input *RecognizeCelebritiesInput) (*RecognizeCelebritiesOutput, error)

RecognizeCelebrities API operation for Amazon Rekognition.

Returns an array of celebrities recognized in the input image. For more information, see celebrities.

RecognizeCelebrities returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces are not amongst the largest 100 faces in the image.

For each celebrity recognized, the RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image.

Rekognition does not retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the operation.

You pass the imput image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For an example, see celebrities-procedure-image.

This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation RecognizeCelebrities for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

func (*Rekognition) RecognizeCelebritiesRequest added in v1.8.38 

func (c *Rekognition) RecognizeCelebritiesRequest(input *RecognizeCelebritiesInput) (req *request.Request, output *RecognizeCelebritiesOutput)

RecognizeCelebritiesRequest generates a "aws/request.Request" representing the client's request for the RecognizeCelebrities operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RecognizeCelebrities for more information on using the RecognizeCelebrities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RecognizeCelebritiesRequest method.
req, resp := client.RecognizeCelebritiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) RecognizeCelebritiesWithContext added in v1.8.38 

func (c *Rekognition) RecognizeCelebritiesWithContext(ctx aws.Context, input *RecognizeCelebritiesInput, opts ...request.Option) (*RecognizeCelebritiesOutput, error)

RecognizeCelebritiesWithContext is the same as RecognizeCelebrities with the addition of the ability to pass a context and additional request options.

See RecognizeCelebrities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) SearchFaces 

func (c *Rekognition) SearchFaces(input *SearchFacesInput) (*SearchFacesOutput, error)

SearchFaces API operation for Amazon Rekognition.

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see search-face-with-id-procedure.

This operation requires permissions to perform the rekognition:SearchFaces action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation SearchFaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

Example (Shared00)

To delete a face

This operation searches for matching faces in the collection the supplied face belongs to. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.SearchFacesInput{
		CollectionId:       aws.String("myphotos"),
		FaceId:             aws.String("70008e50-75e4-55d0-8e80-363fb73b3a14"),
		FaceMatchThreshold: aws.Float64(90.000000),
		MaxFaces:           aws.Int64(10),
	}

	result, err := svc.SearchFaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) SearchFacesByImage 

func (c *Rekognition) SearchFacesByImage(input *SearchFacesByImageInput) (*SearchFacesByImageOutput, error)

SearchFacesByImage API operation for Amazon Rekognition.

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation. 

You can also call the DetectFaces operation and use the bounding boxes in

the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

For an example, see search-face-with-image-procedure.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation SearchFacesByImage for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeImageTooLargeException "ImageTooLargeException" The input image size exceeds the allowed limit. For more information, see limits.

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeInvalidImageFormatException "InvalidImageFormatException" The provided image format is not supported.

Example (Shared00)

To search for faces matching a supplied image

This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rekognition"
)

func main() {
	svc := rekognition.New(session.New())
	input := &rekognition.SearchFacesByImageInput{
		CollectionId:       aws.String("myphotos"),
		FaceMatchThreshold: aws.Float64(95.000000),
		Image: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("myphoto"),
			},
		},
		MaxFaces: aws.Int64(5),
	}

	result, err := svc.SearchFacesByImage(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rekognition.ErrCodeInvalidS3ObjectException:
				fmt.Println(rekognition.ErrCodeInvalidS3ObjectException, aerr.Error())
			case rekognition.ErrCodeInvalidParameterException:
				fmt.Println(rekognition.ErrCodeInvalidParameterException, aerr.Error())
			case rekognition.ErrCodeImageTooLargeException:
				fmt.Println(rekognition.ErrCodeImageTooLargeException, aerr.Error())
			case rekognition.ErrCodeAccessDeniedException:
				fmt.Println(rekognition.ErrCodeAccessDeniedException, aerr.Error())
			case rekognition.ErrCodeInternalServerError:
				fmt.Println(rekognition.ErrCodeInternalServerError, aerr.Error())
			case rekognition.ErrCodeThrottlingException:
				fmt.Println(rekognition.ErrCodeThrottlingException, aerr.Error())
			case rekognition.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(rekognition.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case rekognition.ErrCodeResourceNotFoundException:
				fmt.Println(rekognition.ErrCodeResourceNotFoundException, aerr.Error())
			case rekognition.ErrCodeInvalidImageFormatException:
				fmt.Println(rekognition.ErrCodeInvalidImageFormatException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Rekognition) SearchFacesByImageRequest 

func (c *Rekognition) SearchFacesByImageRequest(input *SearchFacesByImageInput) (req *request.Request, output *SearchFacesByImageOutput)

SearchFacesByImageRequest generates a "aws/request.Request" representing the client's request for the SearchFacesByImage operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchFacesByImage for more information on using the SearchFacesByImage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchFacesByImageRequest method.
req, resp := client.SearchFacesByImageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) SearchFacesByImageWithContext added in v1.8.0 

func (c *Rekognition) SearchFacesByImageWithContext(ctx aws.Context, input *SearchFacesByImageInput, opts ...request.Option) (*SearchFacesByImageOutput, error)

SearchFacesByImageWithContext is the same as SearchFacesByImage with the addition of the ability to pass a context and additional request options.

See SearchFacesByImage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) SearchFacesRequest 

func (c *Rekognition) SearchFacesRequest(input *SearchFacesInput) (req *request.Request, output *SearchFacesOutput)

SearchFacesRequest generates a "aws/request.Request" representing the client's request for the SearchFaces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchFaces for more information on using the SearchFaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchFacesRequest method.
req, resp := client.SearchFacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) SearchFacesWithContext added in v1.8.0 

func (c *Rekognition) SearchFacesWithContext(ctx aws.Context, input *SearchFacesInput, opts ...request.Option) (*SearchFacesOutput, error)

SearchFacesWithContext is the same as SearchFaces with the addition of the ability to pass a context and additional request options.

See SearchFaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartCelebrityRecognition added in v1.12.36 

func (c *Rekognition) StartCelebrityRecognition(input *StartCelebrityRecognitionInput) (*StartCelebrityRecognitionOutput, error)

StartCelebrityRecognition API operation for Amazon Rekognition.

Starts asynchronous recognition of celebrities in a stored video.

Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For more information, see celebrities.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartCelebrityRecognition for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeVideoTooLargeException "VideoTooLargeException" The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) StartCelebrityRecognitionRequest added in v1.12.36 

func (c *Rekognition) StartCelebrityRecognitionRequest(input *StartCelebrityRecognitionInput) (req *request.Request, output *StartCelebrityRecognitionOutput)

StartCelebrityRecognitionRequest generates a "aws/request.Request" representing the client's request for the StartCelebrityRecognition operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartCelebrityRecognition for more information on using the StartCelebrityRecognition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartCelebrityRecognitionRequest method.
req, resp := client.StartCelebrityRecognitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartCelebrityRecognitionWithContext added in v1.12.36 

func (c *Rekognition) StartCelebrityRecognitionWithContext(ctx aws.Context, input *StartCelebrityRecognitionInput, opts ...request.Option) (*StartCelebrityRecognitionOutput, error)

StartCelebrityRecognitionWithContext is the same as StartCelebrityRecognition with the addition of the ability to pass a context and additional request options.

See StartCelebrityRecognition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartContentModeration added in v1.12.36 

func (c *Rekognition) StartContentModeration(input *StartContentModerationInput) (*StartContentModerationOutput, error)

StartContentModeration API operation for Amazon Rekognition.

Starts asynchronous detection of explicit or suggestive adult content in a stored video.

Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content moderation analysis is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see moderation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartContentModeration for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeVideoTooLargeException "VideoTooLargeException" The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) StartContentModerationRequest added in v1.12.36 

func (c *Rekognition) StartContentModerationRequest(input *StartContentModerationInput) (req *request.Request, output *StartContentModerationOutput)

StartContentModerationRequest generates a "aws/request.Request" representing the client's request for the StartContentModeration operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartContentModeration for more information on using the StartContentModeration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartContentModerationRequest method.
req, resp := client.StartContentModerationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartContentModerationWithContext added in v1.12.36 

func (c *Rekognition) StartContentModerationWithContext(ctx aws.Context, input *StartContentModerationInput, opts ...request.Option) (*StartContentModerationOutput, error)

StartContentModerationWithContext is the same as StartContentModeration with the addition of the ability to pass a context and additional request options.

See StartContentModeration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartFaceDetection added in v1.12.36 

func (c *Rekognition) StartFaceDetection(input *StartFaceDetectionInput) (*StartFaceDetectionOutput, error)

StartFaceDetection API operation for Amazon Rekognition.

Starts asynchronous detection of faces in a stored video.

Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartFaceDetection. For more information, see faces-video.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartFaceDetection for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeVideoTooLargeException "VideoTooLargeException" The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) StartFaceDetectionRequest added in v1.12.36 

func (c *Rekognition) StartFaceDetectionRequest(input *StartFaceDetectionInput) (req *request.Request, output *StartFaceDetectionOutput)

StartFaceDetectionRequest generates a "aws/request.Request" representing the client's request for the StartFaceDetection operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFaceDetection for more information on using the StartFaceDetection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartFaceDetectionRequest method.
req, resp := client.StartFaceDetectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartFaceDetectionWithContext added in v1.12.36 

func (c *Rekognition) StartFaceDetectionWithContext(ctx aws.Context, input *StartFaceDetectionInput, opts ...request.Option) (*StartFaceDetectionOutput, error)

StartFaceDetectionWithContext is the same as StartFaceDetection with the addition of the ability to pass a context and additional request options.

See StartFaceDetection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartFaceSearch added in v1.12.36 

func (c *Rekognition) StartFaceSearch(input *StartFaceSearchInput) (*StartFaceSearchOutput, error)

StartFaceSearch API operation for Amazon Rekognition.

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see collections-search-person.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartFaceSearch for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeVideoTooLargeException "VideoTooLargeException" The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) StartFaceSearchRequest added in v1.12.36 

func (c *Rekognition) StartFaceSearchRequest(input *StartFaceSearchInput) (req *request.Request, output *StartFaceSearchOutput)

StartFaceSearchRequest generates a "aws/request.Request" representing the client's request for the StartFaceSearch operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFaceSearch for more information on using the StartFaceSearch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartFaceSearchRequest method.
req, resp := client.StartFaceSearchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartFaceSearchWithContext added in v1.12.36 

func (c *Rekognition) StartFaceSearchWithContext(ctx aws.Context, input *StartFaceSearchInput, opts ...request.Option) (*StartFaceSearchOutput, error)

StartFaceSearchWithContext is the same as StartFaceSearch with the addition of the ability to pass a context and additional request options.

See StartFaceSearch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartLabelDetection added in v1.12.36 

func (c *Rekognition) StartLabelDetection(input *StartLabelDetectionInput) (*StartLabelDetectionOutput, error)

StartLabelDetection API operation for Amazon Rekognition.

Starts asynchronous detection of labels in a stored video.

Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartLabelDetection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartLabelDetection for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeVideoTooLargeException "VideoTooLargeException" The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) StartLabelDetectionRequest added in v1.12.36 

func (c *Rekognition) StartLabelDetectionRequest(input *StartLabelDetectionInput) (req *request.Request, output *StartLabelDetectionOutput)

StartLabelDetectionRequest generates a "aws/request.Request" representing the client's request for the StartLabelDetection operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartLabelDetection for more information on using the StartLabelDetection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartLabelDetectionRequest method.
req, resp := client.StartLabelDetectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartLabelDetectionWithContext added in v1.12.36 

func (c *Rekognition) StartLabelDetectionWithContext(ctx aws.Context, input *StartLabelDetectionInput, opts ...request.Option) (*StartLabelDetectionOutput, error)

StartLabelDetectionWithContext is the same as StartLabelDetection with the addition of the ability to pass a context and additional request options.

See StartLabelDetection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartPersonTracking added in v1.12.36 

func (c *Rekognition) StartPersonTracking(input *StartPersonTrackingInput) (*StartPersonTrackingOutput, error)

StartPersonTracking API operation for Amazon Rekognition.

Starts the asynchronous tracking of persons in a stored video.

Rekognition Video can track persons in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartPersonTracking.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartPersonTracking for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeInvalidS3ObjectException "InvalidS3ObjectException" Amazon Rekognition is unable to access the S3 object specified in the request.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeVideoTooLargeException "VideoTooLargeException" The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

  • ErrCodeLimitExceededException "LimitExceededException" An Amazon Rekognition service limit was exceeded. For example, if you start too many Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*Rekognition) StartPersonTrackingRequest added in v1.12.36 

func (c *Rekognition) StartPersonTrackingRequest(input *StartPersonTrackingInput) (req *request.Request, output *StartPersonTrackingOutput)

StartPersonTrackingRequest generates a "aws/request.Request" representing the client's request for the StartPersonTracking operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartPersonTracking for more information on using the StartPersonTracking API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartPersonTrackingRequest method.
req, resp := client.StartPersonTrackingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartPersonTrackingWithContext added in v1.12.36 

func (c *Rekognition) StartPersonTrackingWithContext(ctx aws.Context, input *StartPersonTrackingInput, opts ...request.Option) (*StartPersonTrackingOutput, error)

StartPersonTrackingWithContext is the same as StartPersonTracking with the addition of the ability to pass a context and additional request options.

See StartPersonTracking for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StartStreamProcessor added in v1.12.36 

func (c *Rekognition) StartStreamProcessor(input *StartStreamProcessorInput) (*StartStreamProcessorOutput, error)

StartStreamProcessor API operation for Amazon Rekognition.

Starts processing a stream processor. You create a stream processor by calling . To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StartStreamProcessor for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeResourceInUseException "ResourceInUseException"

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

func (*Rekognition) StartStreamProcessorRequest added in v1.12.36 

func (c *Rekognition) StartStreamProcessorRequest(input *StartStreamProcessorInput) (req *request.Request, output *StartStreamProcessorOutput)

StartStreamProcessorRequest generates a "aws/request.Request" representing the client's request for the StartStreamProcessor operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartStreamProcessor for more information on using the StartStreamProcessor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartStreamProcessorRequest method.
req, resp := client.StartStreamProcessorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StartStreamProcessorWithContext added in v1.12.36 

func (c *Rekognition) StartStreamProcessorWithContext(ctx aws.Context, input *StartStreamProcessorInput, opts ...request.Option) (*StartStreamProcessorOutput, error)

StartStreamProcessorWithContext is the same as StartStreamProcessor with the addition of the ability to pass a context and additional request options.

See StartStreamProcessor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Rekognition) StopStreamProcessor added in v1.12.36 

func (c *Rekognition) StopStreamProcessor(input *StopStreamProcessorInput) (*StopStreamProcessorOutput, error)

StopStreamProcessor API operation for Amazon Rekognition.

Stops a running stream processor that was created by .

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Rekognition's API operation StopStreamProcessor for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You are not authorized to perform the action.

  • ErrCodeInternalServerError "InternalServerError" Amazon Rekognition experienced a service issue. Try your call again.

  • ErrCodeThrottlingException "ThrottlingException" Amazon Rekognition is temporarily unable to process the request. Try your call again.

  • ErrCodeInvalidParameterException "InvalidParameterException" Input parameter violated a constraint. Validate your parameter before calling the API operation again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The collection specified in the request cannot be found.

  • ErrCodeResourceInUseException "ResourceInUseException"

  • ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

func (*Rekognition) StopStreamProcessorRequest added in v1.12.36 

func (c *Rekognition) StopStreamProcessorRequest(input *StopStreamProcessorInput) (req *request.Request, output *StopStreamProcessorOutput)

StopStreamProcessorRequest generates a "aws/request.Request" representing the client's request for the StopStreamProcessor operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopStreamProcessor for more information on using the StopStreamProcessor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopStreamProcessorRequest method.
req, resp := client.StopStreamProcessorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Rekognition) StopStreamProcessorWithContext added in v1.12.36 

func (c *Rekognition) StopStreamProcessorWithContext(ctx aws.Context, input *StopStreamProcessorInput, opts ...request.Option) (*StopStreamProcessorOutput, error)

StopStreamProcessorWithContext is the same as StopStreamProcessor with the addition of the ability to pass a context and additional request options.

See StopStreamProcessor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type S3Object 

type S3Object struct {

	// Name of the S3 bucket.
	Bucket *string `min:"3" type:"string"`

	// S3 object key name.
	Name *string `min:"1" type:"string"`

	// If the bucket is versioning enabled, you can specify the object version.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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 manage-access-resource-policies.

func (S3Object) GoString 

func (s S3Object) GoString() string

GoString returns the string representation

func (*S3Object) SetBucket 

func (s *S3Object) SetBucket(v string) *S3Object

SetBucket sets the Bucket field's value.

func (*S3Object) SetName 

func (s *S3Object) SetName(v string) *S3Object

SetName sets the Name field's value.

func (*S3Object) SetVersion 

func (s *S3Object) SetVersion(v string) *S3Object

SetVersion sets the Version field's value.

func (S3Object) String 

func (s S3Object) String() string

String returns the string representation

func (*S3Object) Validate 

func (s *S3Object) Validate() error

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

type SearchFacesByImageInput 

type SearchFacesByImageInput struct {

	// ID of the collection to search.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// (Optional) Specifies the minimum confidence in the face match to return.
	// For example, don't return any matches where confidence in matches is less
	// than 70%.
	FaceMatchThreshold *float64 `type:"float"`

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

	// Maximum number of faces to return. The operation returns the maximum number
	// of faces with the highest confidence in the match.
	MaxFaces *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (SearchFacesByImageInput) GoString 

func (s SearchFacesByImageInput) GoString() string

GoString returns the string representation

func (*SearchFacesByImageInput) SetCollectionId 

func (s *SearchFacesByImageInput) SetCollectionId(v string) *SearchFacesByImageInput

SetCollectionId sets the CollectionId field's value.

func (*SearchFacesByImageInput) SetFaceMatchThreshold 

func (s *SearchFacesByImageInput) SetFaceMatchThreshold(v float64) *SearchFacesByImageInput

SetFaceMatchThreshold sets the FaceMatchThreshold field's value.

func (*SearchFacesByImageInput) SetImage 

func (s *SearchFacesByImageInput) SetImage(v *Image) *SearchFacesByImageInput

SetImage sets the Image field's value.

func (*SearchFacesByImageInput) SetMaxFaces 

func (s *SearchFacesByImageInput) SetMaxFaces(v int64) *SearchFacesByImageInput

SetMaxFaces sets the MaxFaces field's value.

func (SearchFacesByImageInput) String 

func (s SearchFacesByImageInput) String() string

String returns the string representation

func (*SearchFacesByImageInput) Validate 

func (s *SearchFacesByImageInput) Validate() error

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

type SearchFacesByImageOutput 

type SearchFacesByImageOutput struct {

	// An array of faces that match the input face, along with the confidence in
	// the match.
	FaceMatches []*FaceMatch `type:"list"`

	// Version number of the face detection model associated with the input collection
	// (CollectionId).
	FaceModelVersion *string `type:"string"`

	// The bounding box around the face in the input image that Amazon Rekognition
	// used for the search.
	SearchedFaceBoundingBox *BoundingBox `type:"structure"`

	// The level of confidence that the searchedFaceBoundingBox, contains a face.
	SearchedFaceConfidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (SearchFacesByImageOutput) GoString 

func (s SearchFacesByImageOutput) GoString() string

GoString returns the string representation

func (*SearchFacesByImageOutput) SetFaceMatches 

func (s *SearchFacesByImageOutput) SetFaceMatches(v []*FaceMatch) *SearchFacesByImageOutput

SetFaceMatches sets the FaceMatches field's value.

func (*SearchFacesByImageOutput) SetFaceModelVersion added in v1.12.32 

func (s *SearchFacesByImageOutput) SetFaceModelVersion(v string) *SearchFacesByImageOutput

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*SearchFacesByImageOutput) SetSearchedFaceBoundingBox 

func (s *SearchFacesByImageOutput) SetSearchedFaceBoundingBox(v *BoundingBox) *SearchFacesByImageOutput

SetSearchedFaceBoundingBox sets the SearchedFaceBoundingBox field's value.

func (*SearchFacesByImageOutput) SetSearchedFaceConfidence 

func (s *SearchFacesByImageOutput) SetSearchedFaceConfidence(v float64) *SearchFacesByImageOutput

SetSearchedFaceConfidence sets the SearchedFaceConfidence field's value.

func (SearchFacesByImageOutput) String 

func (s SearchFacesByImageOutput) String() string

String returns the string representation

type SearchFacesInput 

type SearchFacesInput struct {

	// ID of the collection the face belongs to.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// ID of a face to find matches for in the collection.
	//
	// FaceId is a required field
	FaceId *string `type:"string" required:"true"`

	// Optional value specifying the minimum confidence in the face match to return.
	// For example, don't return any matches where confidence in matches is less
	// than 70%.
	FaceMatchThreshold *float64 `type:"float"`

	// Maximum number of faces to return. The operation returns the maximum number
	// of faces with the highest confidence in the match.
	MaxFaces *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (SearchFacesInput) GoString 

func (s SearchFacesInput) GoString() string

GoString returns the string representation

func (*SearchFacesInput) SetCollectionId 

func (s *SearchFacesInput) SetCollectionId(v string) *SearchFacesInput

SetCollectionId sets the CollectionId field's value.

func (*SearchFacesInput) SetFaceId 

func (s *SearchFacesInput) SetFaceId(v string) *SearchFacesInput

SetFaceId sets the FaceId field's value.

func (*SearchFacesInput) SetFaceMatchThreshold 

func (s *SearchFacesInput) SetFaceMatchThreshold(v float64) *SearchFacesInput

SetFaceMatchThreshold sets the FaceMatchThreshold field's value.

func (*SearchFacesInput) SetMaxFaces 

func (s *SearchFacesInput) SetMaxFaces(v int64) *SearchFacesInput

SetMaxFaces sets the MaxFaces field's value.

func (SearchFacesInput) String 

func (s SearchFacesInput) String() string

String returns the string representation

func (*SearchFacesInput) Validate 

func (s *SearchFacesInput) Validate() error

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

type SearchFacesOutput 

type SearchFacesOutput struct {

	// An array of faces that matched the input face, along with the confidence
	// in the match.
	FaceMatches []*FaceMatch `type:"list"`

	// Version number of the face detection model associated with the input collection
	// (CollectionId).
	FaceModelVersion *string `type:"string"`

	// ID of the face that was searched for matches in a collection.
	SearchedFaceId *string `type:"string"`
	// contains filtered or unexported fields
}

func (SearchFacesOutput) GoString 

func (s SearchFacesOutput) GoString() string

GoString returns the string representation

func (*SearchFacesOutput) SetFaceMatches 

func (s *SearchFacesOutput) SetFaceMatches(v []*FaceMatch) *SearchFacesOutput

SetFaceMatches sets the FaceMatches field's value.

func (*SearchFacesOutput) SetFaceModelVersion added in v1.12.32 

func (s *SearchFacesOutput) SetFaceModelVersion(v string) *SearchFacesOutput

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*SearchFacesOutput) SetSearchedFaceId 

func (s *SearchFacesOutput) SetSearchedFaceId(v string) *SearchFacesOutput

SetSearchedFaceId sets the SearchedFaceId field's value.

func (SearchFacesOutput) String 

func (s SearchFacesOutput) String() string

String returns the string representation

type Smile 

type Smile struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the face is smiling or not.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the face is smiling, and the confidence level in the determination.

func (Smile) GoString 

func (s Smile) GoString() string

GoString returns the string representation

func (*Smile) SetConfidence 

func (s *Smile) SetConfidence(v float64) *Smile

SetConfidence sets the Confidence field's value.

func (*Smile) SetValue 

func (s *Smile) SetValue(v bool) *Smile

SetValue sets the Value field's value.

func (Smile) String 

func (s Smile) String() string

String returns the string representation

type StartCelebrityRecognitionInput added in v1.12.36 

type StartCelebrityRecognitionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartCelebrityRecognition requests, the same JobId is
	// returned. Use ClientRequestToken to prevent the same job from being accidently
	// started more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// Unique identifier you specify to identify the job in the completion status
	// published to the Amazon Simple Notification Service topic.
	JobTag *string `min:"1" type:"string"`

	// The Amazon SNS topic ARN that you want Rekognition Video to publish the completion
	// status of the celebrity recognition analysis to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to recognize celebrities. The video must be stored
	// in an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartCelebrityRecognitionInput) GoString added in v1.12.36 

func (s StartCelebrityRecognitionInput) GoString() string

GoString returns the string representation

func (*StartCelebrityRecognitionInput) SetClientRequestToken added in v1.12.36 

func (s *StartCelebrityRecognitionInput) SetClientRequestToken(v string) *StartCelebrityRecognitionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartCelebrityRecognitionInput) SetJobTag added in v1.12.36 

func (s *StartCelebrityRecognitionInput) SetJobTag(v string) *StartCelebrityRecognitionInput

SetJobTag sets the JobTag field's value.

func (*StartCelebrityRecognitionInput) SetNotificationChannel added in v1.12.36 

func (s *StartCelebrityRecognitionInput) SetNotificationChannel(v *NotificationChannel) *StartCelebrityRecognitionInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartCelebrityRecognitionInput) SetVideo added in v1.12.36 

func (s *StartCelebrityRecognitionInput) SetVideo(v *Video) *StartCelebrityRecognitionInput

SetVideo sets the Video field's value.

func (StartCelebrityRecognitionInput) String added in v1.12.36 

func (s StartCelebrityRecognitionInput) String() string

String returns the string representation

func (*StartCelebrityRecognitionInput) Validate added in v1.12.36 

func (s *StartCelebrityRecognitionInput) Validate() error

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

type StartCelebrityRecognitionOutput added in v1.12.36 

type StartCelebrityRecognitionOutput struct {

	// The identifier for the celebrity recognition analysis job. Use JobId to identify
	// the job in a subsequent call to GetCelebrityRecognition.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartCelebrityRecognitionOutput) GoString added in v1.12.36 

func (s StartCelebrityRecognitionOutput) GoString() string

GoString returns the string representation

func (*StartCelebrityRecognitionOutput) SetJobId added in v1.12.36 

func (s *StartCelebrityRecognitionOutput) SetJobId(v string) *StartCelebrityRecognitionOutput

SetJobId sets the JobId field's value.

func (StartCelebrityRecognitionOutput) String added in v1.12.36 

func (s StartCelebrityRecognitionOutput) String() string

String returns the string representation

type StartContentModerationInput added in v1.12.36 

type StartContentModerationInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartContentModeration requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// Unique identifier you specify to identify the job in the completion status
	// published to the Amazon Simple Notification Service topic.
	JobTag *string `min:"1" type:"string"`

	// Specifies the minimum confidence that Amazon Rekognition must have in order
	// to return a moderated content label. Confidence represents how certain Amazon
	// Rekognition is that the moderated content is correctly identified. 0 is the
	// lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't
	// return any moderated content labels with a confidence level lower than this
	// specified value.
	MinConfidence *float64 `type:"float"`

	// The Amazon SNS topic ARN that you want Rekognition Video to publish the completion
	// status of the content moderation analysis to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to moderate content. The video must be stored
	// in an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartContentModerationInput) GoString added in v1.12.36 

func (s StartContentModerationInput) GoString() string

GoString returns the string representation

func (*StartContentModerationInput) SetClientRequestToken added in v1.12.36 

func (s *StartContentModerationInput) SetClientRequestToken(v string) *StartContentModerationInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartContentModerationInput) SetJobTag added in v1.12.36 

func (s *StartContentModerationInput) SetJobTag(v string) *StartContentModerationInput

SetJobTag sets the JobTag field's value.

func (*StartContentModerationInput) SetMinConfidence added in v1.12.36 

func (s *StartContentModerationInput) SetMinConfidence(v float64) *StartContentModerationInput

SetMinConfidence sets the MinConfidence field's value.

func (*StartContentModerationInput) SetNotificationChannel added in v1.12.36 

func (s *StartContentModerationInput) SetNotificationChannel(v *NotificationChannel) *StartContentModerationInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartContentModerationInput) SetVideo added in v1.12.36 

func (s *StartContentModerationInput) SetVideo(v *Video) *StartContentModerationInput

SetVideo sets the Video field's value.

func (StartContentModerationInput) String added in v1.12.36 

func (s StartContentModerationInput) String() string

String returns the string representation

func (*StartContentModerationInput) Validate added in v1.12.36 

func (s *StartContentModerationInput) Validate() error

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

type StartContentModerationOutput added in v1.12.36 

type StartContentModerationOutput struct {

	// The identifier for the content moderation analysis job. Use JobId to identify
	// the job in a subsequent call to GetContentModeration.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartContentModerationOutput) GoString added in v1.12.36 

func (s StartContentModerationOutput) GoString() string

GoString returns the string representation

func (*StartContentModerationOutput) SetJobId added in v1.12.36 

func (s *StartContentModerationOutput) SetJobId(v string) *StartContentModerationOutput

SetJobId sets the JobId field's value.

func (StartContentModerationOutput) String added in v1.12.36 

func (s StartContentModerationOutput) String() string

String returns the string representation

type StartFaceDetectionInput added in v1.12.36 

type StartFaceDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartFaceDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// The face attributes you want returned.
	//
	// DEFAULT - The following subset of facial attributes are returned: BoundingBox,
	// Confidence, Pose, Quality and Landmarks.
	//
	// ALL - All facial attributes are returned.
	FaceAttributes *string `type:"string" enum:"FaceAttributes"`

	// Unique identifier you specify to identify the job in the completion status
	// published to the Amazon Simple Notification Service topic.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Rekognition Video to publish
	// the completion status of the face detection operation.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect faces. The video must be stored in
	// an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartFaceDetectionInput) GoString added in v1.12.36 

func (s StartFaceDetectionInput) GoString() string

GoString returns the string representation

func (*StartFaceDetectionInput) SetClientRequestToken added in v1.12.36 

func (s *StartFaceDetectionInput) SetClientRequestToken(v string) *StartFaceDetectionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartFaceDetectionInput) SetFaceAttributes added in v1.12.36 

func (s *StartFaceDetectionInput) SetFaceAttributes(v string) *StartFaceDetectionInput

SetFaceAttributes sets the FaceAttributes field's value.

func (*StartFaceDetectionInput) SetJobTag added in v1.12.36 

func (s *StartFaceDetectionInput) SetJobTag(v string) *StartFaceDetectionInput

SetJobTag sets the JobTag field's value.

func (*StartFaceDetectionInput) SetNotificationChannel added in v1.12.36 

func (s *StartFaceDetectionInput) SetNotificationChannel(v *NotificationChannel) *StartFaceDetectionInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartFaceDetectionInput) SetVideo added in v1.12.36 

func (s *StartFaceDetectionInput) SetVideo(v *Video) *StartFaceDetectionInput

SetVideo sets the Video field's value.

func (StartFaceDetectionInput) String added in v1.12.36 

func (s StartFaceDetectionInput) String() string

String returns the string representation

func (*StartFaceDetectionInput) Validate added in v1.12.36 

func (s *StartFaceDetectionInput) Validate() error

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

type StartFaceDetectionOutput added in v1.12.36 

type StartFaceDetectionOutput struct {

	// The identifier for the face detection job. Use JobId to identify the job
	// in a subsequent call to GetFaceDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartFaceDetectionOutput) GoString added in v1.12.36 

func (s StartFaceDetectionOutput) GoString() string

GoString returns the string representation

func (*StartFaceDetectionOutput) SetJobId added in v1.12.36 

func (s *StartFaceDetectionOutput) SetJobId(v string) *StartFaceDetectionOutput

SetJobId sets the JobId field's value.

func (StartFaceDetectionOutput) String added in v1.12.36 

func (s StartFaceDetectionOutput) String() string

String returns the string representation

type StartFaceSearchInput added in v1.12.36 

type StartFaceSearchInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartFaceSearch requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// ID of the collection that contains the faces you want to search for.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// The minimum confidence in the person match to return. For example, don't
	// return any matches where confidence in matches is less than 70%.
	FaceMatchThreshold *float64 `type:"float"`

	// Unique identifier you specify to identify the job in the completion status
	// published to the Amazon Simple Notification Service topic.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Rekognition Video to publish
	// the completion status of the search.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video you want to search. The video must be stored in an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartFaceSearchInput) GoString added in v1.12.36 

func (s StartFaceSearchInput) GoString() string

GoString returns the string representation

func (*StartFaceSearchInput) SetClientRequestToken added in v1.12.36 

func (s *StartFaceSearchInput) SetClientRequestToken(v string) *StartFaceSearchInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartFaceSearchInput) SetCollectionId added in v1.12.36 

func (s *StartFaceSearchInput) SetCollectionId(v string) *StartFaceSearchInput

SetCollectionId sets the CollectionId field's value.

func (*StartFaceSearchInput) SetFaceMatchThreshold added in v1.12.36 

func (s *StartFaceSearchInput) SetFaceMatchThreshold(v float64) *StartFaceSearchInput

SetFaceMatchThreshold sets the FaceMatchThreshold field's value.

func (*StartFaceSearchInput) SetJobTag added in v1.12.36 

func (s *StartFaceSearchInput) SetJobTag(v string) *StartFaceSearchInput

SetJobTag sets the JobTag field's value.

func (*StartFaceSearchInput) SetNotificationChannel added in v1.12.36 

func (s *StartFaceSearchInput) SetNotificationChannel(v *NotificationChannel) *StartFaceSearchInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartFaceSearchInput) SetVideo added in v1.12.36 

func (s *StartFaceSearchInput) SetVideo(v *Video) *StartFaceSearchInput

SetVideo sets the Video field's value.

func (StartFaceSearchInput) String added in v1.12.36 

func (s StartFaceSearchInput) String() string

String returns the string representation

func (*StartFaceSearchInput) Validate added in v1.12.36 

func (s *StartFaceSearchInput) Validate() error

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

type StartFaceSearchOutput added in v1.12.36 

type StartFaceSearchOutput struct {

	// The identifier for the search job. Use JobId to identify the job in a subsequent
	// call to GetFaceSearch.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartFaceSearchOutput) GoString added in v1.12.36 

func (s StartFaceSearchOutput) GoString() string

GoString returns the string representation

func (*StartFaceSearchOutput) SetJobId added in v1.12.36 

func (s *StartFaceSearchOutput) SetJobId(v string) *StartFaceSearchOutput

SetJobId sets the JobId field's value.

func (StartFaceSearchOutput) String added in v1.12.36 

func (s StartFaceSearchOutput) String() string

String returns the string representation

type StartLabelDetectionInput added in v1.12.36 

type StartLabelDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartLabelDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// Unique identifier you specify to identify the job in the completion status
	// published to the Amazon Simple Notification Service topic.
	JobTag *string `min:"1" type:"string"`

	// Specifies the minimum confidence that Rekognition Video must have in order
	// to return a detected label. Confidence represents how certain Amazon Rekognition
	// is that a label is correctly identified.0 is the lowest confidence. 100 is
	// the highest confidence. Rekognition Video doesn't return any labels with
	// a confidence level lower than this specified value.
	//
	// If you don't specify MinConfidence, the operation returns labels with confidence
	// values greater than or equal to 50 percent.
	MinConfidence *float64 `type:"float"`

	// The Amazon SNS topic ARN you want Rekognition Video to publish the completion
	// status of the label detection operation to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect labels. The video must be stored in
	// an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartLabelDetectionInput) GoString added in v1.12.36 

func (s StartLabelDetectionInput) GoString() string

GoString returns the string representation

func (*StartLabelDetectionInput) SetClientRequestToken added in v1.12.36 

func (s *StartLabelDetectionInput) SetClientRequestToken(v string) *StartLabelDetectionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartLabelDetectionInput) SetJobTag added in v1.12.36 

func (s *StartLabelDetectionInput) SetJobTag(v string) *StartLabelDetectionInput

SetJobTag sets the JobTag field's value.

func (*StartLabelDetectionInput) SetMinConfidence added in v1.12.36 

func (s *StartLabelDetectionInput) SetMinConfidence(v float64) *StartLabelDetectionInput

SetMinConfidence sets the MinConfidence field's value.

func (*StartLabelDetectionInput) SetNotificationChannel added in v1.12.36 

func (s *StartLabelDetectionInput) SetNotificationChannel(v *NotificationChannel) *StartLabelDetectionInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartLabelDetectionInput) SetVideo added in v1.12.36 

func (s *StartLabelDetectionInput) SetVideo(v *Video) *StartLabelDetectionInput

SetVideo sets the Video field's value.

func (StartLabelDetectionInput) String added in v1.12.36 

func (s StartLabelDetectionInput) String() string

String returns the string representation

func (*StartLabelDetectionInput) Validate added in v1.12.36 

func (s *StartLabelDetectionInput) Validate() error

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

type StartLabelDetectionOutput added in v1.12.36 

type StartLabelDetectionOutput struct {

	// The identifier for the label detection job. Use JobId to identify the job
	// in a subsequent call to GetLabelDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartLabelDetectionOutput) GoString added in v1.12.36 

func (s StartLabelDetectionOutput) GoString() string

GoString returns the string representation

func (*StartLabelDetectionOutput) SetJobId added in v1.12.36 

func (s *StartLabelDetectionOutput) SetJobId(v string) *StartLabelDetectionOutput

SetJobId sets the JobId field's value.

func (StartLabelDetectionOutput) String added in v1.12.36 

func (s StartLabelDetectionOutput) String() string

String returns the string representation

type StartPersonTrackingInput added in v1.12.36 

type StartPersonTrackingInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartPersonTracking requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// Unique identifier you specify to identify the job in the completion status
	// published to the Amazon Simple Notification Service topic.
	JobTag *string `min:"1" type:"string"`

	// The Amazon SNS topic ARN you want Rekognition Video to publish the completion
	// status of the people detection operation to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect people. The video must be stored in
	// an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartPersonTrackingInput) GoString added in v1.12.36 

func (s StartPersonTrackingInput) GoString() string

GoString returns the string representation

func (*StartPersonTrackingInput) SetClientRequestToken added in v1.12.36 

func (s *StartPersonTrackingInput) SetClientRequestToken(v string) *StartPersonTrackingInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartPersonTrackingInput) SetJobTag added in v1.12.36 

func (s *StartPersonTrackingInput) SetJobTag(v string) *StartPersonTrackingInput

SetJobTag sets the JobTag field's value.

func (*StartPersonTrackingInput) SetNotificationChannel added in v1.12.36 

func (s *StartPersonTrackingInput) SetNotificationChannel(v *NotificationChannel) *StartPersonTrackingInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartPersonTrackingInput) SetVideo added in v1.12.36 

func (s *StartPersonTrackingInput) SetVideo(v *Video) *StartPersonTrackingInput

SetVideo sets the Video field's value.

func (StartPersonTrackingInput) String added in v1.12.36 

func (s StartPersonTrackingInput) String() string

String returns the string representation

func (*StartPersonTrackingInput) Validate added in v1.12.36 

func (s *StartPersonTrackingInput) Validate() error

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

type StartPersonTrackingOutput added in v1.12.36 

type StartPersonTrackingOutput struct {

	// The identifier for the person detection job. Use JobId to identify the job
	// in a subsequent call to GetPersonTracking.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartPersonTrackingOutput) GoString added in v1.12.36 

func (s StartPersonTrackingOutput) GoString() string

GoString returns the string representation

func (*StartPersonTrackingOutput) SetJobId added in v1.12.36 

func (s *StartPersonTrackingOutput) SetJobId(v string) *StartPersonTrackingOutput

SetJobId sets the JobId field's value.

func (StartPersonTrackingOutput) String added in v1.12.36 

func (s StartPersonTrackingOutput) String() string

String returns the string representation

type StartStreamProcessorInput added in v1.12.36 

type StartStreamProcessorInput struct {

	// The name of the stream processor to start processing.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartStreamProcessorInput) GoString added in v1.12.36 

func (s StartStreamProcessorInput) GoString() string

GoString returns the string representation

func (*StartStreamProcessorInput) SetName added in v1.12.36 

func (s *StartStreamProcessorInput) SetName(v string) *StartStreamProcessorInput

SetName sets the Name field's value.

func (StartStreamProcessorInput) String added in v1.12.36 

func (s StartStreamProcessorInput) String() string

String returns the string representation

func (*StartStreamProcessorInput) Validate added in v1.12.36 

func (s *StartStreamProcessorInput) Validate() error

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

type StartStreamProcessorOutput added in v1.12.36 

type StartStreamProcessorOutput struct {
	// contains filtered or unexported fields
}

func (StartStreamProcessorOutput) GoString added in v1.12.36 

func (s StartStreamProcessorOutput) GoString() string

GoString returns the string representation

func (StartStreamProcessorOutput) String added in v1.12.36 

func (s StartStreamProcessorOutput) String() string

String returns the string representation

type StopStreamProcessorInput added in v1.12.36 

type StopStreamProcessorInput struct {

	// The name of a stream processor created by .
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopStreamProcessorInput) GoString added in v1.12.36 

func (s StopStreamProcessorInput) GoString() string

GoString returns the string representation

func (*StopStreamProcessorInput) SetName added in v1.12.36 

func (s *StopStreamProcessorInput) SetName(v string) *StopStreamProcessorInput

SetName sets the Name field's value.

func (StopStreamProcessorInput) String added in v1.12.36 

func (s StopStreamProcessorInput) String() string

String returns the string representation

func (*StopStreamProcessorInput) Validate added in v1.12.36 

func (s *StopStreamProcessorInput) Validate() error

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

type StopStreamProcessorOutput added in v1.12.36 

type StopStreamProcessorOutput struct {
	// contains filtered or unexported fields
}

func (StopStreamProcessorOutput) GoString added in v1.12.36 

func (s StopStreamProcessorOutput) GoString() string

GoString returns the string representation

func (StopStreamProcessorOutput) String added in v1.12.36 

func (s StopStreamProcessorOutput) String() string

String returns the string representation

type StreamProcessor added in v1.12.36 

type StreamProcessor struct {

	// Name of the Amazon Rekognition stream processor.
	Name *string `min:"1" type:"string"`

	// Current status of the Amazon Rekognition stream processor.
	Status *string `type:"string" enum:"StreamProcessorStatus"`
	// contains filtered or unexported fields
}

An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to . The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

func (StreamProcessor) GoString added in v1.12.36 

func (s StreamProcessor) GoString() string

GoString returns the string representation

func (*StreamProcessor) SetName added in v1.12.36 

func (s *StreamProcessor) SetName(v string) *StreamProcessor

SetName sets the Name field's value.

func (*StreamProcessor) SetStatus added in v1.12.36 

func (s *StreamProcessor) SetStatus(v string) *StreamProcessor

SetStatus sets the Status field's value.

func (StreamProcessor) String added in v1.12.36 

func (s StreamProcessor) String() string

String returns the string representation

type StreamProcessorInput added in v1.12.36 

type StreamProcessorInput struct {

	// The Kinesis video stream input stream for the source streaming video.
	KinesisVideoStream *KinesisVideoStream `type:"structure"`
	// contains filtered or unexported fields
}

Information about the source streaming video.

func (StreamProcessorInput) GoString added in v1.12.36 

func (s StreamProcessorInput) GoString() string

GoString returns the string representation

func (*StreamProcessorInput) SetKinesisVideoStream added in v1.12.36 

func (s *StreamProcessorInput) SetKinesisVideoStream(v *KinesisVideoStream) *StreamProcessorInput

SetKinesisVideoStream sets the KinesisVideoStream field's value.

func (StreamProcessorInput) String added in v1.12.36 

func (s StreamProcessorInput) String() string

String returns the string representation

type StreamProcessorOutput added in v1.12.36 

type StreamProcessorOutput struct {

	// The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream
	// processor streams the analysis results.
	KinesisDataStream *KinesisDataStream `type:"structure"`
	// contains filtered or unexported fields
}

Information about the Amazon Kinesis Data Streams stream to which a Rekognition Video stream processor streams the results of a video analysis. For more information, see .

func (StreamProcessorOutput) GoString added in v1.12.36 

func (s StreamProcessorOutput) GoString() string

GoString returns the string representation

func (*StreamProcessorOutput) SetKinesisDataStream added in v1.12.36 

func (s *StreamProcessorOutput) SetKinesisDataStream(v *KinesisDataStream) *StreamProcessorOutput

SetKinesisDataStream sets the KinesisDataStream field's value.

func (StreamProcessorOutput) String added in v1.12.36 

func (s StreamProcessorOutput) String() string

String returns the string representation

type StreamProcessorSettings added in v1.12.36 

type StreamProcessorSettings struct {

	// Face search settings to use on a streaming video.
	FaceSearch *FaceSearchSettings `type:"structure"`
	// contains filtered or unexported fields
}

Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

func (StreamProcessorSettings) GoString added in v1.12.36 

func (s StreamProcessorSettings) GoString() string

GoString returns the string representation

func (*StreamProcessorSettings) SetFaceSearch added in v1.12.36 

func (s *StreamProcessorSettings) SetFaceSearch(v *FaceSearchSettings) *StreamProcessorSettings

SetFaceSearch sets the FaceSearch field's value.

func (StreamProcessorSettings) String added in v1.12.36 

func (s StreamProcessorSettings) String() string

String returns the string representation

func (*StreamProcessorSettings) Validate added in v1.12.36 

func (s *StreamProcessorSettings) Validate() error

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

type Sunglasses 

type Sunglasses struct {

	// Level of confidence in the determination.
	Confidence *float64 `type:"float"`

	// Boolean value that indicates whether the face is wearing sunglasses or not.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

func (Sunglasses) GoString 

func (s Sunglasses) GoString() string

GoString returns the string representation

func (*Sunglasses) SetConfidence 

func (s *Sunglasses) SetConfidence(v float64) *Sunglasses

SetConfidence sets the Confidence field's value.

func (*Sunglasses) SetValue 

func (s *Sunglasses) SetValue(v bool) *Sunglasses

SetValue sets the Value field's value.

func (Sunglasses) String 

func (s Sunglasses) String() string

String returns the string representation

type TextDetection added in v1.12.32 

type TextDetection struct {

	// The confidence that Amazon Rekognition has in the accuracy of the detected
	// text and the accuracy of the geometry points around the detected text.
	Confidence *float64 `type:"float"`

	// The word or line of text recognized by Amazon Rekognition.
	DetectedText *string `type:"string"`

	// The location of the detected text on the image. Includes an axis aligned
	// coarse bounding box surrounding the text and a finer grain polygon for more
	// accurate spatial information.
	Geometry *Geometry `type:"structure"`

	// The identifier for the detected text. The identifier is only unique for a
	// single call to DetectText.
	Id *int64 `type:"integer"`

	// The Parent identifier for the detected text identified by the value of ID.
	// If the type of detected text is LINE, the value of ParentId is Null.
	ParentId *int64 `type:"integer"`

	// The type of text that was detected.
	Type *string `type:"string" enum:"TextTypes"`
	// contains filtered or unexported fields
}

Information about a word or line of text detected by .

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see text-detection.

func (TextDetection) GoString added in v1.12.32 

func (s TextDetection) GoString() string

GoString returns the string representation

func (*TextDetection) SetConfidence added in v1.12.32 

func (s *TextDetection) SetConfidence(v float64) *TextDetection

SetConfidence sets the Confidence field's value.

func (*TextDetection) SetDetectedText added in v1.12.32 

func (s *TextDetection) SetDetectedText(v string) *TextDetection

SetDetectedText sets the DetectedText field's value.

func (*TextDetection) SetGeometry added in v1.12.32 

func (s *TextDetection) SetGeometry(v *Geometry) *TextDetection

SetGeometry sets the Geometry field's value.

func (*TextDetection) SetId added in v1.12.32 

func (s *TextDetection) SetId(v int64) *TextDetection

SetId sets the Id field's value.

func (*TextDetection) SetParentId added in v1.12.32 

func (s *TextDetection) SetParentId(v int64) *TextDetection

SetParentId sets the ParentId field's value.

func (*TextDetection) SetType added in v1.12.32 

func (s *TextDetection) SetType(v string) *TextDetection

SetType sets the Type field's value.

func (TextDetection) String added in v1.12.32 

func (s TextDetection) String() string

String returns the string representation

type Video added in v1.12.36 

type Video struct {

	// The Amazon S3 bucket name and file name for the video.
	S3Object *S3Object `type:"structure"`
	// contains filtered or unexported fields
}

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

func (Video) GoString added in v1.12.36 

func (s Video) GoString() string

GoString returns the string representation

func (*Video) SetS3Object added in v1.12.36 

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

SetS3Object sets the S3Object field's value.

func (Video) String added in v1.12.36 

func (s Video) String() string

String returns the string representation

func (*Video) Validate added in v1.12.36 

func (s *Video) Validate() error

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

type VideoMetadata added in v1.12.36 

type VideoMetadata struct {

	// Type of compression used in the analyzed video.
	Codec *string `type:"string"`

	// Length of the video in milliseconds.
	DurationMillis *int64 `type:"long"`

	// Format of the analyzed video. Possible values are MP4, MOV and AVI.
	Format *string `type:"string"`

	// Vertical pixel dimension of the video.
	FrameHeight *int64 `type:"long"`

	// Number of frames per second in the video.
	FrameRate *float64 `type:"float"`

	// Horizontal pixel dimension of the video.
	FrameWidth *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

func (VideoMetadata) GoString added in v1.12.36 

func (s VideoMetadata) GoString() string

GoString returns the string representation

func (*VideoMetadata) SetCodec added in v1.12.36 

func (s *VideoMetadata) SetCodec(v string) *VideoMetadata

SetCodec sets the Codec field's value.

func (*VideoMetadata) SetDurationMillis added in v1.12.36 

func (s *VideoMetadata) SetDurationMillis(v int64) *VideoMetadata

SetDurationMillis sets the DurationMillis field's value.

func (*VideoMetadata) SetFormat added in v1.12.36 

func (s *VideoMetadata) SetFormat(v string) *VideoMetadata

SetFormat sets the Format field's value.

func (*VideoMetadata) SetFrameHeight added in v1.12.36 

func (s *VideoMetadata) SetFrameHeight(v int64) *VideoMetadata

SetFrameHeight sets the FrameHeight field's value.

func (*VideoMetadata) SetFrameRate added in v1.12.36 

func (s *VideoMetadata) SetFrameRate(v float64) *VideoMetadata

SetFrameRate sets the FrameRate field's value.

func (*VideoMetadata) SetFrameWidth added in v1.12.36 

func (s *VideoMetadata) SetFrameWidth(v int64) *VideoMetadata

SetFrameWidth sets the FrameWidth field's value.

func (VideoMetadata) String added in v1.12.36 

func (s VideoMetadata) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition service client for testing your code.
 Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.