rekognition

package
v1.43.29 Latest Latest
Warning

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

 Go to latest Published: Mar 30, 2022 License: Apache-2.0 Imports: 10 Imported by: 116

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 (
	// BodyPartFace is a BodyPart enum value
	BodyPartFace = "FACE"

	// BodyPartHead is a BodyPart enum value
	BodyPartHead = "HEAD"

	// BodyPartLeftHand is a BodyPart enum value
	BodyPartLeftHand = "LEFT_HAND"

	// BodyPartRightHand is a BodyPart enum value
	BodyPartRightHand = "RIGHT_HAND"
)
View Source 
const (
	// CelebrityRecognitionSortById is a CelebrityRecognitionSortBy enum value
	CelebrityRecognitionSortById = "ID"

	// CelebrityRecognitionSortByTimestamp is a CelebrityRecognitionSortBy enum value
	CelebrityRecognitionSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// ContentClassifierFreeOfPersonallyIdentifiableInformation is a ContentClassifier enum value
	ContentClassifierFreeOfPersonallyIdentifiableInformation = "FreeOfPersonallyIdentifiableInformation"

	// ContentClassifierFreeOfAdultContent is a ContentClassifier enum value
	ContentClassifierFreeOfAdultContent = "FreeOfAdultContent"
)
View Source 
const (
	// ContentModerationSortByName is a ContentModerationSortBy enum value
	ContentModerationSortByName = "NAME"

	// ContentModerationSortByTimestamp is a ContentModerationSortBy enum value
	ContentModerationSortByTimestamp = "TIMESTAMP"
)
View Source 
const (
	// DatasetStatusCreateInProgress is a DatasetStatus enum value
	DatasetStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// DatasetStatusCreateComplete is a DatasetStatus enum value
	DatasetStatusCreateComplete = "CREATE_COMPLETE"

	// DatasetStatusCreateFailed is a DatasetStatus enum value
	DatasetStatusCreateFailed = "CREATE_FAILED"

	// DatasetStatusUpdateInProgress is a DatasetStatus enum value
	DatasetStatusUpdateInProgress = "UPDATE_IN_PROGRESS"

	// DatasetStatusUpdateComplete is a DatasetStatus enum value
	DatasetStatusUpdateComplete = "UPDATE_COMPLETE"

	// DatasetStatusUpdateFailed is a DatasetStatus enum value
	DatasetStatusUpdateFailed = "UPDATE_FAILED"

	// DatasetStatusDeleteInProgress is a DatasetStatus enum value
	DatasetStatusDeleteInProgress = "DELETE_IN_PROGRESS"
)
View Source 
const (
	// DatasetStatusMessageCodeSuccess is a DatasetStatusMessageCode enum value
	DatasetStatusMessageCodeSuccess = "SUCCESS"

	// DatasetStatusMessageCodeServiceError is a DatasetStatusMessageCode enum value
	DatasetStatusMessageCodeServiceError = "SERVICE_ERROR"

	// DatasetStatusMessageCodeClientError is a DatasetStatusMessageCode enum value
	DatasetStatusMessageCodeClientError = "CLIENT_ERROR"
)
View Source 
const (
	// DatasetTypeTrain is a DatasetType enum value
	DatasetTypeTrain = "TRAIN"

	// DatasetTypeTest is a DatasetType enum value
	DatasetTypeTest = "TEST"
)
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"

	// EmotionNameFear is a EmotionName enum value
	EmotionNameFear = "FEAR"
)
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 (
	// KnownGenderTypeMale is a KnownGenderType enum value
	KnownGenderTypeMale = "Male"

	// KnownGenderTypeFemale is a KnownGenderType enum value
	KnownGenderTypeFemale = "Female"

	// KnownGenderTypeNonbinary is a KnownGenderType enum value
	KnownGenderTypeNonbinary = "Nonbinary"

	// KnownGenderTypeUnlisted is a KnownGenderType enum value
	KnownGenderTypeUnlisted = "Unlisted"
)

A list of enum string of possible gender values that Celebrity returns.

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"

	// LandmarkTypeUpperJawlineLeft is a LandmarkType enum value
	LandmarkTypeUpperJawlineLeft = "upperJawlineLeft"

	// LandmarkTypeMidJawlineLeft is a LandmarkType enum value
	LandmarkTypeMidJawlineLeft = "midJawlineLeft"

	// LandmarkTypeChinBottom is a LandmarkType enum value
	LandmarkTypeChinBottom = "chinBottom"

	// LandmarkTypeMidJawlineRight is a LandmarkType enum value
	LandmarkTypeMidJawlineRight = "midJawlineRight"

	// LandmarkTypeUpperJawlineRight is a LandmarkType enum value
	LandmarkTypeUpperJawlineRight = "upperJawlineRight"
)
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 (
	// ProjectStatusCreating is a ProjectStatus enum value
	ProjectStatusCreating = "CREATING"

	// ProjectStatusCreated is a ProjectStatus enum value
	ProjectStatusCreated = "CREATED"

	// ProjectStatusDeleting is a ProjectStatus enum value
	ProjectStatusDeleting = "DELETING"
)
View Source 
const (
	// ProjectVersionStatusTrainingInProgress is a ProjectVersionStatus enum value
	ProjectVersionStatusTrainingInProgress = "TRAINING_IN_PROGRESS"

	// ProjectVersionStatusTrainingCompleted is a ProjectVersionStatus enum value
	ProjectVersionStatusTrainingCompleted = "TRAINING_COMPLETED"

	// ProjectVersionStatusTrainingFailed is a ProjectVersionStatus enum value
	ProjectVersionStatusTrainingFailed = "TRAINING_FAILED"

	// ProjectVersionStatusStarting is a ProjectVersionStatus enum value
	ProjectVersionStatusStarting = "STARTING"

	// ProjectVersionStatusRunning is a ProjectVersionStatus enum value
	ProjectVersionStatusRunning = "RUNNING"

	// ProjectVersionStatusFailed is a ProjectVersionStatus enum value
	ProjectVersionStatusFailed = "FAILED"

	// ProjectVersionStatusStopping is a ProjectVersionStatus enum value
	ProjectVersionStatusStopping = "STOPPING"

	// ProjectVersionStatusStopped is a ProjectVersionStatus enum value
	ProjectVersionStatusStopped = "STOPPED"

	// ProjectVersionStatusDeleting is a ProjectVersionStatus enum value
	ProjectVersionStatusDeleting = "DELETING"
)
View Source 
const (
	// ProtectiveEquipmentTypeFaceCover is a ProtectiveEquipmentType enum value
	ProtectiveEquipmentTypeFaceCover = "FACE_COVER"

	// ProtectiveEquipmentTypeHandCover is a ProtectiveEquipmentType enum value
	ProtectiveEquipmentTypeHandCover = "HAND_COVER"

	// ProtectiveEquipmentTypeHeadCover is a ProtectiveEquipmentType enum value
	ProtectiveEquipmentTypeHeadCover = "HEAD_COVER"
)
View Source 
const (
	// QualityFilterNone is a QualityFilter enum value
	QualityFilterNone = "NONE"

	// QualityFilterAuto is a QualityFilter enum value
	QualityFilterAuto = "AUTO"

	// QualityFilterLow is a QualityFilter enum value
	QualityFilterLow = "LOW"

	// QualityFilterMedium is a QualityFilter enum value
	QualityFilterMedium = "MEDIUM"

	// QualityFilterHigh is a QualityFilter enum value
	QualityFilterHigh = "HIGH"
)
View Source 
const (
	// ReasonExceedsMaxFaces is a Reason enum value
	ReasonExceedsMaxFaces = "EXCEEDS_MAX_FACES"

	// ReasonExtremePose is a Reason enum value
	ReasonExtremePose = "EXTREME_POSE"

	// ReasonLowBrightness is a Reason enum value
	ReasonLowBrightness = "LOW_BRIGHTNESS"

	// ReasonLowSharpness is a Reason enum value
	ReasonLowSharpness = "LOW_SHARPNESS"

	// ReasonLowConfidence is a Reason enum value
	ReasonLowConfidence = "LOW_CONFIDENCE"

	// ReasonSmallBoundingBox is a Reason enum value
	ReasonSmallBoundingBox = "SMALL_BOUNDING_BOX"

	// ReasonLowFaceQuality is a Reason enum value
	ReasonLowFaceQuality = "LOW_FACE_QUALITY"
)
View Source 
const (
	// SegmentTypeTechnicalCue is a SegmentType enum value
	SegmentTypeTechnicalCue = "TECHNICAL_CUE"

	// SegmentTypeShot is a SegmentType enum value
	SegmentTypeShot = "SHOT"
)
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 (
	// TechnicalCueTypeColorBars is a TechnicalCueType enum value
	TechnicalCueTypeColorBars = "ColorBars"

	// TechnicalCueTypeEndCredits is a TechnicalCueType enum value
	TechnicalCueTypeEndCredits = "EndCredits"

	// TechnicalCueTypeBlackFrames is a TechnicalCueType enum value
	TechnicalCueTypeBlackFrames = "BlackFrames"

	// TechnicalCueTypeOpeningCredits is a TechnicalCueType enum value
	TechnicalCueTypeOpeningCredits = "OpeningCredits"

	TechnicalCueTypeStudioLogo = "StudioLogo"

	// TechnicalCueTypeSlate is a TechnicalCueType enum value
	TechnicalCueTypeSlate = "Slate"

	// TechnicalCueTypeContent is a TechnicalCueType enum value
	TechnicalCueTypeContent = "Content"
)
View Source 
const (
	// TextTypesLine is a TextTypes enum value
	TextTypesLine = "LINE"

	// TextTypesWord is a TextTypes enum value
	TextTypesWord = "WORD"
)
View Source 
const (
	// VideoColorRangeFull is a VideoColorRange enum value
	VideoColorRangeFull = "FULL"

	// VideoColorRangeLimited is a VideoColorRange enum value
	VideoColorRangeLimited = "LIMITED"
)
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"

	// ErrCodeHumanLoopQuotaExceededException for service response error code
	// "HumanLoopQuotaExceededException".
	//
	// The number of in-progress human reviews you have has exceeded the number
	// allowed.
	ErrCodeHumanLoopQuotaExceededException = "HumanLoopQuotaExceededException"

	// 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. If you are calling DetectProtectiveEquipment,
	// the image size or resolution exceeds the allowed limit. For more information,
	// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.
	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 Amazon 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 resource with the specified ID already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is already being used.
	ErrCodeResourceInUseException = "ResourceInUseException"

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

	// ErrCodeResourceNotReadyException for service response error code
	// "ResourceNotReadyException".
	//
	// The requested resource isn't ready. For example, this exception occurs when
	// you call DetectCustomLabels with a model version that isn't deployed.
	ErrCodeResourceNotReadyException = "ResourceNotReadyException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The size of the collection exceeds the allowed limit. For more information,
	// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// 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 10GB. The maximum duration is 6 hours.
	ErrCodeVideoTooLargeException = "VideoTooLargeException"
)
View Source 
const (
	ServiceName = "rekognition" // Name of service.
	EndpointsID = ServiceName   // ID to lookup a service endpoint with.
	ServiceID   = "Rekognition" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func Attribute_Values added in v1.34.3 

func Attribute_Values() []string

Attribute_Values returns all elements of the Attribute enum

func BodyPart_Values added in v1.35.8 

func BodyPart_Values() []string

BodyPart_Values returns all elements of the BodyPart enum

func CelebrityRecognitionSortBy_Values added in v1.34.3 

func CelebrityRecognitionSortBy_Values() []string

CelebrityRecognitionSortBy_Values returns all elements of the CelebrityRecognitionSortBy enum

func ContentClassifier_Values added in v1.34.3 

func ContentClassifier_Values() []string

ContentClassifier_Values returns all elements of the ContentClassifier enum

func ContentModerationSortBy_Values added in v1.34.3 

func ContentModerationSortBy_Values() []string

ContentModerationSortBy_Values returns all elements of the ContentModerationSortBy enum

func DatasetStatusMessageCode_Values added in v1.41.15 

func DatasetStatusMessageCode_Values() []string

DatasetStatusMessageCode_Values returns all elements of the DatasetStatusMessageCode enum

func DatasetStatus_Values added in v1.41.15 

func DatasetStatus_Values() []string

DatasetStatus_Values returns all elements of the DatasetStatus enum

func DatasetType_Values added in v1.41.15 

func DatasetType_Values() []string

DatasetType_Values returns all elements of the DatasetType enum

func EmotionName_Values added in v1.34.3 

func EmotionName_Values() []string

EmotionName_Values returns all elements of the EmotionName enum

func FaceAttributes_Values added in v1.34.3 

func FaceAttributes_Values() []string

FaceAttributes_Values returns all elements of the FaceAttributes enum

func FaceSearchSortBy_Values added in v1.34.3 

func FaceSearchSortBy_Values() []string

FaceSearchSortBy_Values returns all elements of the FaceSearchSortBy enum

func GenderType_Values added in v1.34.3 

func GenderType_Values() []string

GenderType_Values returns all elements of the GenderType enum

func KnownGenderType_Values added in v1.40.31 

func KnownGenderType_Values() []string

KnownGenderType_Values returns all elements of the KnownGenderType enum

func LabelDetectionSortBy_Values added in v1.34.3 

func LabelDetectionSortBy_Values() []string

LabelDetectionSortBy_Values returns all elements of the LabelDetectionSortBy enum

func LandmarkType_Values added in v1.34.3 

func LandmarkType_Values() []string

LandmarkType_Values returns all elements of the LandmarkType enum

func OrientationCorrection_Values added in v1.34.3 

func OrientationCorrection_Values() []string

OrientationCorrection_Values returns all elements of the OrientationCorrection enum

func PersonTrackingSortBy_Values added in v1.34.3 

func PersonTrackingSortBy_Values() []string

PersonTrackingSortBy_Values returns all elements of the PersonTrackingSortBy enum

func ProjectStatus_Values added in v1.34.3 

func ProjectStatus_Values() []string

ProjectStatus_Values returns all elements of the ProjectStatus enum

func ProjectVersionStatus_Values added in v1.34.3 

func ProjectVersionStatus_Values() []string

ProjectVersionStatus_Values returns all elements of the ProjectVersionStatus enum

func ProtectiveEquipmentType_Values added in v1.35.8 

func ProtectiveEquipmentType_Values() []string

ProtectiveEquipmentType_Values returns all elements of the ProtectiveEquipmentType enum

func QualityFilter_Values added in v1.34.3 

func QualityFilter_Values() []string

QualityFilter_Values returns all elements of the QualityFilter enum

func Reason_Values added in v1.34.3 

func Reason_Values() []string

Reason_Values returns all elements of the Reason enum

func SegmentType_Values added in v1.34.3 

func SegmentType_Values() []string

SegmentType_Values returns all elements of the SegmentType enum

func StreamProcessorStatus_Values added in v1.34.3 

func StreamProcessorStatus_Values() []string

StreamProcessorStatus_Values returns all elements of the StreamProcessorStatus enum

func TechnicalCueType_Values added in v1.34.3 

func TechnicalCueType_Values() []string

TechnicalCueType_Values returns all elements of the TechnicalCueType enum

func TextTypes_Values added in v1.34.3 

func TextTypes_Values() []string

TextTypes_Values returns all elements of the TextTypes enum

func VideoColorRange_Values added in v1.40.18 

func VideoColorRange_Values() []string

VideoColorRange_Values returns all elements of the VideoColorRange enum

func VideoJobStatus_Values added in v1.34.3 

func VideoJobStatus_Values() []string

VideoJobStatus_Values returns all elements of the VideoJobStatus enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You are not authorized to perform the action.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the face of a 6-year-old might 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Asset added in v1.25.47 

type Asset struct {

	// The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest
	// file.
	GroundTruthManifest *GroundTruthManifest `type:"structure"`
	// contains filtered or unexported fields
}

Assets are the images that you use to train and evaluate a model version. Assets can also contain validation information that you use to debug a failed model training.

func (Asset) GoString added in v1.25.47 

func (s Asset) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Asset) SetGroundTruthManifest added in v1.25.47 

func (s *Asset) SetGroundTruthManifest(v *GroundTruthManifest) *Asset

SetGroundTruthManifest sets the GroundTruthManifest field's value.

func (Asset) String added in v1.25.47 

func (s Asset) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Asset) Validate added in v1.25.47 

func (s *Asset) Validate() error

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

type AudioMetadata added in v1.32.7 

type AudioMetadata struct {

	// The audio codec used to encode or decode the audio stream.
	Codec *string `type:"string"`

	// The duration of the audio stream in milliseconds.
	DurationMillis *int64 `type:"long"`

	// The number of audio channels in the segment.
	NumberOfChannels *int64 `type:"long"`

	// The sample rate for the audio stream.
	SampleRate *int64 `type:"long"`
	// contains filtered or unexported fields
}

Metadata information about an audio stream. An array of AudioMetadata objects for the audio streams found in a stored video is returned by GetSegmentDetection.

func (AudioMetadata) GoString added in v1.32.7 

func (s AudioMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioMetadata) SetCodec added in v1.32.7 

func (s *AudioMetadata) SetCodec(v string) *AudioMetadata

SetCodec sets the Codec field's value.

func (*AudioMetadata) SetDurationMillis added in v1.32.7 

func (s *AudioMetadata) SetDurationMillis(v int64) *AudioMetadata

SetDurationMillis sets the DurationMillis field's value.

func (*AudioMetadata) SetNumberOfChannels added in v1.32.7 

func (s *AudioMetadata) SetNumberOfChannels(v int64) *AudioMetadata

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*AudioMetadata) SetSampleRate added in v1.32.7 

func (s *AudioMetadata) SetSampleRate(v int64) *AudioMetadata

SetSampleRate sets the SampleRate field's value.

func (AudioMetadata) String added in v1.32.7 

func (s AudioMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BlackFrame added in v1.40.18 

type BlackFrame struct {

	// A threshold used to determine the maximum luminance value for a pixel to
	// be considered black. In a full color range video, luminance values range
	// from 0-255. A pixel value of 0 is pure black, and the most strict filter.
	// The maximum black pixel value is computed as follows: max_black_pixel_value
	// = minimum_luminance + MaxPixelThreshold *luminance_range.
	//
	// For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value
	// is 0 + 0.1 * (255-0) = 25.5.
	//
	// The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value
	// of 51 for a full range video. You can lower this threshold to be more strict
	// on black levels.
	MaxPixelThreshold *float64 `type:"float"`

	// The minimum percentage of pixels in a frame that need to have a luminance
	// below the max_black_pixel_value for a frame to be considered a black frame.
	// Luminance is calculated using the BT.709 matrix.
	//
	// The default value is 99, which means at least 99% of all pixels in the frame
	// are black pixels as per the MaxPixelThreshold set. You can reduce this value
	// to allow more noise on the black frame.
	MinCoveragePercentage *float64 `type:"float"`
	// contains filtered or unexported fields
}

A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. As videos can come from multiple sources, formats, and time periods, they may contain different standards and varying noise levels for black frames that need to be accounted for. For more information, see StartSegmentDetection.

func (BlackFrame) GoString added in v1.40.18 

func (s BlackFrame) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BlackFrame) SetMaxPixelThreshold added in v1.40.18 

func (s *BlackFrame) SetMaxPixelThreshold(v float64) *BlackFrame

SetMaxPixelThreshold sets the MaxPixelThreshold field's value.

func (*BlackFrame) SetMinCoveragePercentage added in v1.40.18 

func (s *BlackFrame) SetMinCoveragePercentage(v float64) *BlackFrame

SetMinCoveragePercentage sets the MinCoveragePercentage field's value.

func (BlackFrame) String added in v1.40.18 

func (s BlackFrame) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 label, face, text or personal protective equipment. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 known gender identity for the celebrity that matches the provided ID.
	// The known gender identity can be Male, Female, Nonbinary, or Unlisted.
	KnownGender *KnownGender `type:"structure"`

	// The confidence, in percentage, that Amazon 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 RecognizeCelebrities operation.

func (Celebrity) GoString added in v1.8.38 

func (s Celebrity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetKnownGender added in v1.40.31 

func (s *Celebrity) SetKnownGender(v *KnownGender) *Celebrity

SetKnownGender sets the KnownGender 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Retrieves the known gender for the celebrity.
	KnownGender *KnownGender `type:"structure"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetKnownGender added in v1.41.14 

func (s *CelebrityDetail) SetKnownGender(v *KnownGender) *CelebrityDetail

SetKnownGender sets the KnownGender 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 GetCelebrityRecognition in the Amazon Rekognition Developer Guide.

func (CelebrityRecognition) GoString added in v1.12.36 

func (s CelebrityRecognition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompareFacesInput 

type CompareFacesInput struct {

	// A filter that specifies a quality bar for how much filtering is done to identify
	// faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition
	// chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes
	// all faces that don’t meet the chosen quality bar. The quality bar is based
	// on a variety of common use cases. Low-quality detections can occur for a
	// number of reasons. Some examples are an object that's misidentified as a
	// face, a face that's too blurry, or a face with a pose that's too extreme
	// to use. If you specify NONE, no filtering is performed. The default value
	// is NONE.
	//
	// To use quality filtering, the collection you are using must be associated
	// with version 3 of the face model or higher.
	QualityFilter *string `type:"string" enum:"QualityFilter"`

	// 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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompareFacesInput) SetQualityFilter added in v1.25.41 

func (s *CompareFacesInput) SetQualityFilter(v string) *CompareFacesInput

SetQualityFilter sets the QualityFilter field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 analyzed 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 value of SourceImageOrientationCorrection is always null.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// file format (Exif) metadata that includes the image's orientation. Amazon
	// Rekognition uses this orientation information to perform image correction.
	// The bounding box coordinates are translated to represent object locations
	// after the orientation information in the Exif metadata is used to correct
	// the image orientation. Images in .png format don't contain Exif metadata.
	//
	// Amazon Rekognition doesn’t perform image correction for images in .png
	// format and .jpeg images without orientation information in the image Exif
	// metadata. The bounding box coordinates aren't translated and represent the
	// object locations before the image is rotated.
	SourceImageOrientationCorrection *string `type:"string" enum:"OrientationCorrection"`

	// The value of TargetImageOrientationCorrection is always null.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// file format (Exif) metadata that includes the image's orientation. Amazon
	// Rekognition uses this orientation information to perform image correction.
	// The bounding box coordinates are translated to represent object locations
	// after the orientation information in the Exif metadata is used to correct
	// the image orientation. Images in .png format don't contain Exif metadata.
	//
	// Amazon Rekognition doesn’t perform image correction for images in .png
	// format and .jpeg images without orientation information in the image Exif
	// metadata. The bounding box coordinates aren't translated and represent the
	// object locations before the image is rotated.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// The emotions that appear to be expressed on the face, and the confidence
	// level in the determination. Valid values include "Happy", "Sad", "Angry",
	// "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
	Emotions []*Emotion `type:"list"`

	// 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"`

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

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

func (ComparedFace) GoString 

func (s ComparedFace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEmotions added in v1.40.31 

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

SetEmotions sets the Emotions 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) SetSmile added in v1.40.31 

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

SetSmile sets the Smile field's value.

func (ComparedFace) String 

func (s ComparedFace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContentModerationDetection added in v1.12.36 

type ContentModerationDetection struct {

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

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

Information about an inappropriate, unwanted, or offensive content label detection in a stored video.

func (ContentModerationDetection) GoString added in v1.12.36 

func (s ContentModerationDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CoversBodyPart added in v1.35.8 

type CoversBodyPart struct {

	// The confidence that Amazon Rekognition has in the value of Value.
	Confidence *float64 `type:"float"`

	// True if the PPE covers the corresponding body part, otherwise false.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about an item of Personal Protective Equipment covering a corresponding body part. For more information, see DetectProtectiveEquipment.

func (CoversBodyPart) GoString added in v1.35.8 

func (s CoversBodyPart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CoversBodyPart) SetConfidence added in v1.35.8 

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

SetConfidence sets the Confidence field's value.

func (*CoversBodyPart) SetValue added in v1.35.8 

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

SetValue sets the Value field's value.

func (CoversBodyPart) String added in v1.35.8 

func (s CoversBodyPart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A set of tags (key-value pairs) that you want to attach to the collection.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateCollectionInput) GoString 

func (s CreateCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCollectionInput) SetCollectionId 

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

SetCollectionId sets the CollectionId field's value.

func (*CreateCollectionInput) SetTags added in v1.38.5 

func (s *CreateCollectionInput) SetTags(v map[string]*string) *CreateCollectionInput

SetTags sets the Tags field's value.

func (CreateCollectionInput) String 

func (s CreateCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Latest face model being used with the collection. For more information, see
	// Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDatasetInput added in v1.41.15 

type CreateDatasetInput struct {

	// The source files for the dataset. You can specify the ARN of an existing
	// dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format
	// manifest file. If you don't specify datasetSource, an empty dataset is created.
	// To add labeled images to the dataset, You can use the console or call UpdateDatasetEntries.
	DatasetSource *DatasetSource `type:"structure"`

	// The type of the dataset. Specify train to create a training dataset. Specify
	// test to create a test dataset.
	//
	// DatasetType is a required field
	DatasetType *string `type:"string" required:"true" enum:"DatasetType"`

	// The ARN of the Amazon Rekognition Custom Labels project to which you want
	// to asssign the dataset.
	//
	// ProjectArn is a required field
	ProjectArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDatasetInput) GoString added in v1.41.15 

func (s CreateDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetInput) SetDatasetSource added in v1.41.15 

func (s *CreateDatasetInput) SetDatasetSource(v *DatasetSource) *CreateDatasetInput

SetDatasetSource sets the DatasetSource field's value.

func (*CreateDatasetInput) SetDatasetType added in v1.41.15 

func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput

SetDatasetType sets the DatasetType field's value.

func (*CreateDatasetInput) SetProjectArn added in v1.41.15 

func (s *CreateDatasetInput) SetProjectArn(v string) *CreateDatasetInput

SetProjectArn sets the ProjectArn field's value.

func (CreateDatasetInput) String added in v1.41.15 

func (s CreateDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetInput) Validate added in v1.41.15 

func (s *CreateDatasetInput) Validate() error

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

type CreateDatasetOutput added in v1.41.15 

type CreateDatasetOutput struct {

	// The ARN of the created Amazon Rekognition Custom Labels dataset.
	DatasetArn *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetOutput) GoString added in v1.41.15 

func (s CreateDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetOutput) SetDatasetArn added in v1.41.15 

func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (CreateDatasetOutput) String added in v1.41.15 

func (s CreateDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProjectInput added in v1.25.47 

type CreateProjectInput struct {

	// The name of the project to create.
	//
	// ProjectName is a required field
	ProjectName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProjectInput) GoString added in v1.25.47 

func (s CreateProjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectInput) SetProjectName added in v1.25.47 

func (s *CreateProjectInput) SetProjectName(v string) *CreateProjectInput

SetProjectName sets the ProjectName field's value.

func (CreateProjectInput) String added in v1.25.47 

func (s CreateProjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectInput) Validate added in v1.25.47 

func (s *CreateProjectInput) Validate() error

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

type CreateProjectOutput added in v1.25.47 

type CreateProjectOutput struct {

	// The Amazon Resource Name (ARN) of the new project. You can use the ARN to
	// configure IAM access to the project.
	ProjectArn *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProjectOutput) GoString added in v1.25.47 

func (s CreateProjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectOutput) SetProjectArn added in v1.25.47 

func (s *CreateProjectOutput) SetProjectArn(v string) *CreateProjectOutput

SetProjectArn sets the ProjectArn field's value.

func (CreateProjectOutput) String added in v1.25.47 

func (s CreateProjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProjectVersionInput added in v1.25.47 

type CreateProjectVersionInput struct {

	// The identifier for your AWS Key Management Service key (AWS KMS key). You
	// can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your
	// KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt
	// training and test images copied into the service for model training. Your
	// source images are unaffected. The key is also used to encrypt training results
	// and manifest files written to the output Amazon S3 bucket (OutputConfig).
	//
	// If you choose to use your own KMS key, you need the following permissions
	// on the KMS key.
	//
	//    * kms:CreateGrant
	//
	//    * kms:DescribeKey
	//
	//    * kms:GenerateDataKey
	//
	//    * kms:Decrypt
	//
	// If you don't specify a value for KmsKeyId, images copied into the service
	// are encrypted using a key that AWS owns and manages.
	KmsKeyId *string `min:"1" type:"string"`

	// The Amazon S3 bucket location to store the results of training. The S3 bucket
	// can be in any AWS account as long as the caller has s3:PutObject permissions
	// on the S3 bucket.
	//
	// OutputConfig is a required field
	OutputConfig *OutputConfig `type:"structure" required:"true"`

	// The ARN of the Amazon Rekognition Custom Labels project that manages the
	// model that you want to train.
	//
	// ProjectArn is a required field
	ProjectArn *string `min:"20" type:"string" required:"true"`

	// A set of tags (key-value pairs) that you want to attach to the model.
	Tags map[string]*string `type:"map"`

	// Specifies an external manifest that the service uses to test the model. If
	// you specify TestingData you must also specify TrainingData. The project must
	// not have any associated datasets.
	TestingData *TestingData `type:"structure"`

	// Specifies an external manifest that the services uses to train the model.
	// If you specify TrainingData you must also specify TestingData. The project
	// must not have any associated datasets.
	TrainingData *TrainingData `type:"structure"`

	// A name for the version of the model. This value must be unique.
	//
	// VersionName is a required field
	VersionName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProjectVersionInput) GoString added in v1.25.47 

func (s CreateProjectVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectVersionInput) SetKmsKeyId added in v1.38.43 

func (s *CreateProjectVersionInput) SetKmsKeyId(v string) *CreateProjectVersionInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateProjectVersionInput) SetOutputConfig added in v1.25.47 

func (s *CreateProjectVersionInput) SetOutputConfig(v *OutputConfig) *CreateProjectVersionInput

SetOutputConfig sets the OutputConfig field's value.

func (*CreateProjectVersionInput) SetProjectArn added in v1.25.47 

func (s *CreateProjectVersionInput) SetProjectArn(v string) *CreateProjectVersionInput

SetProjectArn sets the ProjectArn field's value.

func (*CreateProjectVersionInput) SetTags added in v1.38.5 

func (s *CreateProjectVersionInput) SetTags(v map[string]*string) *CreateProjectVersionInput

SetTags sets the Tags field's value.

func (*CreateProjectVersionInput) SetTestingData added in v1.25.47 

func (s *CreateProjectVersionInput) SetTestingData(v *TestingData) *CreateProjectVersionInput

SetTestingData sets the TestingData field's value.

func (*CreateProjectVersionInput) SetTrainingData added in v1.25.47 

func (s *CreateProjectVersionInput) SetTrainingData(v *TrainingData) *CreateProjectVersionInput

SetTrainingData sets the TrainingData field's value.

func (*CreateProjectVersionInput) SetVersionName added in v1.25.47 

func (s *CreateProjectVersionInput) SetVersionName(v string) *CreateProjectVersionInput

SetVersionName sets the VersionName field's value.

func (CreateProjectVersionInput) String added in v1.25.47 

func (s CreateProjectVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectVersionInput) Validate added in v1.25.47 

func (s *CreateProjectVersionInput) Validate() error

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

type CreateProjectVersionOutput added in v1.25.47 

type CreateProjectVersionOutput struct {

	// The ARN of the model version that was created. Use DescribeProjectVersion
	// to get the current status of the training operation.
	ProjectVersionArn *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProjectVersionOutput) GoString added in v1.25.47 

func (s CreateProjectVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectVersionOutput) SetProjectVersionArn added in v1.25.47 

func (s *CreateProjectVersionOutput) SetProjectVersionArn(v string) *CreateProjectVersionOutput

SetProjectVersionArn sets the ProjectVersionArn field's value.

func (CreateProjectVersionOutput) String added in v1.25.47 

func (s CreateProjectVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 DescribeStreamProcessor. Name is idempotent.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Kinesis data stream stream to which Amazon 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"`

	// A set of tags (key-value pairs) that you want to attach to the stream processor.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateStreamProcessorInput) GoString added in v1.12.36 

func (s CreateStreamProcessorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTags added in v1.38.5 

func (s *CreateStreamProcessorInput) SetTags(v map[string]*string) *CreateStreamProcessorInput

SetTags sets the Tags field's value.

func (CreateStreamProcessorInput) String added in v1.12.36 

func (s CreateStreamProcessorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomLabel added in v1.25.47 

type CustomLabel struct {

	// The confidence that the model has in the detection of the custom label. The
	// range is 0-100. A higher value indicates a higher confidence.
	Confidence *float64 `type:"float"`

	// The location of the detected object on the image that corresponds to the
	// custom label. Includes an axis aligned coarse bounding box surrounding the
	// object and a finer grain polygon for more accurate spatial information.
	Geometry *Geometry `type:"structure"`

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

A custom label detected in an image by a call to DetectCustomLabels.

func (CustomLabel) GoString added in v1.25.47 

func (s CustomLabel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomLabel) SetConfidence added in v1.25.47 

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

SetConfidence sets the Confidence field's value.

func (*CustomLabel) SetGeometry added in v1.25.47 

func (s *CustomLabel) SetGeometry(v *Geometry) *CustomLabel

SetGeometry sets the Geometry field's value.

func (*CustomLabel) SetName added in v1.25.47 

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

SetName sets the Name field's value.

func (CustomLabel) String added in v1.25.47 

func (s CustomLabel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetChanges added in v1.41.15 

type DatasetChanges struct {

	// A Base64-encoded binary data object containing one or JSON lines that either
	// update the dataset or are additions to the dataset. You change a dataset
	// by calling UpdateDatasetEntries. If you are using an AWS SDK to call UpdateDatasetEntries,
	// you don't need to encode Changes as the SDK encodes the data for you.
	//
	// For example JSON lines, see Image-Level labels in manifest files and and
	// Object localization in manifest files in the Amazon Rekognition Custom Labels
	// Developer Guide.
	// GroundTruth is automatically base64 encoded/decoded by the SDK.
	//
	// GroundTruth is a required field
	GroundTruth []byte `min:"1" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Describes updates or additions to a dataset. A Single update or addition is an entry (JSON Line) that provides information about a single image. To update an existing entry, you match the source-ref field of the update entry with the source-ref filed of the entry that you want to update. If the source-ref field doesn't match an existing entry, the entry is added to dataset as a new entry.

func (DatasetChanges) GoString added in v1.41.15 

func (s DatasetChanges) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetChanges) SetGroundTruth added in v1.41.15 

func (s *DatasetChanges) SetGroundTruth(v []byte) *DatasetChanges

SetGroundTruth sets the GroundTruth field's value.

func (DatasetChanges) String added in v1.41.15 

func (s DatasetChanges) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetChanges) Validate added in v1.41.15 

func (s *DatasetChanges) Validate() error

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

type DatasetDescription added in v1.41.15 

type DatasetDescription struct {

	// The Unix timestamp for the time and date that the dataset was created.
	CreationTimestamp *time.Time `type:"timestamp"`

	// The status message code for the dataset.
	DatasetStats *DatasetStats `type:"structure"`

	// The Unix timestamp for the date and time that the dataset was last updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The status of the dataset.
	Status *string `type:"string" enum:"DatasetStatus"`

	// The status message for the dataset.
	StatusMessage *string `type:"string"`

	// The status message code for the dataset operation. If a service error occurs,
	// try the API call again later. If a client error occurs, check the input parameters
	// to the dataset API call that failed.
	StatusMessageCode *string `type:"string" enum:"DatasetStatusMessageCode"`
	// contains filtered or unexported fields
}

A description for a dataset. For more information, see DescribeDataset.

The status fields Status, StatusMessage, and StatusMessageCode reflect the last operation on the dataset.

func (DatasetDescription) GoString added in v1.41.15 

func (s DatasetDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetDescription) SetCreationTimestamp added in v1.41.15 

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DatasetDescription) SetDatasetStats added in v1.41.15 

func (s *DatasetDescription) SetDatasetStats(v *DatasetStats) *DatasetDescription

SetDatasetStats sets the DatasetStats field's value.

func (*DatasetDescription) SetLastUpdatedTimestamp added in v1.41.15 

func (s *DatasetDescription) SetLastUpdatedTimestamp(v time.Time) *DatasetDescription

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*DatasetDescription) SetStatus added in v1.41.15 

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

SetStatus sets the Status field's value.

func (*DatasetDescription) SetStatusMessage added in v1.41.15 

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

SetStatusMessage sets the StatusMessage field's value.

func (*DatasetDescription) SetStatusMessageCode added in v1.41.15 

func (s *DatasetDescription) SetStatusMessageCode(v string) *DatasetDescription

SetStatusMessageCode sets the StatusMessageCode field's value.

func (DatasetDescription) String added in v1.41.15 

func (s DatasetDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetLabelDescription added in v1.41.15 

type DatasetLabelDescription struct {

	// The name of the label.
	LabelName *string `min:"1" type:"string"`

	// Statistics about the label.
	LabelStats *DatasetLabelStats `type:"structure"`
	// contains filtered or unexported fields
}

Describes a dataset label. For more information, see ListDatasetLabels.

func (DatasetLabelDescription) GoString added in v1.41.15 

func (s DatasetLabelDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetLabelDescription) SetLabelName added in v1.41.15 

func (s *DatasetLabelDescription) SetLabelName(v string) *DatasetLabelDescription

SetLabelName sets the LabelName field's value.

func (*DatasetLabelDescription) SetLabelStats added in v1.41.15 

func (s *DatasetLabelDescription) SetLabelStats(v *DatasetLabelStats) *DatasetLabelDescription

SetLabelStats sets the LabelStats field's value.

func (DatasetLabelDescription) String added in v1.41.15 

func (s DatasetLabelDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetLabelStats added in v1.41.15 

type DatasetLabelStats struct {

	// The total number of images that have the label assigned to a bounding box.
	BoundingBoxCount *int64 `type:"integer"`

	// The total number of images that use the label.
	EntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Statistics about a label used in a dataset. For more information, see DatasetLabelDescription.

func (DatasetLabelStats) GoString added in v1.41.15 

func (s DatasetLabelStats) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetLabelStats) SetBoundingBoxCount added in v1.41.15 

func (s *DatasetLabelStats) SetBoundingBoxCount(v int64) *DatasetLabelStats

SetBoundingBoxCount sets the BoundingBoxCount field's value.

func (*DatasetLabelStats) SetEntryCount added in v1.41.15 

func (s *DatasetLabelStats) SetEntryCount(v int64) *DatasetLabelStats

SetEntryCount sets the EntryCount field's value.

func (DatasetLabelStats) String added in v1.41.15 

func (s DatasetLabelStats) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetMetadata added in v1.41.15 

type DatasetMetadata struct {

	// The Unix timestamp for the date and time that the dataset was created.
	CreationTimestamp *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) for the dataset.
	DatasetArn *string `min:"20" type:"string"`

	// The type of the dataset.
	DatasetType *string `type:"string" enum:"DatasetType"`

	// The status for the dataset.
	Status *string `type:"string" enum:"DatasetStatus"`

	// The status message for the dataset.
	StatusMessage *string `type:"string"`

	// The status message code for the dataset operation. If a service error occurs,
	// try the API call again later. If a client error occurs, check the input parameters
	// to the dataset API call that failed.
	StatusMessageCode *string `type:"string" enum:"DatasetStatusMessageCode"`
	// contains filtered or unexported fields
}

Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see ProjectDescription.

func (DatasetMetadata) GoString added in v1.41.15 

func (s DatasetMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetMetadata) SetCreationTimestamp added in v1.41.15 

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DatasetMetadata) SetDatasetArn added in v1.41.15 

func (s *DatasetMetadata) SetDatasetArn(v string) *DatasetMetadata

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetMetadata) SetDatasetType added in v1.41.15 

func (s *DatasetMetadata) SetDatasetType(v string) *DatasetMetadata

SetDatasetType sets the DatasetType field's value.

func (*DatasetMetadata) SetStatus added in v1.41.15 

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

SetStatus sets the Status field's value.

func (*DatasetMetadata) SetStatusMessage added in v1.41.15 

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

SetStatusMessage sets the StatusMessage field's value.

func (*DatasetMetadata) SetStatusMessageCode added in v1.41.15 

func (s *DatasetMetadata) SetStatusMessageCode(v string) *DatasetMetadata

SetStatusMessageCode sets the StatusMessageCode field's value.

func (DatasetMetadata) String added in v1.41.15 

func (s DatasetMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetSource added in v1.41.15 

type DatasetSource struct {

	// The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.
	DatasetArn *string `min:"20" type:"string"`

	// The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest
	// file.
	GroundTruthManifest *GroundTruthManifest `type:"structure"`
	// contains filtered or unexported fields
}

The source that Amazon Rekognition Custom Labels uses to create a dataset. To use an Amazon Sagemaker format manifest file, specify the S3 bucket location in the GroundTruthManifest field. The S3 bucket must be in your AWS account. To create a copy of an existing dataset, specify the Amazon Resource Name (ARN) of an existing dataset in DatasetArn.

You need to specify a value for DatasetArn or GroundTruthManifest, but not both. if you supply both values, or if you don't specify any values, an InvalidParameterException exception occurs.

For more information, see CreateDataset.

func (DatasetSource) GoString added in v1.41.15 

func (s DatasetSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetSource) SetDatasetArn added in v1.41.15 

func (s *DatasetSource) SetDatasetArn(v string) *DatasetSource

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetSource) SetGroundTruthManifest added in v1.41.15 

func (s *DatasetSource) SetGroundTruthManifest(v *GroundTruthManifest) *DatasetSource

SetGroundTruthManifest sets the GroundTruthManifest field's value.

func (DatasetSource) String added in v1.41.15 

func (s DatasetSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetSource) Validate added in v1.41.15 

func (s *DatasetSource) Validate() error

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

type DatasetStats added in v1.41.15 

type DatasetStats struct {

	// The total number of entries that contain at least one error.
	ErrorEntries *int64 `type:"integer"`

	// The total number of images in the dataset that have labels.
	LabeledEntries *int64 `type:"integer"`

	// The total number of images in the dataset.
	TotalEntries *int64 `type:"integer"`

	// The total number of labels declared in the dataset.
	TotalLabels *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides statistics about a dataset. For more information, see DescribeDataset.

func (DatasetStats) GoString added in v1.41.15 

func (s DatasetStats) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetStats) SetErrorEntries added in v1.41.15 

func (s *DatasetStats) SetErrorEntries(v int64) *DatasetStats

SetErrorEntries sets the ErrorEntries field's value.

func (*DatasetStats) SetLabeledEntries added in v1.41.15 

func (s *DatasetStats) SetLabeledEntries(v int64) *DatasetStats

SetLabeledEntries sets the LabeledEntries field's value.

func (*DatasetStats) SetTotalEntries added in v1.41.15 

func (s *DatasetStats) SetTotalEntries(v int64) *DatasetStats

SetTotalEntries sets the TotalEntries field's value.

func (*DatasetStats) SetTotalLabels added in v1.41.15 

func (s *DatasetStats) SetTotalLabels(v int64) *DatasetStats

SetTotalLabels sets the TotalLabels field's value.

func (DatasetStats) String added in v1.41.15 

func (s DatasetStats) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDatasetInput added in v1.41.15 

type DeleteDatasetInput struct {

	// The ARN of the Amazon Rekognition Custom Labels dataset that you want to
	// delete.
	//
	// DatasetArn is a required field
	DatasetArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetInput) GoString added in v1.41.15 

func (s DeleteDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDatasetInput) SetDatasetArn added in v1.41.15 

func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DeleteDatasetInput) String added in v1.41.15 

func (s DeleteDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDatasetInput) Validate added in v1.41.15 

func (s *DeleteDatasetInput) Validate() error

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

type DeleteDatasetOutput added in v1.41.15 

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

func (DeleteDatasetOutput) GoString added in v1.41.15 

func (s DeleteDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDatasetOutput) String added in v1.41.15 

func (s DeleteDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProjectInput added in v1.30.1 

type DeleteProjectInput struct {

	// The Amazon Resource Name (ARN) of the project that you want to delete.
	//
	// ProjectArn is a required field
	ProjectArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProjectInput) GoString added in v1.30.1 

func (s DeleteProjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectInput) SetProjectArn added in v1.30.1 

func (s *DeleteProjectInput) SetProjectArn(v string) *DeleteProjectInput

SetProjectArn sets the ProjectArn field's value.

func (DeleteProjectInput) String added in v1.30.1 

func (s DeleteProjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectInput) Validate added in v1.30.1 

func (s *DeleteProjectInput) Validate() error

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

type DeleteProjectOutput added in v1.30.1 

type DeleteProjectOutput struct {

	// The current status of the delete project operation.
	Status *string `type:"string" enum:"ProjectStatus"`
	// contains filtered or unexported fields
}

func (DeleteProjectOutput) GoString added in v1.30.1 

func (s DeleteProjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectOutput) SetStatus added in v1.30.1 

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

SetStatus sets the Status field's value.

func (DeleteProjectOutput) String added in v1.30.1 

func (s DeleteProjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProjectVersionInput added in v1.30.1 

type DeleteProjectVersionInput struct {

	// The Amazon Resource Name (ARN) of the model version that you want to delete.
	//
	// ProjectVersionArn is a required field
	ProjectVersionArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProjectVersionInput) GoString added in v1.30.1 

func (s DeleteProjectVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectVersionInput) SetProjectVersionArn added in v1.30.1 

func (s *DeleteProjectVersionInput) SetProjectVersionArn(v string) *DeleteProjectVersionInput

SetProjectVersionArn sets the ProjectVersionArn field's value.

func (DeleteProjectVersionInput) String added in v1.30.1 

func (s DeleteProjectVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectVersionInput) Validate added in v1.30.1 

func (s *DeleteProjectVersionInput) Validate() error

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

type DeleteProjectVersionOutput added in v1.30.1 

type DeleteProjectVersionOutput struct {

	// The status of the deletion operation.
	Status *string `type:"string" enum:"ProjectVersionStatus"`
	// contains filtered or unexported fields
}

func (DeleteProjectVersionOutput) GoString added in v1.30.1 

func (s DeleteProjectVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectVersionOutput) SetStatus added in v1.30.1 

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

SetStatus sets the Status field's value.

func (DeleteProjectVersionOutput) String added in v1.30.1 

func (s DeleteProjectVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStreamProcessorOutput) String added in v1.12.36 

func (s DeleteStreamProcessorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCollectionInput added in v1.15.19 

type DescribeCollectionInput struct {

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

func (DescribeCollectionInput) GoString added in v1.15.19 

func (s DescribeCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCollectionInput) SetCollectionId added in v1.15.19 

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

SetCollectionId sets the CollectionId field's value.

func (DescribeCollectionInput) String added in v1.15.19 

func (s DescribeCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCollectionInput) Validate added in v1.15.19 

func (s *DescribeCollectionInput) Validate() error

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

type DescribeCollectionOutput added in v1.15.19 

type DescribeCollectionOutput struct {

	// The Amazon Resource Name (ARN) of the collection.
	CollectionARN *string `type:"string"`

	// The number of milliseconds since the Unix epoch time until the creation of
	// the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time
	// (UTC), Thursday, 1 January 1970.
	CreationTimestamp *time.Time `type:"timestamp"`

	// The number of faces that are indexed into the collection. To index faces
	// into a collection, use IndexFaces.
	FaceCount *int64 `type:"long"`

	// The version of the face model that's used by the collection for face detection.
	//
	// For more information, see Model Versioning in the Amazon Rekognition Developer
	// Guide.
	FaceModelVersion *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCollectionOutput) GoString added in v1.15.19 

func (s DescribeCollectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCollectionOutput) SetCollectionARN added in v1.15.19 

func (s *DescribeCollectionOutput) SetCollectionARN(v string) *DescribeCollectionOutput

SetCollectionARN sets the CollectionARN field's value.

func (*DescribeCollectionOutput) SetCreationTimestamp added in v1.15.19 

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeCollectionOutput) SetFaceCount added in v1.15.19 

func (s *DescribeCollectionOutput) SetFaceCount(v int64) *DescribeCollectionOutput

SetFaceCount sets the FaceCount field's value.

func (*DescribeCollectionOutput) SetFaceModelVersion added in v1.15.19 

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

SetFaceModelVersion sets the FaceModelVersion field's value.

func (DescribeCollectionOutput) String added in v1.15.19 

func (s DescribeCollectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDatasetInput added in v1.41.15 

type DescribeDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset that you want to describe.
	//
	// DatasetArn is a required field
	DatasetArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetInput) GoString added in v1.41.15 

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetInput) SetDatasetArn added in v1.41.15 

func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DescribeDatasetInput) String added in v1.41.15 

func (s DescribeDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetInput) Validate added in v1.41.15 

func (s *DescribeDatasetInput) Validate() error

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

type DescribeDatasetOutput added in v1.41.15 

type DescribeDatasetOutput struct {

	// The description for the dataset.
	DatasetDescription *DatasetDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatasetOutput) GoString added in v1.41.15 

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetOutput) SetDatasetDescription added in v1.41.15 

func (s *DescribeDatasetOutput) SetDatasetDescription(v *DatasetDescription) *DescribeDatasetOutput

SetDatasetDescription sets the DatasetDescription field's value.

func (DescribeDatasetOutput) String added in v1.41.15 

func (s DescribeDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProjectVersionsInput added in v1.25.47 

type DescribeProjectVersionsInput struct {

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

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

	// The Amazon Resource Name (ARN) of the project that contains the models you
	// want to describe.
	//
	// ProjectArn is a required field
	ProjectArn *string `min:"20" type:"string" required:"true"`

	// A list of model version names that you want to describe. You can add up to
	// 10 model version names to the list. If you don't specify a value, all model
	// descriptions are returned. A version name is part of a model (ProjectVersion)
	// ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the
	// following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.
	VersionNames []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProjectVersionsInput) GoString added in v1.25.47 

func (s DescribeProjectVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectVersionsInput) SetMaxResults added in v1.25.47 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeProjectVersionsInput) SetNextToken added in v1.25.47 

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

SetNextToken sets the NextToken field's value.

func (*DescribeProjectVersionsInput) SetProjectArn added in v1.25.47 

func (s *DescribeProjectVersionsInput) SetProjectArn(v string) *DescribeProjectVersionsInput

SetProjectArn sets the ProjectArn field's value.

func (*DescribeProjectVersionsInput) SetVersionNames added in v1.25.47 

func (s *DescribeProjectVersionsInput) SetVersionNames(v []*string) *DescribeProjectVersionsInput

SetVersionNames sets the VersionNames field's value.

func (DescribeProjectVersionsInput) String added in v1.25.47 

func (s DescribeProjectVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectVersionsInput) Validate added in v1.25.47 

func (s *DescribeProjectVersionsInput) Validate() error

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

type DescribeProjectVersionsOutput added in v1.25.47 

type DescribeProjectVersionsOutput struct {

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

	// A list of model descriptions. The list is sorted by the creation date and
	// time of the model versions, latest to earliest.
	ProjectVersionDescriptions []*ProjectVersionDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProjectVersionsOutput) GoString added in v1.25.47 

func (s DescribeProjectVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectVersionsOutput) SetNextToken added in v1.25.47 

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

SetNextToken sets the NextToken field's value.

func (*DescribeProjectVersionsOutput) SetProjectVersionDescriptions added in v1.25.47 

func (s *DescribeProjectVersionsOutput) SetProjectVersionDescriptions(v []*ProjectVersionDescription) *DescribeProjectVersionsOutput

SetProjectVersionDescriptions sets the ProjectVersionDescriptions field's value.

func (DescribeProjectVersionsOutput) String added in v1.25.47 

func (s DescribeProjectVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProjectsInput added in v1.25.47 

type DescribeProjectsInput struct {

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

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

	// A list of the projects that you want Amazon Rekognition Custom Labels to
	// describe. If you don't specify a value, the response includes descriptions
	// for all the projects in your AWS account.
	ProjectNames []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProjectsInput) GoString added in v1.25.47 

func (s DescribeProjectsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectsInput) SetMaxResults added in v1.25.47 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeProjectsInput) SetNextToken added in v1.25.47 

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

SetNextToken sets the NextToken field's value.

func (*DescribeProjectsInput) SetProjectNames added in v1.41.15 

func (s *DescribeProjectsInput) SetProjectNames(v []*string) *DescribeProjectsInput

SetProjectNames sets the ProjectNames field's value.

func (DescribeProjectsInput) String added in v1.25.47 

func (s DescribeProjectsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectsInput) Validate added in v1.25.47 

func (s *DescribeProjectsInput) Validate() error

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

type DescribeProjectsOutput added in v1.25.47 

type DescribeProjectsOutput struct {

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

	// A list of project descriptions. The list is sorted by the date and time the
	// projects are created.
	ProjectDescriptions []*ProjectDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProjectsOutput) GoString added in v1.25.47 

func (s DescribeProjectsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectsOutput) SetNextToken added in v1.25.47 

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

SetNextToken sets the NextToken field's value.

func (*DescribeProjectsOutput) SetProjectDescriptions added in v1.25.47 

func (s *DescribeProjectsOutput) SetProjectDescriptions(v []*ProjectDescription) *DescribeProjectsOutput

SetProjectDescriptions sets the ProjectDescriptions field's value.

func (DescribeProjectsOutput) String added in v1.25.47 

func (s DescribeProjectsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// 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"`

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

	// Kinesis data stream to which Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectCustomLabelsInput added in v1.25.47 

type DetectCustomLabelsInput struct {

	// Provides the input image either as bytes or an S3 object.
	//
	// You pass image bytes to an Amazon Rekognition API operation by using the
	// Bytes property. For example, you would use the Bytes property to pass an
	// image loaded from a local file system. Image bytes passed by using the Bytes
	// property must be base64-encoded. Your code may not need to encode image bytes
	// if you are using an AWS SDK to call Amazon Rekognition API operations.
	//
	// For more information, see Analyzing an Image Loaded from a Local File System
	// in the Amazon Rekognition Developer Guide.
	//
	// You pass images stored in an S3 bucket to an Amazon Rekognition API operation
	// by using the S3Object property. Images stored in an S3 bucket do not need
	// to be base64-encoded.
	//
	// The region for the S3 bucket containing the S3 object must match the region
	// you use for Amazon Rekognition operations.
	//
	// If you use the AWS CLI to call Amazon Rekognition operations, passing image
	// bytes using the Bytes property is not supported. You must first upload the
	// image to an Amazon S3 bucket and then call the operation using the S3Object
	// property.
	//
	// For Amazon Rekognition to process an S3 object, the user must have permission
	// to access the S3 object. For more information, see Resource Based Policies
	// in the Amazon Rekognition Developer Guide.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

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

	// Specifies the minimum confidence level for the labels to return. DetectCustomLabels
	// doesn't return any labels with a confidence value that's lower than this
	// specified value. If you specify a value of 0, DetectCustomLabels returns
	// all labels, regardless of the assumed threshold applied to each label. If
	// you don't specify a value for MinConfidence, DetectCustomLabels returns labels
	// based on the assumed threshold of each label.
	MinConfidence *float64 `type:"float"`

	// The ARN of the model version that you want to use.
	//
	// ProjectVersionArn is a required field
	ProjectVersionArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectCustomLabelsInput) GoString added in v1.25.47 

func (s DetectCustomLabelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectCustomLabelsInput) SetImage added in v1.25.47 

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

SetImage sets the Image field's value.

func (*DetectCustomLabelsInput) SetMaxResults added in v1.25.47 

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

SetMaxResults sets the MaxResults field's value.

func (*DetectCustomLabelsInput) SetMinConfidence added in v1.25.47 

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

SetMinConfidence sets the MinConfidence field's value.

func (*DetectCustomLabelsInput) SetProjectVersionArn added in v1.25.47 

func (s *DetectCustomLabelsInput) SetProjectVersionArn(v string) *DetectCustomLabelsInput

SetProjectVersionArn sets the ProjectVersionArn field's value.

func (DetectCustomLabelsInput) String added in v1.25.47 

func (s DetectCustomLabelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectCustomLabelsInput) Validate added in v1.25.47 

func (s *DetectCustomLabelsInput) Validate() error

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

type DetectCustomLabelsOutput added in v1.25.47 

type DetectCustomLabelsOutput struct {

	// An array of custom labels detected in the input image.
	CustomLabels []*CustomLabel `type:"list"`
	// contains filtered or unexported fields
}

func (DetectCustomLabelsOutput) GoString added in v1.25.47 

func (s DetectCustomLabelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectCustomLabelsOutput) SetCustomLabels added in v1.25.47 

func (s *DetectCustomLabelsOutput) SetCustomLabels(v []*CustomLabel) *DetectCustomLabelsOutput

SetCustomLabels sets the CustomLabels field's value.

func (DetectCustomLabelsOutput) String added in v1.25.47 

func (s DetectCustomLabelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 takes
	// 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" enum:"Attribute"`

	// 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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 value of OrientationCorrection is always null.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// file format (Exif) metadata that includes the image's orientation. Amazon
	// Rekognition uses this orientation information to perform image correction.
	// The bounding box coordinates are translated to represent object locations
	// after the orientation information in the Exif metadata is used to correct
	// the image orientation. Images in .png format don't contain Exif metadata.
	//
	// Amazon Rekognition doesn’t perform image correction for images in .png
	// format and .jpeg images without orientation information in the image Exif
	// metadata. The bounding box coordinates aren't translated and represent the
	// object locations before the image is rotated.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`
	// contains filtered or unexported fields
}

func (DetectFacesOutput) GoString 

func (s DetectFacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 image bytes is not supported.
	// Images stored in an S3 Bucket do not need to be base64-encoded.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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 55 percent.
	MinConfidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (DetectLabelsInput) GoString 

func (s DetectLabelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Version number of the label detection model that was used to detect labels.
	LabelModelVersion *string `type:"string"`

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

	// The value of OrientationCorrection is always null.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// file format (Exif) metadata that includes the image's orientation. Amazon
	// Rekognition uses this orientation information to perform image correction.
	// The bounding box coordinates are translated to represent object locations
	// after the orientation information in the Exif metadata is used to correct
	// the image orientation. Images in .png format don't contain Exif metadata.
	//
	// Amazon Rekognition doesn’t perform image correction for images in .png
	// format and .jpeg images without orientation information in the image Exif
	// metadata. The bounding box coordinates aren't translated and represent the
	// object locations before the image is rotated.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`
	// contains filtered or unexported fields
}

func (DetectLabelsOutput) GoString 

func (s DetectLabelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectLabelsOutput) SetLabelModelVersion added in v1.15.68 

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

SetLabelModelVersion sets the LabelModelVersion field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectModerationLabelsInput added in v1.8.14 

type DetectModerationLabelsInput struct {

	// Sets up the configuration for human evaluation, including the FlowDefinition
	// the image will be sent to.
	HumanLoopConfig *HumanLoopConfig `type:"structure"`

	// 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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectModerationLabelsInput) SetHumanLoopConfig added in v1.25.47 

func (s *DetectModerationLabelsInput) SetHumanLoopConfig(v *HumanLoopConfig) *DetectModerationLabelsInput

SetHumanLoopConfig sets the HumanLoopConfig field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Shows the results of the human in the loop evaluation.
	HumanLoopActivationOutput *HumanLoopActivationOutput `type:"structure"`

	// Array of detected Moderation labels and the time, in milliseconds from the
	// start of the video, they were detected.
	ModerationLabels []*ModerationLabel `type:"list"`

	// Version number of the moderation detection model that was used to detect
	// unsafe content.
	ModerationModelVersion *string `type:"string"`
	// contains filtered or unexported fields
}

func (DetectModerationLabelsOutput) GoString added in v1.8.14 

func (s DetectModerationLabelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectModerationLabelsOutput) SetHumanLoopActivationOutput added in v1.25.47 

func (s *DetectModerationLabelsOutput) SetHumanLoopActivationOutput(v *HumanLoopActivationOutput) *DetectModerationLabelsOutput

SetHumanLoopActivationOutput sets the HumanLoopActivationOutput field's value.

func (*DetectModerationLabelsOutput) SetModerationLabels added in v1.8.14 

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

SetModerationLabels sets the ModerationLabels field's value.

func (*DetectModerationLabelsOutput) SetModerationModelVersion added in v1.16.21 

func (s *DetectModerationLabelsOutput) SetModerationModelVersion(v string) *DetectModerationLabelsOutput

SetModerationModelVersion sets the ModerationModelVersion field's value.

func (DetectModerationLabelsOutput) String added in v1.8.14 

func (s DetectModerationLabelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectProtectiveEquipmentInput added in v1.35.8 

type DetectProtectiveEquipmentInput struct {

	// The image in which you want to detect PPE on detected persons. The image
	// can be passed as image bytes or you can reference an image stored in an Amazon
	// S3 bucket.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

	// An array of PPE types that you want to summarize.
	SummarizationAttributes *ProtectiveEquipmentSummarizationAttributes `type:"structure"`
	// contains filtered or unexported fields
}

func (DetectProtectiveEquipmentInput) GoString added in v1.35.8 

func (s DetectProtectiveEquipmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectProtectiveEquipmentInput) SetImage added in v1.35.8 

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

SetImage sets the Image field's value.

func (*DetectProtectiveEquipmentInput) SetSummarizationAttributes added in v1.35.8 

func (s *DetectProtectiveEquipmentInput) SetSummarizationAttributes(v *ProtectiveEquipmentSummarizationAttributes) *DetectProtectiveEquipmentInput

SetSummarizationAttributes sets the SummarizationAttributes field's value.

func (DetectProtectiveEquipmentInput) String added in v1.35.8 

func (s DetectProtectiveEquipmentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectProtectiveEquipmentInput) Validate added in v1.35.8 

func (s *DetectProtectiveEquipmentInput) Validate() error

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

type DetectProtectiveEquipmentOutput added in v1.35.8 

type DetectProtectiveEquipmentOutput struct {

	// An array of persons detected in the image (including persons not wearing
	// PPE).
	Persons []*ProtectiveEquipmentPerson `type:"list"`

	// The version number of the PPE detection model used to detect PPE in the image.
	ProtectiveEquipmentModelVersion *string `type:"string"`

	// Summary information for the types of PPE specified in the SummarizationAttributes
	// input parameter.
	Summary *ProtectiveEquipmentSummary `type:"structure"`
	// contains filtered or unexported fields
}

func (DetectProtectiveEquipmentOutput) GoString added in v1.35.8 

func (s DetectProtectiveEquipmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectProtectiveEquipmentOutput) SetPersons added in v1.35.8 

func (s *DetectProtectiveEquipmentOutput) SetPersons(v []*ProtectiveEquipmentPerson) *DetectProtectiveEquipmentOutput

SetPersons sets the Persons field's value.

func (*DetectProtectiveEquipmentOutput) SetProtectiveEquipmentModelVersion added in v1.35.8 

func (s *DetectProtectiveEquipmentOutput) SetProtectiveEquipmentModelVersion(v string) *DetectProtectiveEquipmentOutput

SetProtectiveEquipmentModelVersion sets the ProtectiveEquipmentModelVersion field's value.

func (*DetectProtectiveEquipmentOutput) SetSummary added in v1.35.8 

func (s *DetectProtectiveEquipmentOutput) SetSummary(v *ProtectiveEquipmentSummary) *DetectProtectiveEquipmentOutput

SetSummary sets the Summary field's value.

func (DetectProtectiveEquipmentOutput) String added in v1.35.8 

func (s DetectProtectiveEquipmentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectTextFilters added in v1.29.4 

type DetectTextFilters struct {

	// A Filter focusing on a certain area of the image. Uses a BoundingBox object
	// to set the region of the image.
	RegionsOfInterest []*RegionOfInterest `type:"list"`

	// A set of parameters that allow you to filter out certain results from your
	// returned results.
	WordFilter *DetectionFilter `type:"structure"`
	// contains filtered or unexported fields
}

A set of optional parameters that you can use to set the criteria that the text must meet to be included in your response. WordFilter looks at a word’s height, width, and minimum confidence. RegionOfInterest lets you set a specific region of the image to look for text in.

func (DetectTextFilters) GoString added in v1.29.4 

func (s DetectTextFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectTextFilters) SetRegionsOfInterest added in v1.29.4 

func (s *DetectTextFilters) SetRegionsOfInterest(v []*RegionOfInterest) *DetectTextFilters

SetRegionsOfInterest sets the RegionsOfInterest field's value.

func (*DetectTextFilters) SetWordFilter added in v1.29.4 

func (s *DetectTextFilters) SetWordFilter(v *DetectionFilter) *DetectTextFilters

SetWordFilter sets the WordFilter field's value.

func (DetectTextFilters) String added in v1.29.4 

func (s DetectTextFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectTextInput added in v1.12.32 

type DetectTextInput struct {

	// Optional parameters that let you set the criteria that the text must meet
	// to be included in your response.
	Filters *DetectTextFilters `type:"structure"`

	// 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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectTextInput) SetFilters added in v1.29.4 

func (s *DetectTextInput) SetFilters(v *DetectTextFilters) *DetectTextInput

SetFilters sets the Filters field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// The model version used to detect text.
	TextModelVersion *string `type:"string"`
	// contains filtered or unexported fields
}

func (DetectTextOutput) GoString added in v1.12.32 

func (s DetectTextOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectTextOutput) SetTextDetections added in v1.12.32 

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

SetTextDetections sets the TextDetections field's value.

func (*DetectTextOutput) SetTextModelVersion added in v1.29.4 

func (s *DetectTextOutput) SetTextModelVersion(v string) *DetectTextOutput

SetTextModelVersion sets the TextModelVersion field's value.

func (DetectTextOutput) String added in v1.12.32 

func (s DetectTextOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectionFilter added in v1.29.4 

type DetectionFilter struct {

	// Sets the minimum height of the word bounding box. Words with bounding box
	// heights lesser than this value will be excluded from the result. Value is
	// relative to the video frame height.
	MinBoundingBoxHeight *float64 `type:"float"`

	// Sets the minimum width of the word bounding box. Words with bounding boxes
	// widths lesser than this value will be excluded from the result. Value is
	// relative to the video frame width.
	MinBoundingBoxWidth *float64 `type:"float"`

	// Sets the confidence of word detection. Words with detection confidence below
	// this will be excluded from the result. Values should be between 50 and 100
	// as Text in Video will not return any result below 50.
	MinConfidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

A set of parameters that allow you to filter out certain results from your returned results.

func (DetectionFilter) GoString added in v1.29.4 

func (s DetectionFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectionFilter) SetMinBoundingBoxHeight added in v1.29.4 

func (s *DetectionFilter) SetMinBoundingBoxHeight(v float64) *DetectionFilter

SetMinBoundingBoxHeight sets the MinBoundingBoxHeight field's value.

func (*DetectionFilter) SetMinBoundingBoxWidth added in v1.29.4 

func (s *DetectionFilter) SetMinBoundingBoxWidth(v float64) *DetectionFilter

SetMinBoundingBoxWidth sets the MinBoundingBoxWidth field's value.

func (*DetectionFilter) SetMinConfidence added in v1.29.4 

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

SetMinConfidence sets the MinConfidence field's value.

func (DetectionFilter) String added in v1.29.4 

func (s DetectionFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DistributeDataset added in v1.41.15 

type DistributeDataset struct {

	// The Amazon Resource Name (ARN) of the dataset that you want to use.
	//
	// Arn is a required field
	Arn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A training dataset or a test dataset used in a dataset distribution operation. For more information, see DistributeDatasetEntries.

func (DistributeDataset) GoString added in v1.41.15 

func (s DistributeDataset) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DistributeDataset) SetArn added in v1.41.15 

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

SetArn sets the Arn field's value.

func (DistributeDataset) String added in v1.41.15 

func (s DistributeDataset) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DistributeDataset) Validate added in v1.41.15 

func (s *DistributeDataset) Validate() error

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

type DistributeDatasetEntriesInput added in v1.41.15 

type DistributeDatasetEntriesInput struct {

	// The ARNS for the training dataset and test dataset that you want to use.
	// The datasets must belong to the same project. The test dataset must be empty.
	//
	// Datasets is a required field
	Datasets []*DistributeDataset `min:"2" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DistributeDatasetEntriesInput) GoString added in v1.41.15 

func (s DistributeDatasetEntriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DistributeDatasetEntriesInput) SetDatasets added in v1.41.15 

func (s *DistributeDatasetEntriesInput) SetDatasets(v []*DistributeDataset) *DistributeDatasetEntriesInput

SetDatasets sets the Datasets field's value.

func (DistributeDatasetEntriesInput) String added in v1.41.15 

func (s DistributeDatasetEntriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DistributeDatasetEntriesInput) Validate added in v1.41.15 

func (s *DistributeDatasetEntriesInput) Validate() error

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

type DistributeDatasetEntriesOutput added in v1.41.15 

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

func (DistributeDatasetEntriesOutput) GoString added in v1.41.15 

func (s DistributeDatasetEntriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DistributeDatasetEntriesOutput) String added in v1.41.15 

func (s DistributeDatasetEntriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

func (Emotion) GoString 

func (s Emotion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EquipmentDetection added in v1.35.8 

type EquipmentDetection struct {

	// A bounding box surrounding the item of detected PPE.
	BoundingBox *BoundingBox `type:"structure"`

	// The confidence that Amazon Rekognition has that the bounding box (BoundingBox)
	// contains an item of PPE.
	Confidence *float64 `type:"float"`

	// Information about the body part covered by the detected PPE.
	CoversBodyPart *CoversBodyPart `type:"structure"`

	// The type of detected PPE.
	Type *string `type:"string" enum:"ProtectiveEquipmentType"`
	// contains filtered or unexported fields
}

Information about an item of Personal Protective Equipment (PPE) detected by DetectProtectiveEquipment. For more information, see DetectProtectiveEquipment.

func (EquipmentDetection) GoString added in v1.35.8 

func (s EquipmentDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EquipmentDetection) SetBoundingBox added in v1.35.8 

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

SetBoundingBox sets the BoundingBox field's value.

func (*EquipmentDetection) SetConfidence added in v1.35.8 

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

SetConfidence sets the Confidence field's value.

func (*EquipmentDetection) SetCoversBodyPart added in v1.35.8 

func (s *EquipmentDetection) SetCoversBodyPart(v *CoversBodyPart) *EquipmentDetection

SetCoversBodyPart sets the CoversBodyPart field's value.

func (*EquipmentDetection) SetType added in v1.35.8 

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

SetType sets the Type field's value.

func (EquipmentDetection) String added in v1.35.8 

func (s EquipmentDetection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EvaluationResult added in v1.25.47 

type EvaluationResult struct {

	// The F1 score for the evaluation of all labels. The F1 score metric evaluates
	// the overall precision and recall performance of the model as a single value.
	// A higher value indicates better precision and recall performance. A lower
	// score indicates that precision, recall, or both are performing poorly.
	F1Score *float64 `type:"float"`

	// The S3 bucket that contains the training summary.
	Summary *Summary `type:"structure"`
	// contains filtered or unexported fields
}

The evaluation results for the training of a model.

func (EvaluationResult) GoString added in v1.25.47 

func (s EvaluationResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EvaluationResult) SetF1Score added in v1.25.47 

func (s *EvaluationResult) SetF1Score(v float64) *EvaluationResult

SetF1Score sets the F1Score field's value.

func (*EvaluationResult) SetSummary added in v1.25.47 

func (s *EvaluationResult) SetSummary(v *Summary) *EvaluationResult

SetSummary sets the Summary field's value.

func (EvaluationResult) String added in v1.25.47 

func (s EvaluationResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// The version of the face detect and storage model that was used when indexing
	// the face vector.
	IndexFacesModelVersion *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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIndexFacesModelVersion added in v1.42.27 

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

SetIndexFacesModelVersion sets the IndexFacesModelVersion field's value.

func (Face) String 

func (s Face) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that appear to be expressed on the face, and the confidence
	// level in the determination. The API is only making a determination of the
	// physical appearance of a person's face. It is not a determination of the
	// person’s internal emotional state and should not be used in such a way.
	// For example, a person pretending to have a sad face might not be sad emotionally.
	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"`

	// The predicted gender of a detected face.
	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.

GetFaceDetection is the only Amazon 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 StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes input parameter.

  • GetCelebrityRecognition

  • GetPersonTracking

  • GetFaceSearch

The Amazon Rekognition Image DetectFaces and IndexFaces 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 backend 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The default is 80. 0 is the lowest confidence. 100 is
	// the highest confidence. Values between 0 and 100 are accepted, and values
	// lower than 80 are set to 80.
	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 CreateStreamProcessor.

func (FaceSearchSettings) GoString added in v1.12.36 

func (s FaceSearchSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 prediction.
	Confidence *float64 `type:"float"`

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

The predicted gender of a detected face.

Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor wearing a long-haired wig and earrings for a role might be predicted as female.

Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.

We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.

func (Gender) GoString 

func (s Gender) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Geometry added in v1.12.32 

type Geometry struct {

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

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

Information about where an object (DetectCustomLabels) or text (DetectText) is located on an image.

func (Geometry) GoString added in v1.12.32 

func (s Geometry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 RecognizeCelebrities
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Retrieves the known gender for the celebrity.
	KnownGender *KnownGender `type:"structure"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCelebrityInfoOutput) SetKnownGender added in v1.40.31 

func (s *GetCelebrityInfoOutput) SetKnownGender(v *KnownGender) *GetCelebrityInfoOutput

SetKnownGender sets the KnownGender field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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), Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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, Amazon 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 Amazon 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 (GetCelebrityRecognitionOutput) GoString added in v1.12.36 

func (s GetCelebrityRecognitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContentModerationInput added in v1.12.36 

type GetContentModerationInput struct {

	// The identifier for the inappropriate, unwanted, or offensive 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 analysis job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

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

	// Version number of the moderation detection model that was used to detect
	// inappropriate, unwanted, or offensive content.
	ModerationModelVersion *string `type:"string"`

	// If the response is truncated, Amazon Rekognition Video returns this token
	// that you can use in the subsequent request to retrieve the next set of content
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetModerationModelVersion added in v1.16.34 

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

SetModerationModelVersion sets the ModerationModelVersion 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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), Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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), Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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, Amazon 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, PersonMatch, 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 Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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), Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Version number of the label detection model that was used to detect labels.
	LabelModelVersion *string `type:"string"`

	// 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, Amazon 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 Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLabelDetectionOutput) SetJobStatus added in v1.12.36 

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

SetJobStatus sets the JobStatus field's value.

func (*GetLabelDetectionOutput) SetLabelModelVersion added in v1.16.21 

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

SetLabelModelVersion sets the LabelModelVersion 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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), Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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, Amazon 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 time(s) their path
	// was tracked throughout the video. An array element will exist for each time
	// a person's path 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 Amazon 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 (GetPersonTrackingOutput) GoString added in v1.12.36 

func (s GetPersonTrackingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSegmentDetectionInput added in v1.32.7 

type GetSegmentDetectionInput struct {

	// Job identifier for the text detection operation for which you want results
	// returned. You get the job identifer from an initial call to StartSegmentDetection.
	//
	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (GetSegmentDetectionInput) GoString added in v1.32.7 

func (s GetSegmentDetectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentDetectionInput) SetJobId added in v1.32.7 

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

SetJobId sets the JobId field's value.

func (*GetSegmentDetectionInput) SetMaxResults added in v1.32.7 

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

SetMaxResults sets the MaxResults field's value.

func (*GetSegmentDetectionInput) SetNextToken added in v1.32.7 

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

SetNextToken sets the NextToken field's value.

func (GetSegmentDetectionInput) String added in v1.32.7 

func (s GetSegmentDetectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentDetectionInput) Validate added in v1.32.7 

func (s *GetSegmentDetectionInput) Validate() error

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

type GetSegmentDetectionOutput added in v1.32.7 

type GetSegmentDetectionOutput struct {

	// An array of objects. There can be multiple audio streams. Each AudioMetadata
	// object contains metadata for a single audio stream. Audio information in
	// an AudioMetadata objects includes the audio codec, the number of audio channels,
	// the duration of the audio stream, and the sample rate. Audio metadata is
	// returned in each page of information returned by GetSegmentDetection.
	AudioMetadata []*AudioMetadata `type:"list"`

	// Current status of the segment detection job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

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

	// An array of segments detected in a video. The array is sorted by the segment
	// types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter
	// of StartSegmentDetection. Within each segment type the array is sorted by
	// timestamp values.
	Segments []*SegmentDetection `type:"list"`

	// An array containing the segment types requested in the call to StartSegmentDetection.
	SelectedSegmentTypes []*SegmentTypeInfo `type:"list"`

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

	// Currently, Amazon Rekognition Video returns a single object in the VideoMetadata
	// array. The object contains information about the video stream in the input
	// file that Amazon Rekognition Video chose to analyze. The VideoMetadata object
	// includes the video codec, video format and other information. Video metadata
	// is returned in each page of information returned by GetSegmentDetection.
	VideoMetadata []*VideoMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (GetSegmentDetectionOutput) GoString added in v1.32.7 

func (s GetSegmentDetectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentDetectionOutput) SetAudioMetadata added in v1.32.7 

func (s *GetSegmentDetectionOutput) SetAudioMetadata(v []*AudioMetadata) *GetSegmentDetectionOutput

SetAudioMetadata sets the AudioMetadata field's value.

func (*GetSegmentDetectionOutput) SetJobStatus added in v1.32.7 

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

SetJobStatus sets the JobStatus field's value.

func (*GetSegmentDetectionOutput) SetNextToken added in v1.32.7 

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

SetNextToken sets the NextToken field's value.

func (*GetSegmentDetectionOutput) SetSegments added in v1.32.7 

func (s *GetSegmentDetectionOutput) SetSegments(v []*SegmentDetection) *GetSegmentDetectionOutput

SetSegments sets the Segments field's value.

func (*GetSegmentDetectionOutput) SetSelectedSegmentTypes added in v1.32.7 

func (s *GetSegmentDetectionOutput) SetSelectedSegmentTypes(v []*SegmentTypeInfo) *GetSegmentDetectionOutput

SetSelectedSegmentTypes sets the SelectedSegmentTypes field's value.

func (*GetSegmentDetectionOutput) SetStatusMessage added in v1.32.7 

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetSegmentDetectionOutput) SetVideoMetadata added in v1.32.7 

func (s *GetSegmentDetectionOutput) SetVideoMetadata(v []*VideoMetadata) *GetSegmentDetectionOutput

SetVideoMetadata sets the VideoMetadata field's value.

func (GetSegmentDetectionOutput) String added in v1.32.7 

func (s GetSegmentDetectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTextDetectionInput added in v1.29.4 

type GetTextDetectionInput struct {

	// Job identifier for the text detection operation for which you want results
	// returned. You get the job identifer from an initial call to StartTextDetection.
	//
	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (GetTextDetectionInput) GoString added in v1.29.4 

func (s GetTextDetectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTextDetectionInput) SetJobId added in v1.29.4 

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

SetJobId sets the JobId field's value.

func (*GetTextDetectionInput) SetMaxResults added in v1.29.4 

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

SetMaxResults sets the MaxResults field's value.

func (*GetTextDetectionInput) SetNextToken added in v1.29.4 

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

SetNextToken sets the NextToken field's value.

func (GetTextDetectionInput) String added in v1.29.4 

func (s GetTextDetectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTextDetectionInput) Validate added in v1.29.4 

func (s *GetTextDetectionInput) Validate() error

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

type GetTextDetectionOutput added in v1.29.4 

type GetTextDetectionOutput struct {

	// Current status of the text detection job.
	JobStatus *string `type:"string" enum:"VideoJobStatus"`

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

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

	// An array of text detected in the video. Each element contains the detected
	// text, the time in milliseconds from the start of the video that the text
	// was detected, and where it was detected on the screen.
	TextDetections []*TextDetectionResult `type:"list"`

	// Version number of the text detection model that was used to detect text.
	TextModelVersion *string `type:"string"`

	// Information about a video that Amazon Rekognition 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 (GetTextDetectionOutput) GoString added in v1.29.4 

func (s GetTextDetectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTextDetectionOutput) SetJobStatus added in v1.29.4 

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

SetJobStatus sets the JobStatus field's value.

func (*GetTextDetectionOutput) SetNextToken added in v1.29.4 

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

SetNextToken sets the NextToken field's value.

func (*GetTextDetectionOutput) SetStatusMessage added in v1.29.4 

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetTextDetectionOutput) SetTextDetections added in v1.29.4 

func (s *GetTextDetectionOutput) SetTextDetections(v []*TextDetectionResult) *GetTextDetectionOutput

SetTextDetections sets the TextDetections field's value.

func (*GetTextDetectionOutput) SetTextModelVersion added in v1.29.4 

func (s *GetTextDetectionOutput) SetTextModelVersion(v string) *GetTextDetectionOutput

SetTextModelVersion sets the TextModelVersion field's value.

func (*GetTextDetectionOutput) SetVideoMetadata added in v1.29.4 

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetTextDetectionOutput) String added in v1.29.4 

func (s GetTextDetectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GroundTruthManifest added in v1.25.47 

type GroundTruthManifest struct {

	// Provides the S3 bucket name and object name.
	//
	// The region for the S3 bucket containing the S3 object must match the region
	// you use for Amazon Rekognition operations.
	//
	// For Amazon Rekognition to process an S3 object, the user must have permission
	// to access the S3 object. For more information, see Resource-Based Policies
	// in the Amazon Rekognition Developer Guide.
	S3Object *S3Object `type:"structure"`
	// contains filtered or unexported fields
}

The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

func (GroundTruthManifest) GoString added in v1.25.47 

func (s GroundTruthManifest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroundTruthManifest) SetS3Object added in v1.25.47 

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

SetS3Object sets the S3Object field's value.

func (GroundTruthManifest) String added in v1.25.47 

func (s GroundTruthManifest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroundTruthManifest) Validate added in v1.25.47 

func (s *GroundTruthManifest) Validate() error

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

type HumanLoopActivationOutput added in v1.25.47 

type HumanLoopActivationOutput struct {

	// Shows the result of condition evaluations, including those conditions which
	// activated a human review.
	HumanLoopActivationConditionsEvaluationResults aws.JSONValue `type:"jsonvalue"`

	// Shows if and why human review was needed.
	HumanLoopActivationReasons []*string `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the HumanLoop created.
	HumanLoopArn *string `type:"string"`
	// contains filtered or unexported fields
}

Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.

func (HumanLoopActivationOutput) GoString added in v1.25.47 

func (s HumanLoopActivationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopActivationOutput) SetHumanLoopActivationConditionsEvaluationResults added in v1.25.47 

func (s *HumanLoopActivationOutput) SetHumanLoopActivationConditionsEvaluationResults(v aws.JSONValue) *HumanLoopActivationOutput

SetHumanLoopActivationConditionsEvaluationResults sets the HumanLoopActivationConditionsEvaluationResults field's value.

func (*HumanLoopActivationOutput) SetHumanLoopActivationReasons added in v1.25.47 

func (s *HumanLoopActivationOutput) SetHumanLoopActivationReasons(v []*string) *HumanLoopActivationOutput

SetHumanLoopActivationReasons sets the HumanLoopActivationReasons field's value.

func (*HumanLoopActivationOutput) SetHumanLoopArn added in v1.25.47 

func (s *HumanLoopActivationOutput) SetHumanLoopArn(v string) *HumanLoopActivationOutput

SetHumanLoopArn sets the HumanLoopArn field's value.

func (HumanLoopActivationOutput) String added in v1.25.47 

func (s HumanLoopActivationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HumanLoopConfig added in v1.25.47 

type HumanLoopConfig struct {

	// Sets attributes of the input data.
	DataAttributes *HumanLoopDataAttributes `type:"structure"`

	// The Amazon Resource Name (ARN) of the flow definition. You can create a flow
	// definition by using the Amazon Sagemaker CreateFlowDefinition (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html)
	// Operation.
	//
	// FlowDefinitionArn is a required field
	FlowDefinitionArn *string `type:"string" required:"true"`

	// The name of the human review used for this image. This should be kept unique
	// within a region.
	//
	// HumanLoopName is a required field
	HumanLoopName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Sets up the flow definition the image will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.

func (HumanLoopConfig) GoString added in v1.25.47 

func (s HumanLoopConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopConfig) SetDataAttributes added in v1.25.47 

func (s *HumanLoopConfig) SetDataAttributes(v *HumanLoopDataAttributes) *HumanLoopConfig

SetDataAttributes sets the DataAttributes field's value.

func (*HumanLoopConfig) SetFlowDefinitionArn added in v1.25.47 

func (s *HumanLoopConfig) SetFlowDefinitionArn(v string) *HumanLoopConfig

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*HumanLoopConfig) SetHumanLoopName added in v1.25.47 

func (s *HumanLoopConfig) SetHumanLoopName(v string) *HumanLoopConfig

SetHumanLoopName sets the HumanLoopName field's value.

func (HumanLoopConfig) String added in v1.25.47 

func (s HumanLoopConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopConfig) Validate added in v1.25.47 

func (s *HumanLoopConfig) Validate() error

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

type HumanLoopDataAttributes added in v1.25.47 

type HumanLoopDataAttributes struct {

	// Sets whether the input image is free of personally identifiable information.
	ContentClassifiers []*string `type:"list" enum:"ContentClassifier"`
	// contains filtered or unexported fields
}

Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information.

func (HumanLoopDataAttributes) GoString added in v1.25.47 

func (s HumanLoopDataAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopDataAttributes) SetContentClassifiers added in v1.25.47 

func (s *HumanLoopDataAttributes) SetContentClassifiers(v []*string) *HumanLoopDataAttributes

SetContentClassifiers sets the ContentClassifiers field's value.

func (HumanLoopDataAttributes) String added in v1.25.47 

func (s HumanLoopDataAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HumanLoopQuotaExceededException added in v1.28.0 

type HumanLoopQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The quota code.
	QuotaCode *string `type:"string"`

	// The resource type.
	ResourceType *string `type:"string"`

	// The service code.
	ServiceCode *string `type:"string"`
	// contains filtered or unexported fields
}

The number of in-progress human reviews you have has exceeded the number allowed.

func (*HumanLoopQuotaExceededException) Code added in v1.28.0 

func (s *HumanLoopQuotaExceededException) Code() string

Code returns the exception type name.

func (*HumanLoopQuotaExceededException) Error added in v1.28.0 

func (s *HumanLoopQuotaExceededException) Error() string

func (HumanLoopQuotaExceededException) GoString added in v1.28.0 

func (s HumanLoopQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HumanLoopQuotaExceededException) Message added in v1.28.0 

func (s *HumanLoopQuotaExceededException) Message() string

Message returns the exception's message.

func (*HumanLoopQuotaExceededException) OrigErr added in v1.28.0 

func (s *HumanLoopQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*HumanLoopQuotaExceededException) RequestID added in v1.28.0 

func (s *HumanLoopQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*HumanLoopQuotaExceededException) StatusCode added in v1.28.0 

func (s *HumanLoopQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (HumanLoopQuotaExceededException) String added in v1.28.0 

func (s HumanLoopQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdempotentParameterMismatchException added in v1.28.0 

type IdempotentParameterMismatchException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*IdempotentParameterMismatchException) Code added in v1.28.0 

func (s *IdempotentParameterMismatchException) Code() string

Code returns the exception type name.

func (*IdempotentParameterMismatchException) Error added in v1.28.0 

func (s *IdempotentParameterMismatchException) Error() string

func (IdempotentParameterMismatchException) GoString added in v1.28.0 

func (s IdempotentParameterMismatchException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdempotentParameterMismatchException) Message added in v1.28.0 

func (s *IdempotentParameterMismatchException) Message() string

Message returns the exception's message.

func (*IdempotentParameterMismatchException) OrigErr added in v1.28.0 

func (s *IdempotentParameterMismatchException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IdempotentParameterMismatchException) RequestID added in v1.28.0 

func (s *IdempotentParameterMismatchException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IdempotentParameterMismatchException) StatusCode added in v1.28.0 

func (s *IdempotentParameterMismatchException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IdempotentParameterMismatchException) String added in v1.28.0 

func (s IdempotentParameterMismatchException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

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

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.

func (Image) GoString 

func (s Image) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImageTooLargeException added in v1.28.0 

type ImageTooLargeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

func (*ImageTooLargeException) Code added in v1.28.0 

func (s *ImageTooLargeException) Code() string

Code returns the exception type name.

func (*ImageTooLargeException) Error added in v1.28.0 

func (s *ImageTooLargeException) Error() string

func (ImageTooLargeException) GoString added in v1.28.0 

func (s ImageTooLargeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageTooLargeException) Message added in v1.28.0 

func (s *ImageTooLargeException) Message() string

Message returns the exception's message.

func (*ImageTooLargeException) OrigErr added in v1.28.0 

func (s *ImageTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ImageTooLargeException) RequestID added in v1.28.0 

func (s *ImageTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ImageTooLargeException) StatusCode added in v1.28.0 

func (s *ImageTooLargeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ImageTooLargeException) String added in v1.28.0 

func (s ImageTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 takes 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" enum:"Attribute"`

	// The 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
	// isn't supported.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

	// The maximum number of faces to index. The value of MaxFaces must be greater
	// than or equal to 1. IndexFaces returns no more than 100 detected faces in
	// an image, even if you specify a larger value for MaxFaces.
	//
	// If IndexFaces detects more faces than the value of MaxFaces, the faces with
	// the lowest quality are filtered out first. If there are still more faces
	// than the value of MaxFaces, the faces with the smallest bounding boxes are
	// filtered out (up to the number that's needed to satisfy the value of MaxFaces).
	// Information about the unindexed faces is available in the UnindexedFaces
	// array.
	//
	// The faces that are returned by IndexFaces are sorted by the largest face
	// bounding box size to the smallest size, in descending order.
	//
	// MaxFaces can be used with a collection associated with any version of the
	// face model.
	MaxFaces *int64 `min:"1" type:"integer"`

	// A filter that specifies a quality bar for how much filtering is done to identify
	// faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition
	// chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes
	// all faces that don’t meet the chosen quality bar. The default value is
	// AUTO. The quality bar is based on a variety of common use cases. Low-quality
	// detections can occur for a number of reasons. Some examples are an object
	// that's misidentified as a face, a face that's too blurry, or a face with
	// a pose that's too extreme to use. If you specify NONE, no filtering is performed.
	//
	// To use quality filtering, the collection you are using must be associated
	// with version 3 of the face model or higher.
	QualityFilter *string `type:"string" enum:"QualityFilter"`
	// contains filtered or unexported fields
}

func (IndexFacesInput) GoString 

func (s IndexFacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetMaxFaces added in v1.15.37 

func (s *IndexFacesInput) SetMaxFaces(v int64) *IndexFacesInput

SetMaxFaces sets the MaxFaces field's value.

func (*IndexFacesInput) SetQualityFilter added in v1.15.37 

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

SetQualityFilter sets the QualityFilter field's value.

func (IndexFacesInput) String 

func (s IndexFacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Latest face model being used with the collection. For more information, see
	// Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html).
	FaceModelVersion *string `type:"string"`

	// An array of faces detected and added to the collection. For more information,
	// see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
	FaceRecords []*FaceRecord `type:"list"`

	// If your collection is associated with a face detection model that's later
	// than version 3.0, the value of OrientationCorrection is always null and no
	// orientation information is returned.
	//
	// If your collection is associated with a face detection model that's version
	// 3.0 or earlier, the following applies:
	//
	//    * If the input image is in .jpeg format, it might contain exchangeable
	//    image file format (Exif) metadata that includes the image's orientation.
	//    Amazon Rekognition uses this orientation information to perform image
	//    correction - the bounding box coordinates are translated to represent
	//    object locations after the orientation information in the Exif metadata
	//    is used to correct the image orientation. Images in .png format don't
	//    contain Exif metadata. The value of OrientationCorrection is null.
	//
	//    * If the image doesn't contain orientation information in its Exif metadata,
	//    Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90,
	//    ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction
	//    for images. The bounding box coordinates aren't translated and represent
	//    the object locations before the image is rotated.
	//
	// Bounding box information is returned in the FaceRecords array. You can get
	// the version of the face detection model by calling DescribeCollection.
	OrientationCorrection *string `type:"string" enum:"OrientationCorrection"`

	// An array of faces that were detected in the image but weren't indexed. They
	// weren't indexed because the quality filter identified them as low quality,
	// or the MaxFaces request parameter filtered them out. To use the quality filter,
	// you specify the QualityFilter request parameter.
	UnindexedFaces []*UnindexedFace `type:"list"`
	// contains filtered or unexported fields
}

func (IndexFacesOutput) GoString 

func (s IndexFacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetUnindexedFaces added in v1.15.37 

func (s *IndexFacesOutput) SetUnindexedFaces(v []*UnindexedFace) *IndexFacesOutput

SetUnindexedFaces sets the UnindexedFaces field's value.

func (IndexFacesOutput) String 

func (s IndexFacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Instance added in v1.15.68 

type Instance struct {

	// The position of the label instance on the image.
	BoundingBox *BoundingBox `type:"structure"`

	// The confidence that Amazon Rekognition has in the accuracy of the bounding
	// box.
	Confidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).

func (Instance) GoString added in v1.15.68 

func (s Instance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Instance) SetBoundingBox added in v1.15.68 

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

SetBoundingBox sets the BoundingBox field's value.

func (*Instance) SetConfidence added in v1.15.68 

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

SetConfidence sets the Confidence field's value.

func (Instance) String added in v1.15.68 

func (s Instance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError added in v1.28.0 

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Amazon Rekognition experienced a service issue. Try your call again.

func (*InternalServerError) Code added in v1.28.0 

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error added in v1.28.0 

func (s *InternalServerError) Error() string

func (InternalServerError) GoString added in v1.28.0 

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message added in v1.28.0 

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr added in v1.28.0 

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID added in v1.28.0 

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode added in v1.28.0 

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String added in v1.28.0 

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidImageFormatException added in v1.28.0 

type InvalidImageFormatException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided image format is not supported.

func (*InvalidImageFormatException) Code added in v1.28.0 

func (s *InvalidImageFormatException) Code() string

Code returns the exception type name.

func (*InvalidImageFormatException) Error added in v1.28.0 

func (s *InvalidImageFormatException) Error() string

func (InvalidImageFormatException) GoString added in v1.28.0 

func (s InvalidImageFormatException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidImageFormatException) Message added in v1.28.0 

func (s *InvalidImageFormatException) Message() string

Message returns the exception's message.

func (*InvalidImageFormatException) OrigErr added in v1.28.0 

func (s *InvalidImageFormatException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidImageFormatException) RequestID added in v1.28.0 

func (s *InvalidImageFormatException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidImageFormatException) StatusCode added in v1.28.0 

func (s *InvalidImageFormatException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidImageFormatException) String added in v1.28.0 

func (s InvalidImageFormatException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidPaginationTokenException added in v1.28.0 

type InvalidPaginationTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Pagination token in the request is not valid.

func (*InvalidPaginationTokenException) Code added in v1.28.0 

func (s *InvalidPaginationTokenException) Code() string

Code returns the exception type name.

func (*InvalidPaginationTokenException) Error added in v1.28.0 

func (s *InvalidPaginationTokenException) Error() string

func (InvalidPaginationTokenException) GoString added in v1.28.0 

func (s InvalidPaginationTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPaginationTokenException) Message added in v1.28.0 

func (s *InvalidPaginationTokenException) Message() string

Message returns the exception's message.

func (*InvalidPaginationTokenException) OrigErr added in v1.28.0 

func (s *InvalidPaginationTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPaginationTokenException) RequestID added in v1.28.0 

func (s *InvalidPaginationTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPaginationTokenException) StatusCode added in v1.28.0 

func (s *InvalidPaginationTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPaginationTokenException) String added in v1.28.0 

func (s InvalidPaginationTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException added in v1.28.0 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidS3ObjectException added in v1.28.0 

type InvalidS3ObjectException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Amazon Rekognition is unable to access the S3 object specified in the request.

func (*InvalidS3ObjectException) Code added in v1.28.0 

func (s *InvalidS3ObjectException) Code() string

Code returns the exception type name.

func (*InvalidS3ObjectException) Error added in v1.28.0 

func (s *InvalidS3ObjectException) Error() string

func (InvalidS3ObjectException) GoString added in v1.28.0 

func (s InvalidS3ObjectException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidS3ObjectException) Message added in v1.28.0 

func (s *InvalidS3ObjectException) Message() string

Message returns the exception's message.

func (*InvalidS3ObjectException) OrigErr added in v1.28.0 

func (s *InvalidS3ObjectException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidS3ObjectException) RequestID added in v1.28.0 

func (s *InvalidS3ObjectException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidS3ObjectException) StatusCode added in v1.28.0 

func (s *InvalidS3ObjectException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidS3ObjectException) String added in v1.28.0 

func (s InvalidS3ObjectException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 CreateStreamProcessor in the Amazon Rekognition Developer Guide.

func (KinesisDataStream) GoString added in v1.12.36 

func (s KinesisDataStream) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Rekognition Video stream processor. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

func (KinesisVideoStream) GoString added in v1.12.36 

func (s KinesisVideoStream) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnownGender added in v1.40.31 

type KnownGender struct {

	// A string value of the KnownGender info about the Celebrity.
	Type *string `type:"string" enum:"KnownGenderType"`
	// contains filtered or unexported fields
}

The known gender identity for the celebrity that matches the provided ID. The known gender identity can be Male, Female, Nonbinary, or Unlisted.

func (KnownGender) GoString added in v1.40.31 

func (s KnownGender) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnownGender) SetType added in v1.40.31 

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

SetType sets the Type field's value.

func (KnownGender) String added in v1.40.31 

func (s KnownGender) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Label 

type Label struct {

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

	// If Label represents an object, Instances contains the bounding boxes for
	// each instance of the detected object. Bounding boxes are returned for common
	// object labels such as people, cars, furniture, apparel or pets.
	Instances []*Instance `type:"list"`

	// The name (label) of the object or scene.
	Name *string `type:"string"`

	// The parent labels for a label. The response includes all ancestor labels.
	Parents []*Parent `type:"list"`
	// contains filtered or unexported fields
}

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

func (Label) GoString 

func (s Label) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Label) SetConfidence 

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

SetConfidence sets the Confidence field's value.

func (*Label) SetInstances added in v1.15.68 

func (s *Label) SetInstances(v []*Instance) *Label

SetInstances sets the Instances field's value.

func (*Label) SetName 

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

SetName sets the Name field's value.

func (*Label) SetParents added in v1.15.68 

func (s *Label) SetParents(v []*Parent) *Label

SetParents sets the Parents field's value.

func (Label) String 

func (s Label) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Landmark 

type Landmark struct {

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

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

	// The y-coordinate of the landmark expressed as a ratio of the height of the
	// image. The y-coordinate is measured from the top of the image. For example,
	// if the image height is 200 pixels and the y-coordinate of the landmark is
	// at 50 pixels, this value is 0.25.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCollectionsOutput 

type ListCollectionsOutput struct {

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

	// Latest face models being used with the corresponding collections in the array.
	// For more information, see Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html).
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDatasetEntriesInput added in v1.41.15 

type ListDatasetEntriesInput struct {

	// Specifies a label filter for the response. The response includes an entry
	// only if one or more of the labels in ContainsLabels exist in the entry.
	ContainsLabels []*string `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) for the dataset that you want to use.
	//
	// DatasetArn is a required field
	DatasetArn *string `min:"20" type:"string" required:"true"`

	// Specifies an error filter for the response. Specify True to only include
	// entries that have errors.
	HasErrors *bool `type:"boolean"`

	// Specify true to get only the JSON Lines where the image is labeled. Specify
	// false to get only the JSON Lines where the image isn't labeled. If you don't
	// specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled
	// images.
	Labeled *bool `type:"boolean"`

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

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

	// If specified, ListDatasetEntries only returns JSON Lines where the value
	// of SourceRefContains is part of the source-ref field. The source-ref field
	// contains the Amazon S3 location of the image. You can use SouceRefContains
	// for tasks such as getting the JSON Line for a single image, or gettting JSON
	// Lines for all images within a specific folder.
	SourceRefContains *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetEntriesInput) GoString added in v1.41.15 

func (s ListDatasetEntriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetEntriesInput) SetContainsLabels added in v1.41.15 

func (s *ListDatasetEntriesInput) SetContainsLabels(v []*string) *ListDatasetEntriesInput

SetContainsLabels sets the ContainsLabels field's value.

func (*ListDatasetEntriesInput) SetDatasetArn added in v1.41.15 

func (s *ListDatasetEntriesInput) SetDatasetArn(v string) *ListDatasetEntriesInput

SetDatasetArn sets the DatasetArn field's value.

func (*ListDatasetEntriesInput) SetHasErrors added in v1.41.15 

func (s *ListDatasetEntriesInput) SetHasErrors(v bool) *ListDatasetEntriesInput

SetHasErrors sets the HasErrors field's value.

func (*ListDatasetEntriesInput) SetLabeled added in v1.41.15 

func (s *ListDatasetEntriesInput) SetLabeled(v bool) *ListDatasetEntriesInput

SetLabeled sets the Labeled field's value.

func (*ListDatasetEntriesInput) SetMaxResults added in v1.41.15 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetEntriesInput) SetNextToken added in v1.41.15 

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

SetNextToken sets the NextToken field's value.

func (*ListDatasetEntriesInput) SetSourceRefContains added in v1.41.15 

func (s *ListDatasetEntriesInput) SetSourceRefContains(v string) *ListDatasetEntriesInput

SetSourceRefContains sets the SourceRefContains field's value.

func (ListDatasetEntriesInput) String added in v1.41.15 

func (s ListDatasetEntriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetEntriesInput) Validate added in v1.41.15 

func (s *ListDatasetEntriesInput) Validate() error

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

type ListDatasetEntriesOutput added in v1.41.15 

type ListDatasetEntriesOutput struct {

	// A list of entries (images) in the dataset.
	DatasetEntries []*string `type:"list"`

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

func (ListDatasetEntriesOutput) GoString added in v1.41.15 

func (s ListDatasetEntriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetEntriesOutput) SetDatasetEntries added in v1.41.15 

func (s *ListDatasetEntriesOutput) SetDatasetEntries(v []*string) *ListDatasetEntriesOutput

SetDatasetEntries sets the DatasetEntries field's value.

func (*ListDatasetEntriesOutput) SetNextToken added in v1.41.15 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetEntriesOutput) String added in v1.41.15 

func (s ListDatasetEntriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDatasetLabelsInput added in v1.41.15 

type ListDatasetLabelsInput struct {

	// The Amazon Resource Name (ARN) of the dataset that you want to use.
	//
	// DatasetArn is a required field
	DatasetArn *string `min:"20" type:"string" required:"true"`

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

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

func (ListDatasetLabelsInput) GoString added in v1.41.15 

func (s ListDatasetLabelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetLabelsInput) SetDatasetArn added in v1.41.15 

func (s *ListDatasetLabelsInput) SetDatasetArn(v string) *ListDatasetLabelsInput

SetDatasetArn sets the DatasetArn field's value.

func (*ListDatasetLabelsInput) SetMaxResults added in v1.41.15 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetLabelsInput) SetNextToken added in v1.41.15 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetLabelsInput) String added in v1.41.15 

func (s ListDatasetLabelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetLabelsInput) Validate added in v1.41.15 

func (s *ListDatasetLabelsInput) Validate() error

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

type ListDatasetLabelsOutput added in v1.41.15 

type ListDatasetLabelsOutput struct {

	// A list of the labels in the dataset.
	DatasetLabelDescriptions []*DatasetLabelDescription `type:"list"`

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

func (ListDatasetLabelsOutput) GoString added in v1.41.15 

func (s ListDatasetLabelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetLabelsOutput) SetDatasetLabelDescriptions added in v1.41.15 

func (s *ListDatasetLabelsOutput) SetDatasetLabelDescriptions(v []*DatasetLabelDescription) *ListDatasetLabelsOutput

SetDatasetLabelDescriptions sets the DatasetLabelDescriptions field's value.

func (*ListDatasetLabelsOutput) SetNextToken added in v1.41.15 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetLabelsOutput) String added in v1.41.15 

func (s ListDatasetLabelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Latest face model being used with the collection. For more information, see
	// Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStreamProcessorsInput added in v1.12.36 

type ListStreamProcessorsInput struct {

	// Maximum number of stream processors you want Amazon 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), Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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, Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.38.5 

type ListTagsForResourceInput struct {

	// Amazon Resource Name (ARN) of the model, collection, or stream processor
	// that contains the tags that you want a list of.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.38.5 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.38.5 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.38.5 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.38.5 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.38.5 

type ListTagsForResourceOutput struct {

	// A list of key-value tags assigned to the resource.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.38.5 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.38.5 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.38.5 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 unsafe 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 inappropriate, unwanted, or offensive content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Content moderation in the Amazon Rekognition Developer Guide.

func (ModerationLabel) GoString added in v1.8.14 

func (s ModerationLabel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics).

func (NotificationChannel) GoString added in v1.12.36 

func (s NotificationChannel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 OutputConfig added in v1.25.47 

type OutputConfig struct {

	// The S3 bucket where training output is placed.
	S3Bucket *string `min:"3" type:"string"`

	// The prefix applied to the training output files.
	S3KeyPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

The S3 bucket and folder location where training output is placed.

func (OutputConfig) GoString added in v1.25.47 

func (s OutputConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputConfig) SetS3Bucket added in v1.25.47 

func (s *OutputConfig) SetS3Bucket(v string) *OutputConfig

SetS3Bucket sets the S3Bucket field's value.

func (*OutputConfig) SetS3KeyPrefix added in v1.25.47 

func (s *OutputConfig) SetS3KeyPrefix(v string) *OutputConfig

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (OutputConfig) String added in v1.25.47 

func (s OutputConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputConfig) Validate added in v1.25.47 

func (s *OutputConfig) Validate() error

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

type Parent added in v1.15.68 

type Parent struct {

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

A parent label for a label. A label can have 0, 1, or more parents.

func (Parent) GoString added in v1.15.68 

func (s Parent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parent) SetName added in v1.15.68 

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

SetName sets the Name field's value.

func (Parent) String added in v1.15.68 

func (s Parent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PersonDetection added in v1.12.36 

type PersonDetection struct {

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

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

Details and path tracking information for a single time a person's path is tracked in a video. Amazon Rekognition operations that track people's paths return an array of PersonDetection objects with elements for each time a person's path is tracked in a video.

For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.

func (PersonDetection) GoString added in v1.12.36 

func (s PersonDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch objects is returned by GetFaceSearch.

func (PersonMatch) GoString added in v1.12.36 

func (s PersonMatch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 DetectText and by DetectCustomLabels. Polygon represents a fine-grained polygon around a detected item. For more information, see Geometry in the Amazon Rekognition Developer Guide.

func (Point) GoString added in v1.12.32 

func (s Point) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProjectDescription added in v1.25.47 

type ProjectDescription struct {

	// The Unix timestamp for the date and time that the project was created.
	CreationTimestamp *time.Time `type:"timestamp"`

	// Information about the training and test datasets in the project.
	Datasets []*DatasetMetadata `type:"list"`

	// The Amazon Resource Name (ARN) of the project.
	ProjectArn *string `min:"20" type:"string"`

	// The current status of the project.
	Status *string `type:"string" enum:"ProjectStatus"`
	// contains filtered or unexported fields
}

A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects.

func (ProjectDescription) GoString added in v1.25.47 

func (s ProjectDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProjectDescription) SetCreationTimestamp added in v1.25.47 

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*ProjectDescription) SetDatasets added in v1.41.15 

func (s *ProjectDescription) SetDatasets(v []*DatasetMetadata) *ProjectDescription

SetDatasets sets the Datasets field's value.

func (*ProjectDescription) SetProjectArn added in v1.25.47 

func (s *ProjectDescription) SetProjectArn(v string) *ProjectDescription

SetProjectArn sets the ProjectArn field's value.

func (*ProjectDescription) SetStatus added in v1.25.47 

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

SetStatus sets the Status field's value.

func (ProjectDescription) String added in v1.25.47 

func (s ProjectDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProjectVersionDescription added in v1.25.47 

type ProjectVersionDescription struct {

	// The duration, in seconds, that you were billed for a successful training
	// of the model version. This value is only returned if the model version has
	// been successfully trained.
	BillableTrainingTimeInSeconds *int64 `type:"long"`

	// The Unix datetime for the date and time that training started.
	CreationTimestamp *time.Time `type:"timestamp"`

	// The training results. EvaluationResult is only returned if training is successful.
	EvaluationResult *EvaluationResult `type:"structure"`

	// The identifer for the AWS Key Management Service key (AWS KMS key) that was
	// used to encrypt the model during training.
	KmsKeyId *string `min:"1" type:"string"`

	// The location of the summary manifest. The summary manifest provides aggregate
	// data validation results for the training and test datasets.
	ManifestSummary *GroundTruthManifest `type:"structure"`

	// The minimum number of inference units used by the model. For more information,
	// see StartProjectVersion.
	MinInferenceUnits *int64 `min:"1" type:"integer"`

	// The location where training results are saved.
	OutputConfig *OutputConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the model version.
	ProjectVersionArn *string `min:"20" type:"string"`

	// The current status of the model version.
	Status *string `type:"string" enum:"ProjectVersionStatus"`

	// A descriptive message for an error or warning that occurred.
	StatusMessage *string `type:"string"`

	// Contains information about the testing results.
	TestingDataResult *TestingDataResult `type:"structure"`

	// Contains information about the training results.
	TrainingDataResult *TrainingDataResult `type:"structure"`

	// The Unix date and time that training of the model ended.
	TrainingEndTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A description of a version of an Amazon Rekognition Custom Labels model.

func (ProjectVersionDescription) GoString added in v1.25.47 

func (s ProjectVersionDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProjectVersionDescription) SetBillableTrainingTimeInSeconds added in v1.25.47 

func (s *ProjectVersionDescription) SetBillableTrainingTimeInSeconds(v int64) *ProjectVersionDescription

SetBillableTrainingTimeInSeconds sets the BillableTrainingTimeInSeconds field's value.

func (*ProjectVersionDescription) SetCreationTimestamp added in v1.25.47 

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*ProjectVersionDescription) SetEvaluationResult added in v1.25.47 

func (s *ProjectVersionDescription) SetEvaluationResult(v *EvaluationResult) *ProjectVersionDescription

SetEvaluationResult sets the EvaluationResult field's value.

func (*ProjectVersionDescription) SetKmsKeyId added in v1.38.43 

func (s *ProjectVersionDescription) SetKmsKeyId(v string) *ProjectVersionDescription

SetKmsKeyId sets the KmsKeyId field's value.

func (*ProjectVersionDescription) SetManifestSummary added in v1.35.6 

func (s *ProjectVersionDescription) SetManifestSummary(v *GroundTruthManifest) *ProjectVersionDescription

SetManifestSummary sets the ManifestSummary field's value.

func (*ProjectVersionDescription) SetMinInferenceUnits added in v1.25.47 

func (s *ProjectVersionDescription) SetMinInferenceUnits(v int64) *ProjectVersionDescription

SetMinInferenceUnits sets the MinInferenceUnits field's value.

func (*ProjectVersionDescription) SetOutputConfig added in v1.25.47 

func (s *ProjectVersionDescription) SetOutputConfig(v *OutputConfig) *ProjectVersionDescription

SetOutputConfig sets the OutputConfig field's value.

func (*ProjectVersionDescription) SetProjectVersionArn added in v1.25.47 

func (s *ProjectVersionDescription) SetProjectVersionArn(v string) *ProjectVersionDescription

SetProjectVersionArn sets the ProjectVersionArn field's value.

func (*ProjectVersionDescription) SetStatus added in v1.25.47 

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

SetStatus sets the Status field's value.

func (*ProjectVersionDescription) SetStatusMessage added in v1.25.47 

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

SetStatusMessage sets the StatusMessage field's value.

func (*ProjectVersionDescription) SetTestingDataResult added in v1.25.47 

func (s *ProjectVersionDescription) SetTestingDataResult(v *TestingDataResult) *ProjectVersionDescription

SetTestingDataResult sets the TestingDataResult field's value.

func (*ProjectVersionDescription) SetTrainingDataResult added in v1.25.47 

func (s *ProjectVersionDescription) SetTrainingDataResult(v *TrainingDataResult) *ProjectVersionDescription

SetTrainingDataResult sets the TrainingDataResult field's value.

func (*ProjectVersionDescription) SetTrainingEndTimestamp added in v1.25.47 

func (s *ProjectVersionDescription) SetTrainingEndTimestamp(v time.Time) *ProjectVersionDescription

SetTrainingEndTimestamp sets the TrainingEndTimestamp field's value.

func (ProjectVersionDescription) String added in v1.25.47 

func (s ProjectVersionDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProtectiveEquipmentBodyPart added in v1.35.8 

type ProtectiveEquipmentBodyPart struct {

	// The confidence that Amazon Rekognition has in the detection accuracy of the
	// detected body part.
	Confidence *float64 `type:"float"`

	// An array of Personal Protective Equipment items detected around a body part.
	EquipmentDetections []*EquipmentDetection `type:"list"`

	// The detected body part.
	Name *string `type:"string" enum:"BodyPart"`
	// contains filtered or unexported fields
}

Information about a body part detected by DetectProtectiveEquipment that contains PPE. An array of ProtectiveEquipmentBodyPart objects is returned for each person detected by DetectProtectiveEquipment.

func (ProtectiveEquipmentBodyPart) GoString added in v1.35.8 

func (s ProtectiveEquipmentBodyPart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectiveEquipmentBodyPart) SetConfidence added in v1.35.8 

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

SetConfidence sets the Confidence field's value.

func (*ProtectiveEquipmentBodyPart) SetEquipmentDetections added in v1.35.8 

func (s *ProtectiveEquipmentBodyPart) SetEquipmentDetections(v []*EquipmentDetection) *ProtectiveEquipmentBodyPart

SetEquipmentDetections sets the EquipmentDetections field's value.

func (*ProtectiveEquipmentBodyPart) SetName added in v1.35.8 

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

SetName sets the Name field's value.

func (ProtectiveEquipmentBodyPart) String added in v1.35.8 

func (s ProtectiveEquipmentBodyPart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProtectiveEquipmentPerson added in v1.35.8 

type ProtectiveEquipmentPerson struct {

	// An array of body parts detected on a person's body (including body parts
	// without PPE).
	BodyParts []*ProtectiveEquipmentBodyPart `type:"list"`

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

	// The confidence that Amazon Rekognition has that the bounding box contains
	// a person.
	Confidence *float64 `type:"float"`

	// The identifier for the detected person. The identifier is only unique for
	// a single call to DetectProtectiveEquipment.
	Id *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A person detected by a call to DetectProtectiveEquipment. The API returns all persons detected in the input image in an array of ProtectiveEquipmentPerson objects.

func (ProtectiveEquipmentPerson) GoString added in v1.35.8 

func (s ProtectiveEquipmentPerson) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectiveEquipmentPerson) SetBodyParts added in v1.35.8 

func (s *ProtectiveEquipmentPerson) SetBodyParts(v []*ProtectiveEquipmentBodyPart) *ProtectiveEquipmentPerson

SetBodyParts sets the BodyParts field's value.

func (*ProtectiveEquipmentPerson) SetBoundingBox added in v1.35.8 

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

SetBoundingBox sets the BoundingBox field's value.

func (*ProtectiveEquipmentPerson) SetConfidence added in v1.35.8 

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

SetConfidence sets the Confidence field's value.

func (*ProtectiveEquipmentPerson) SetId added in v1.35.8 

func (s *ProtectiveEquipmentPerson) SetId(v int64) *ProtectiveEquipmentPerson

SetId sets the Id field's value.

func (ProtectiveEquipmentPerson) String added in v1.35.8 

func (s ProtectiveEquipmentPerson) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProtectiveEquipmentSummarizationAttributes added in v1.35.8 

type ProtectiveEquipmentSummarizationAttributes struct {

	// The minimum confidence level for which you want summary information. The
	// confidence level applies to person detection, body part detection, equipment
	// detection, and body part coverage. Amazon Rekognition doesn't return summary
	// information with a confidence than this specified value. There isn't a default
	// value.
	//
	// Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment
	// returns predictions only where the detection confidence is between 50% -
	// 100%. If you specify a value that is less than 50%, the results are the same
	// specifying a value of 50%.
	//
	// MinConfidence is a required field
	MinConfidence *float64 `type:"float" required:"true"`

	// An array of personal protective equipment types for which you want summary
	// information. If a person is detected wearing a required requipment type,
	// the person's ID is added to the PersonsWithRequiredEquipment array field
	// returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.
	//
	// RequiredEquipmentTypes is a required field
	RequiredEquipmentTypes []*string `type:"list" required:"true" enum:"ProtectiveEquipmentType"`
	// contains filtered or unexported fields
}

Specifies summary attributes to return from a call to DetectProtectiveEquipment. You can specify which types of PPE to summarize. You can also specify a minimum confidence value for detections. Summary information is returned in the Summary (ProtectiveEquipmentSummary) field of the response from DetectProtectiveEquipment. The summary includes which persons in an image were detected wearing the requested types of person protective equipment (PPE), which persons were detected as not wearing PPE, and the persons in which a determination could not be made. For more information, see ProtectiveEquipmentSummary.

func (ProtectiveEquipmentSummarizationAttributes) GoString added in v1.35.8 

func (s ProtectiveEquipmentSummarizationAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectiveEquipmentSummarizationAttributes) SetMinConfidence added in v1.35.8 

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

SetMinConfidence sets the MinConfidence field's value.

func (*ProtectiveEquipmentSummarizationAttributes) SetRequiredEquipmentTypes added in v1.35.8 

func (s *ProtectiveEquipmentSummarizationAttributes) SetRequiredEquipmentTypes(v []*string) *ProtectiveEquipmentSummarizationAttributes

SetRequiredEquipmentTypes sets the RequiredEquipmentTypes field's value.

func (ProtectiveEquipmentSummarizationAttributes) String added in v1.35.8 

func (s ProtectiveEquipmentSummarizationAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectiveEquipmentSummarizationAttributes) Validate added in v1.35.8 

func (s *ProtectiveEquipmentSummarizationAttributes) Validate() error

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

type ProtectiveEquipmentSummary added in v1.35.8 

type ProtectiveEquipmentSummary struct {

	// An array of IDs for persons where it was not possible to determine if they
	// are wearing personal protective equipment.
	PersonsIndeterminate []*int64 `type:"list"`

	// An array of IDs for persons who are wearing detected personal protective
	// equipment.
	PersonsWithRequiredEquipment []*int64 `type:"list"`

	// An array of IDs for persons who are not wearing all of the types of PPE specified
	// in the RequiredEquipmentTypes field of the detected personal protective equipment.
	PersonsWithoutRequiredEquipment []*int64 `type:"list"`
	// contains filtered or unexported fields
}

Summary information for required items of personal protective equipment (PPE) detected on persons by a call to DetectProtectiveEquipment. You specify the required type of PPE in the SummarizationAttributes (ProtectiveEquipmentSummarizationAttributes) input parameter. The summary includes which persons were detected wearing the required personal protective equipment (PersonsWithRequiredEquipment), which persons were detected as not wearing the required PPE (PersonsWithoutRequiredEquipment), and the persons in which a determination could not be made (PersonsIndeterminate).

To get a total for each category, use the size of the field array. For example, to find out how many people were detected as wearing the specified PPE, use the size of the PersonsWithRequiredEquipment array. If you want to find out more about a person, such as the location (BoundingBox) of the person on the image, use the person ID in each array element. Each person ID matches the ID field of a ProtectiveEquipmentPerson object returned in the Persons array by DetectProtectiveEquipment.

func (ProtectiveEquipmentSummary) GoString added in v1.35.8 

func (s ProtectiveEquipmentSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectiveEquipmentSummary) SetPersonsIndeterminate added in v1.35.8 

func (s *ProtectiveEquipmentSummary) SetPersonsIndeterminate(v []*int64) *ProtectiveEquipmentSummary

SetPersonsIndeterminate sets the PersonsIndeterminate field's value.

func (*ProtectiveEquipmentSummary) SetPersonsWithRequiredEquipment added in v1.35.8 

func (s *ProtectiveEquipmentSummary) SetPersonsWithRequiredEquipment(v []*int64) *ProtectiveEquipmentSummary

SetPersonsWithRequiredEquipment sets the PersonsWithRequiredEquipment field's value.

func (*ProtectiveEquipmentSummary) SetPersonsWithoutRequiredEquipment added in v1.35.8 

func (s *ProtectiveEquipmentSummary) SetPersonsWithoutRequiredEquipment(v []*int64) *ProtectiveEquipmentSummary

SetPersonsWithoutRequiredEquipment sets the PersonsWithoutRequiredEquipment field's value.

func (ProtectiveEquipmentSummary) String added in v1.35.8 

func (s ProtectiveEquipmentSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProvisionedThroughputExceededException added in v1.28.0 

type ProvisionedThroughputExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ProvisionedThroughputExceededException) Code added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Code() string

Code returns the exception type name.

func (*ProvisionedThroughputExceededException) Error added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Error() string

func (ProvisionedThroughputExceededException) GoString added in v1.28.0 

func (s ProvisionedThroughputExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisionedThroughputExceededException) Message added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Message() string

Message returns the exception's message.

func (*ProvisionedThroughputExceededException) OrigErr added in v1.28.0 

func (s *ProvisionedThroughputExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ProvisionedThroughputExceededException) RequestID added in v1.28.0 

func (s *ProvisionedThroughputExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ProvisionedThroughputExceededException) StatusCode added in v1.28.0 

func (s *ProvisionedThroughputExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ProvisionedThroughputExceededException) String added in v1.28.0 

func (s ProvisionedThroughputExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 64 celebrities in an image. Each celebrity object includes the
	// following attributes: Face, Confidence, Emotions, Landmarks, Pose, Quality,
	// Smile, Id, KnownGender, MatchConfidence, Name, Urls.
	CelebrityFaces []*Celebrity `type:"list"`

	//
	// Support for estimating image orientation using the the OrientationCorrection
	// field has ceased as of August 2021. Any returned values for this field included
	// in an API response will always be NULL.
	//
	// 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. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegionOfInterest added in v1.29.4 

type RegionOfInterest struct {

	// The box representing a region of interest on screen.
	BoundingBox *BoundingBox `type:"structure"`
	// contains filtered or unexported fields
}

Specifies a location within the frame that Rekognition checks for text. Uses a BoundingBox object to set a region of the screen.

A word is included in the region if the word is more than half in that region. If there is more than one region, the word will be compared with all regions of the screen. Any word more than half in a region is kept in the results.

func (RegionOfInterest) GoString added in v1.29.4 

func (s RegionOfInterest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegionOfInterest) SetBoundingBox added in v1.29.4 

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

SetBoundingBox sets the BoundingBox field's value.

func (RegionOfInterest) String added in v1.29.4 

func (s RegionOfInterest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: 

mySession := session.Must(session.NewSession())

// 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.

CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action.

You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG 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, roll, 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.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

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 Comparing Faces in Images in the Amazon Rekognition Developer Guide.

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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • 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 successfully.

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 IndexFaces 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.

When you create a collection, it is associated with the latest version of the face model version.

Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource 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 CreateCollection for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceAlreadyExistsException A resource with the specified ID already exists.

  • ServiceQuotaExceededException The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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())
			case rekognition.ErrCodeServiceQuotaExceededException:
				fmt.Println(rekognition.ErrCodeServiceQuotaExceededException, 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 successfully.

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) CreateDataset added in v1.41.15 

func (c *Rekognition) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error)

CreateDataset API operation for Amazon Rekognition.

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

To create a training dataset for a project, specify train for the value of DatasetType. To create the test dataset for a project, specify test for the value of DatasetType.

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.

To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information.

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries 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 CreateDataset for usage and error information.

Returned Error Types:

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

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

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

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

  • AccessDeniedException You are not authorized to perform the action.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

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

  • ResourceAlreadyExistsException A resource with the specified ID already exists.

  • ResourceNotFoundException The resource specified in the request cannot be found.

func (*Rekognition) CreateDatasetRequest added in v1.41.15 

func (c *Rekognition) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput)

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

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 CreateDataset for more information on using the CreateDataset 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 CreateDatasetRequest method.
req, resp := client.CreateDatasetRequest(params)

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

func (*Rekognition) CreateDatasetWithContext added in v1.41.15 

func (c *Rekognition) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error)

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

See CreateDataset 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) CreateProject added in v1.25.47 

func (c *Rekognition) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error)

CreateProject API operation for Amazon Rekognition.

Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) that you use to create and manage Amazon Rekognition Custom Labels models.

This operation requires permissions to perform the rekognition:CreateProject 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 CreateProject for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is already being used.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) CreateProjectRequest added in v1.25.47 

func (c *Rekognition) CreateProjectRequest(input *CreateProjectInput) (req *request.Request, output *CreateProjectOutput)

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

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 CreateProject for more information on using the CreateProject 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 CreateProjectRequest method.
req, resp := client.CreateProjectRequest(params)

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

func (*Rekognition) CreateProjectVersion added in v1.25.47 

func (c *Rekognition) CreateProjectVersion(input *CreateProjectVersionInput) (*CreateProjectVersionOutput, error)

CreateProjectVersion API operation for Amazon Rekognition.

Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

Training uses the training and test datasets associated with the project. For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.

You can train a modelin a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED.

If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels developers guide.

After evaluating the model, you start the model by calling StartProjectVersion.

This operation requires permissions to perform the rekognition:CreateProjectVersion 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 CreateProjectVersion for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is already being used.

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ServiceQuotaExceededException The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

func (*Rekognition) CreateProjectVersionRequest added in v1.25.47 

func (c *Rekognition) CreateProjectVersionRequest(input *CreateProjectVersionInput) (req *request.Request, output *CreateProjectVersionOutput)

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

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 CreateProjectVersion for more information on using the CreateProjectVersion 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 CreateProjectVersionRequest method.
req, resp := client.CreateProjectVersionRequest(params)

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

func (*Rekognition) CreateProjectVersionWithContext added in v1.25.47 

func (c *Rekognition) CreateProjectVersionWithContext(ctx aws.Context, input *CreateProjectVersionInput, opts ...request.Option) (*CreateProjectVersionOutput, error)

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

See CreateProjectVersion 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) CreateProjectWithContext added in v1.25.47 

func (c *Rekognition) CreateProjectWithContext(ctx aws.Context, input *CreateProjectInput, opts ...request.Option) (*CreateProjectOutput, error)

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

See CreateProject 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.

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon 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 StartStreamProcessor with the Name field.

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

This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource 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 CreateStreamProcessor for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • ResourceInUseException The specified resource is already being used.

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

  • ServiceQuotaExceededException The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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 successfully.

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 Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource 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 successfully.

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) DeleteDataset added in v1.41.15 

func (c *Rekognition) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error)

DeleteDataset API operation for Amazon Rekognition.

Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

This operation requires permissions to perform the rekognition:DeleteDataset 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 DeleteDataset for usage and error information.

Returned Error Types:

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

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

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

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

  • AccessDeniedException You are not authorized to perform the action.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • ResourceInUseException The specified resource is already being used.

  • ResourceNotFoundException The resource specified in the request cannot be found.

func (*Rekognition) DeleteDatasetRequest added in v1.41.15 

func (c *Rekognition) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput)

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

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 DeleteDataset for more information on using the DeleteDataset 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 DeleteDatasetRequest method.
req, resp := client.DeleteDatasetRequest(params)

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

func (*Rekognition) DeleteDatasetWithContext added in v1.41.15 

func (c *Rekognition) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error)

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

See DeleteDataset 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 Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource 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 successfully.

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) DeleteProject added in v1.30.1 

func (c *Rekognition) DeleteProject(input *DeleteProjectInput) (*DeleteProjectOutput, error)

DeleteProject API operation for Amazon Rekognition.

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.

DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response.

This operation requires permissions to perform the rekognition:DeleteProject 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 DeleteProject for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is already being used.

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) DeleteProjectRequest added in v1.30.1 

func (c *Rekognition) DeleteProjectRequest(input *DeleteProjectInput) (req *request.Request, output *DeleteProjectOutput)

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

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 DeleteProject for more information on using the DeleteProject 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 DeleteProjectRequest method.
req, resp := client.DeleteProjectRequest(params)

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

func (*Rekognition) DeleteProjectVersion added in v1.30.1 

func (c *Rekognition) DeleteProjectVersion(input *DeleteProjectVersionInput) (*DeleteProjectVersionOutput, error)

DeleteProjectVersion API operation for Amazon Rekognition.

Deletes an Amazon Rekognition Custom Labels model.

You can't delete a model if it is running or if it is training. To check the status of a model, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. If the model is training, wait until it finishes.

This operation requires permissions to perform the rekognition:DeleteProjectVersion 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 DeleteProjectVersion for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceInUseException The specified resource is already being used.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) DeleteProjectVersionRequest added in v1.30.1 

func (c *Rekognition) DeleteProjectVersionRequest(input *DeleteProjectVersionInput) (req *request.Request, output *DeleteProjectVersionOutput)

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

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 DeleteProjectVersion for more information on using the DeleteProjectVersion 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 DeleteProjectVersionRequest method.
req, resp := client.DeleteProjectVersionRequest(params)

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

func (*Rekognition) DeleteProjectVersionWithContext added in v1.30.1 

func (c *Rekognition) DeleteProjectVersionWithContext(ctx aws.Context, input *DeleteProjectVersionInput, opts ...request.Option) (*DeleteProjectVersionOutput, error)

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

See DeleteProjectVersion 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) DeleteProjectWithContext added in v1.30.1 

func (c *Rekognition) DeleteProjectWithContext(ctx aws.Context, input *DeleteProjectInput, opts ...request.Option) (*DeleteProjectOutput, error)

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

See DeleteProject 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 CreateStreamProcessor. 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceInUseException The specified resource is already being used.

  • 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 successfully.

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) DescribeCollection added in v1.15.19 

func (c *Rekognition) DescribeCollection(input *DescribeCollectionInput) (*DescribeCollectionOutput, error)

DescribeCollection API operation for Amazon Rekognition.

Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

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 DescribeCollection for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

func (*Rekognition) DescribeCollectionRequest added in v1.15.19 

func (c *Rekognition) DescribeCollectionRequest(input *DescribeCollectionInput) (req *request.Request, output *DescribeCollectionOutput)

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

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 DescribeCollection for more information on using the DescribeCollection 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 DescribeCollectionRequest method.
req, resp := client.DescribeCollectionRequest(params)

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

func (*Rekognition) DescribeCollectionWithContext added in v1.15.19 

func (c *Rekognition) DescribeCollectionWithContext(ctx aws.Context, input *DescribeCollectionInput, opts ...request.Option) (*DescribeCollectionOutput, error)

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

See DescribeCollection 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) DescribeDataset added in v1.41.15 

func (c *Rekognition) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)

DescribeDataset API operation for Amazon Rekognition.

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

This operation requires permissions to perform the rekognition:DescribeDataset 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 DescribeDataset for usage and error information.

Returned Error Types:

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

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

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

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

  • AccessDeniedException You are not authorized to perform the action.

  • ResourceNotFoundException The resource specified in the request cannot be found.

func (*Rekognition) DescribeDatasetRequest added in v1.41.15 

func (c *Rekognition) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)

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

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 DescribeDataset for more information on using the DescribeDataset 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 DescribeDatasetRequest method.
req, resp := client.DescribeDatasetRequest(params)

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

func (*Rekognition) DescribeDatasetWithContext added in v1.41.15 

func (c *Rekognition) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error)

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

See DescribeDataset 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) DescribeProjectVersions added in v1.25.47 

func (c *Rekognition) DescribeProjectVersions(input *DescribeProjectVersionsInput) (*DescribeProjectVersionsOutput, error)

DescribeProjectVersions API operation for Amazon Rekognition.

Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model versions in the project are returned.

This operation requires permissions to perform the rekognition:DescribeProjectVersions 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 DescribeProjectVersions for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) DescribeProjectVersionsPages added in v1.25.47 

func (c *Rekognition) DescribeProjectVersionsPages(input *DescribeProjectVersionsInput, fn func(*DescribeProjectVersionsOutput, bool) bool) error

DescribeProjectVersionsPages iterates over the pages of a DescribeProjectVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeProjectVersions 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 DescribeProjectVersions operation.
pageNum := 0
err := client.DescribeProjectVersionsPages(params,
    func(page *rekognition.DescribeProjectVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) DescribeProjectVersionsPagesWithContext added in v1.25.47 

func (c *Rekognition) DescribeProjectVersionsPagesWithContext(ctx aws.Context, input *DescribeProjectVersionsInput, fn func(*DescribeProjectVersionsOutput, bool) bool, opts ...request.Option) error

DescribeProjectVersionsPagesWithContext same as DescribeProjectVersionsPages 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) DescribeProjectVersionsRequest added in v1.25.47 

func (c *Rekognition) DescribeProjectVersionsRequest(input *DescribeProjectVersionsInput) (req *request.Request, output *DescribeProjectVersionsOutput)

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

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 DescribeProjectVersions for more information on using the DescribeProjectVersions 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 DescribeProjectVersionsRequest method.
req, resp := client.DescribeProjectVersionsRequest(params)

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

func (*Rekognition) DescribeProjectVersionsWithContext added in v1.25.47 

func (c *Rekognition) DescribeProjectVersionsWithContext(ctx aws.Context, input *DescribeProjectVersionsInput, opts ...request.Option) (*DescribeProjectVersionsOutput, error)

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

See DescribeProjectVersions 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) DescribeProjects added in v1.25.47 

func (c *Rekognition) DescribeProjects(input *DescribeProjectsInput) (*DescribeProjectsOutput, error)

DescribeProjects API operation for Amazon Rekognition.

Gets information about your Amazon Rekognition Custom Labels projects.

This operation requires permissions to perform the rekognition:DescribeProjects 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 DescribeProjects for usage and error information.

Returned Error Types:

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) DescribeProjectsPages added in v1.25.47 

func (c *Rekognition) DescribeProjectsPages(input *DescribeProjectsInput, fn func(*DescribeProjectsOutput, bool) bool) error

DescribeProjectsPages iterates over the pages of a DescribeProjects operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeProjects 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 DescribeProjects operation.
pageNum := 0
err := client.DescribeProjectsPages(params,
    func(page *rekognition.DescribeProjectsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) DescribeProjectsPagesWithContext added in v1.25.47 

func (c *Rekognition) DescribeProjectsPagesWithContext(ctx aws.Context, input *DescribeProjectsInput, fn func(*DescribeProjectsOutput, bool) bool, opts ...request.Option) error

DescribeProjectsPagesWithContext same as DescribeProjectsPages 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) DescribeProjectsRequest added in v1.25.47 

func (c *Rekognition) DescribeProjectsRequest(input *DescribeProjectsInput) (req *request.Request, output *DescribeProjectsOutput)

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

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 DescribeProjects for more information on using the DescribeProjects 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 DescribeProjectsRequest method.
req, resp := client.DescribeProjectsRequest(params)

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

func (*Rekognition) DescribeProjectsWithContext added in v1.25.47 

func (c *Rekognition) DescribeProjectsWithContext(ctx aws.Context, input *DescribeProjectsInput, opts ...request.Option) (*DescribeProjectsOutput, error)

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

See DescribeProjects 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 CreateStreamProcessor. 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 successfully.

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) DetectCustomLabels added in v1.25.47 

func (c *Rekognition) DetectCustomLabels(input *DetectCustomLabelsInput) (*DetectCustomLabelsOutput, error)

DetectCustomLabels API operation for Amazon Rekognition.

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

You specify which version of a model version to use by using the ProjectVersionArn input parameter.

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 AWS 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 that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry).

To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

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

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

For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

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 DetectCustomLabels for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceNotReadyException The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • InvalidImageFormatException The provided image format is not supported.

func (*Rekognition) DetectCustomLabelsRequest added in v1.25.47 

func (c *Rekognition) DetectCustomLabelsRequest(input *DetectCustomLabelsInput) (req *request.Request, output *DetectCustomLabelsOutput)

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

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 DetectCustomLabels for more information on using the DetectCustomLabels 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 DetectCustomLabelsRequest method.
req, resp := client.DetectCustomLabelsRequest(params)

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

func (*Rekognition) DetectCustomLabelsWithContext added in v1.25.47 

func (c *Rekognition) DetectCustomLabelsWithContext(ctx aws.Context, input *DetectCustomLabelsInput, opts ...request.Option) (*DetectCustomLabelsOutput, error)

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

See DetectCustomLabels 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. These details include 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), presence of beard, sunglasses, and so on.

The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might 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 AWS 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.

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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • 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 successfully.

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 Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

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 AWS 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 includes 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 55%. 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.

DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • 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 successfully.

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 unsafe 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 Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

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 AWS 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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • InvalidImageFormatException The provided image format is not supported.

  • HumanLoopQuotaExceededException The number of in-progress human reviews you have has exceeded the number allowed.

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 successfully.

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) DetectProtectiveEquipment added in v1.35.8 

func (c *Rekognition) DetectProtectiveEquipment(input *DetectProtectiveEquipmentInput) (*DetectProtectiveEquipmentOutput, error)

DetectProtectiveEquipment API operation for Amazon Rekognition.

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.

  • Face cover

  • Hand cover

  • Head cover

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.

DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.

  • The persons detected as wearing all of the types of PPE that you specify.

  • The persons detected as not wearing all of the types PPE that you specify.

  • The persons detected where PPE adornment could not be determined.

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

This operation requires permissions to perform the rekognition:DetectProtectiveEquipment 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 DetectProtectiveEquipment for usage and error information.

Returned Error Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • InvalidImageFormatException The provided image format is not supported.

func (*Rekognition) DetectProtectiveEquipmentRequest added in v1.35.8 

func (c *Rekognition) DetectProtectiveEquipmentRequest(input *DetectProtectiveEquipmentInput) (req *request.Request, output *DetectProtectiveEquipmentOutput)

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

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 DetectProtectiveEquipment for more information on using the DetectProtectiveEquipment 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 DetectProtectiveEquipmentRequest method.
req, resp := client.DetectProtectiveEquipmentRequest(params)

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

func (*Rekognition) DetectProtectiveEquipmentWithContext added in v1.35.8 

func (c *Rekognition) DetectProtectiveEquipmentWithContext(ctx aws.Context, input *DetectProtectiveEquipmentInput, opts ...request.Option) (*DetectProtectiveEquipmentOutput, error)

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

See DetectProtectiveEquipment 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 TextDetection 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 script characters that are not separated by spaces. DetectText can detect up to 100 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 +/- 90 degrees orientation of the horizontal axis.

For more information, see DetectText in the Amazon Rekognition Developer Guide.

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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • 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 successfully.

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) DistributeDatasetEntries added in v1.41.15 

func (c *Rekognition) DistributeDatasetEntries(input *DistributeDatasetEntriesInput) (*DistributeDatasetEntriesOutput, error)

DistributeDatasetEntries API operation for Amazon Rekognition.

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image.

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.

This operation requires permissions to perform the rekognition:DistributeDatasetEntries 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 DistributeDatasetEntries for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotReadyException The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

func (*Rekognition) DistributeDatasetEntriesRequest added in v1.41.15 

func (c *Rekognition) DistributeDatasetEntriesRequest(input *DistributeDatasetEntriesInput) (req *request.Request, output *DistributeDatasetEntriesOutput)

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

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 DistributeDatasetEntries for more information on using the DistributeDatasetEntries 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 DistributeDatasetEntriesRequest method.
req, resp := client.DistributeDatasetEntriesRequest(params)

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

func (*Rekognition) DistributeDatasetEntriesWithContext added in v1.41.15 

func (c *Rekognition) DistributeDatasetEntriesWithContext(ctx aws.Context, input *DistributeDatasetEntriesInput, opts ...request.Option) (*DistributeDatasetEntriesOutput, error)

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

See DistributeDatasetEntries 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 their Amazon 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 Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

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 Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource 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 successfully.

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 Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

When the celebrity recognition operation finishes, Amazon 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 Working With Stored Videos in the Amazon Rekognition Developer Guide.

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The BoundingBox field only applies to the detected face instance. The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

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 GetCelebrityInfo 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 *rekognition.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 successfully.

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 inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs (https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api).

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon 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 analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection 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 Content moderation in the Amazon Rekognition Developer Guide.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 *rekognition.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 successfully.

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 Amazon Rekognition Video analysis started by StartFaceDetection.

Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon 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 GetFaceDetection 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 *rekognition.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 successfully.

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 Amazon Rekognition Video face search started by StartFaceSearch. 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 StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon 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 Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch 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 FaceDetail in the Amazon Rekognition Developer Guide.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 *rekognition.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 successfully.

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 Amazon Rekognition Video analysis started by StartLabelDetection.

The label detection operation is started by a call to StartLabelDetection 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 GetLabelDetection 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.

The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 *rekognition.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 successfully.

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 path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon 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 path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths 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 FaceDetail in the Amazon Rekognition Developer Guide.

By default, the array is sorted by the time(s) a person's path 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 *rekognition.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 successfully.

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) GetSegmentDetection added in v1.32.7 

func (c *Rekognition) GetSegmentDetection(input *GetSegmentDetectionInput) (*GetSegmentDetectionOutput, error)

GetSegmentDetection API operation for Amazon Rekognition.

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.

GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

Use the MaxResults parameter to limit the number of segment detections 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 GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

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 GetSegmentDetection for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

func (*Rekognition) GetSegmentDetectionPages added in v1.32.7 

func (c *Rekognition) GetSegmentDetectionPages(input *GetSegmentDetectionInput, fn func(*GetSegmentDetectionOutput, bool) bool) error

GetSegmentDetectionPages iterates over the pages of a GetSegmentDetection operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetSegmentDetection 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 GetSegmentDetection operation.
pageNum := 0
err := client.GetSegmentDetectionPages(params,
    func(page *rekognition.GetSegmentDetectionOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetSegmentDetectionPagesWithContext added in v1.32.7 

func (c *Rekognition) GetSegmentDetectionPagesWithContext(ctx aws.Context, input *GetSegmentDetectionInput, fn func(*GetSegmentDetectionOutput, bool) bool, opts ...request.Option) error

GetSegmentDetectionPagesWithContext same as GetSegmentDetectionPages 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) GetSegmentDetectionRequest added in v1.32.7 

func (c *Rekognition) GetSegmentDetectionRequest(input *GetSegmentDetectionInput) (req *request.Request, output *GetSegmentDetectionOutput)

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

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 GetSegmentDetection for more information on using the GetSegmentDetection 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 GetSegmentDetectionRequest method.
req, resp := client.GetSegmentDetectionRequest(params)

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

func (*Rekognition) GetSegmentDetectionWithContext added in v1.32.7 

func (c *Rekognition) GetSegmentDetectionWithContext(ctx aws.Context, input *GetSegmentDetectionInput, opts ...request.Option) (*GetSegmentDetectionOutput, error)

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

See GetSegmentDetection 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) GetTextDetection added in v1.29.4 

func (c *Rekognition) GetTextDetection(input *GetTextDetectionInput) (*GetTextDetectionOutput, error)

GetTextDetection API operation for Amazon Rekognition.

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.

GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.

Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.

Use MaxResults parameter to limit the number of text detections 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 GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.

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 GetTextDetection for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

func (*Rekognition) GetTextDetectionPages added in v1.29.4 

func (c *Rekognition) GetTextDetectionPages(input *GetTextDetectionInput, fn func(*GetTextDetectionOutput, bool) bool) error

GetTextDetectionPages iterates over the pages of a GetTextDetection operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetTextDetection 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 GetTextDetection operation.
pageNum := 0
err := client.GetTextDetectionPages(params,
    func(page *rekognition.GetTextDetectionOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) GetTextDetectionPagesWithContext added in v1.29.4 

func (c *Rekognition) GetTextDetectionPagesWithContext(ctx aws.Context, input *GetTextDetectionInput, fn func(*GetTextDetectionOutput, bool) bool, opts ...request.Option) error

GetTextDetectionPagesWithContext same as GetTextDetectionPages 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) GetTextDetectionRequest added in v1.29.4 

func (c *Rekognition) GetTextDetectionRequest(input *GetTextDetectionInput) (req *request.Request, output *GetTextDetectionOutput)

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

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 GetTextDetection for more information on using the GetTextDetection 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 GetTextDetectionRequest method.
req, resp := client.GetTextDetectionRequest(params)

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

func (*Rekognition) GetTextDetectionWithContext added in v1.29.4 

func (c *Rekognition) GetTextDetectionWithContext(ctx aws.Context, input *GetTextDetectionInput, opts ...request.Option) (*GetTextDetectionOutput, error)

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

See GetTextDetection 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 doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.

For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.

To get the number of faces in a collection, call DescribeCollection.

If you're 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.

If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

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 ListFaces 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.

You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:

  • The number of faces detected exceeds the value of the MaxFaces request parameter.

  • The face is too small compared to the image dimensions.

  • The face is too blurry.

  • The image is too dark.

  • The face has an extreme pose.

  • The face doesn’t have enough detail to be suitable for face search.

In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

  • The bounding box, BoundingBox, of the detected face.

  • A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.

  • A face ID, FaceId, assigned by the service for each face that's detected and stored.

  • An image ID, ImageId, assigned by the service for the input image.

If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, use the same external ID, and use the same model version 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 AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG 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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • InvalidImageFormatException The provided image format is not supported.

  • ServiceQuotaExceededException The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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())
			case rekognition.ErrCodeServiceQuotaExceededException:
				fmt.Println(rekognition.ErrCodeServiceQuotaExceededException, 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 successfully.

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 Listing Collections in the Amazon Rekognition Developer Guide.

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 Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

  • ResourceNotFoundException The resource 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 *rekognition.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 successfully.

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) ListDatasetEntries added in v1.41.15 

func (c *Rekognition) ListDatasetEntries(input *ListDatasetEntriesInput) (*ListDatasetEntriesOutput, error)

ListDatasetEntries API operation for Amazon Rekognition.

Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html).

JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.

This operation requires permissions to perform the rekognition:ListDatasetEntries 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 ListDatasetEntries for usage and error information.

Returned Error Types:

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

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

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

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

  • AccessDeniedException You are not authorized to perform the action.

  • ResourceInUseException The specified resource is already being used.

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • InvalidPaginationTokenException Pagination token in the request is not valid.

  • ResourceNotReadyException The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

func (*Rekognition) ListDatasetEntriesPages added in v1.41.15 

func (c *Rekognition) ListDatasetEntriesPages(input *ListDatasetEntriesInput, fn func(*ListDatasetEntriesOutput, bool) bool) error

ListDatasetEntriesPages iterates over the pages of a ListDatasetEntries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasetEntries 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 ListDatasetEntries operation.
pageNum := 0
err := client.ListDatasetEntriesPages(params,
    func(page *rekognition.ListDatasetEntriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) ListDatasetEntriesPagesWithContext added in v1.41.15 

func (c *Rekognition) ListDatasetEntriesPagesWithContext(ctx aws.Context, input *ListDatasetEntriesInput, fn func(*ListDatasetEntriesOutput, bool) bool, opts ...request.Option) error

ListDatasetEntriesPagesWithContext same as ListDatasetEntriesPages 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) ListDatasetEntriesRequest added in v1.41.15 

func (c *Rekognition) ListDatasetEntriesRequest(input *ListDatasetEntriesInput) (req *request.Request, output *ListDatasetEntriesOutput)

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

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 ListDatasetEntries for more information on using the ListDatasetEntries 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 ListDatasetEntriesRequest method.
req, resp := client.ListDatasetEntriesRequest(params)

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

func (*Rekognition) ListDatasetEntriesWithContext added in v1.41.15 

func (c *Rekognition) ListDatasetEntriesWithContext(ctx aws.Context, input *ListDatasetEntriesInput, opts ...request.Option) (*ListDatasetEntriesOutput, error)

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

See ListDatasetEntries 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) ListDatasetLabels added in v1.41.15 

func (c *Rekognition) ListDatasetLabels(input *ListDatasetLabelsInput) (*ListDatasetLabelsOutput, error)

ListDatasetLabels API operation for Amazon Rekognition.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html).

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.

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 ListDatasetLabels for usage and error information.

Returned Error Types:

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

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

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

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

  • AccessDeniedException You are not authorized to perform the action.

  • ResourceInUseException The specified resource is already being used.

  • InvalidPaginationTokenException Pagination token in the request is not valid.

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceNotReadyException The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

func (*Rekognition) ListDatasetLabelsPages added in v1.41.15 

func (c *Rekognition) ListDatasetLabelsPages(input *ListDatasetLabelsInput, fn func(*ListDatasetLabelsOutput, bool) bool) error

ListDatasetLabelsPages iterates over the pages of a ListDatasetLabels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasetLabels 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 ListDatasetLabels operation.
pageNum := 0
err := client.ListDatasetLabelsPages(params,
    func(page *rekognition.ListDatasetLabelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Rekognition) ListDatasetLabelsPagesWithContext added in v1.41.15 

func (c *Rekognition) ListDatasetLabelsPagesWithContext(ctx aws.Context, input *ListDatasetLabelsInput, fn func(*ListDatasetLabelsOutput, bool) bool, opts ...request.Option) error

ListDatasetLabelsPagesWithContext same as ListDatasetLabelsPages 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) ListDatasetLabelsRequest added in v1.41.15 

func (c *Rekognition) ListDatasetLabelsRequest(input *ListDatasetLabelsInput) (req *request.Request, output *ListDatasetLabelsOutput)

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

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 ListDatasetLabels for more information on using the ListDatasetLabels 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 ListDatasetLabelsRequest method.
req, resp := client.ListDatasetLabelsRequest(params)

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

func (*Rekognition) ListDatasetLabelsWithContext added in v1.41.15 

func (c *Rekognition) ListDatasetLabelsWithContext(ctx aws.Context, input *ListDatasetLabelsInput, opts ...request.Option) (*ListDatasetLabelsOutput, error)

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

See ListDatasetLabels 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 Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

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 Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

  • ResourceNotFoundException The resource 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 *rekognition.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 successfully.

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 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 ListStreamProcessors for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • InvalidPaginationTokenException Pagination token in the request is not valid.

  • 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 *rekognition.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 successfully.

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) ListTagsForResource added in v1.38.5 

func (c *Rekognition) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Rekognition.

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

This operation requires permissions to perform the rekognition:ListTagsForResource 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 ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) ListTagsForResourceRequest added in v1.38.5 

func (c *Rekognition) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

func (*Rekognition) ListTagsForResourceWithContext added in v1.38.5 

func (c *Rekognition) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 Recognizing Celebrities in the Amazon Rekognition Developer Guide.

RecognizeCelebrities returns the 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image.

For each celebrity recognized, 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.

Amazon Rekognition doesn't 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 GetCelebrityInfo 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 AWS 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 Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

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 Types:

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

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

  • InvalidImageFormatException The provided image format is not supported.

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • 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 successfully.

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 Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

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 Types:

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource 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 IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces 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 AWS 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.

If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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 Types:

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

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

  • ImageTooLargeException The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 successfully.

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 successfully.

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.

Amazon 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, Amazon 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 GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • 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 successfully.

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 inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs (https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api).

Amazon 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 analysis is finished, Amazon 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 analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • 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 successfully.

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.

Amazon 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, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. 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 GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • 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 successfully.

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, Amazon 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 GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

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 Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • 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 successfully.

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.

Amazon 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, Amazon 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 GetLabelDetection 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • 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 successfully.

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 a person's path in a stored video.

Amazon Rekognition Video can track the path of people 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 GetPersonTracking 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • 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 successfully.

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) StartProjectVersion added in v1.25.47 

func (c *Rekognition) StartProjectVersion(input *StartProjectVersionInput) (*StartProjectVersionOutput, error)

StartProjectVersion API operation for Amazon Rekognition.

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

This operation requires permissions to perform the rekognition:StartProjectVersion 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 StartProjectVersion for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceInUseException The specified resource is already being used.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) StartProjectVersionRequest added in v1.25.47 

func (c *Rekognition) StartProjectVersionRequest(input *StartProjectVersionInput) (req *request.Request, output *StartProjectVersionOutput)

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

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 StartProjectVersion for more information on using the StartProjectVersion 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 StartProjectVersionRequest method.
req, resp := client.StartProjectVersionRequest(params)

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

func (*Rekognition) StartProjectVersionWithContext added in v1.25.47 

func (c *Rekognition) StartProjectVersionWithContext(ctx aws.Context, input *StartProjectVersionInput, opts ...request.Option) (*StartProjectVersionOutput, error)

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

See StartProjectVersion 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) StartSegmentDetection added in v1.32.7 

func (c *Rekognition) StartSegmentDetection(input *StartSegmentDetectionInput) (*StartSegmentDetectionOutput, error)

StartSegmentDetection API operation for Amazon Rekognition.

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

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 StartSegmentDetection for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

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

func (*Rekognition) StartSegmentDetectionRequest added in v1.32.7 

func (c *Rekognition) StartSegmentDetectionRequest(input *StartSegmentDetectionInput) (req *request.Request, output *StartSegmentDetectionOutput)

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

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 StartSegmentDetection for more information on using the StartSegmentDetection 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 StartSegmentDetectionRequest method.
req, resp := client.StartSegmentDetectionRequest(params)

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

func (*Rekognition) StartSegmentDetectionWithContext added in v1.32.7 

func (c *Rekognition) StartSegmentDetectionWithContext(ctx aws.Context, input *StartSegmentDetectionInput, opts ...request.Option) (*StartSegmentDetectionOutput, error)

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

See StartSegmentDetection 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 CreateStreamProcessor. 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 Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceInUseException The specified resource is already being used.

  • 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 successfully.

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) StartTextDetection added in v1.29.4 

func (c *Rekognition) StartTextDetection(input *StartTextDetectionInput) (*StartTextDetectionOutput, error)

StartTextDetection API operation for Amazon Rekognition.

Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.

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 StartTextDetection for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

  • 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.

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

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

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

  • VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

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

func (*Rekognition) StartTextDetectionRequest added in v1.29.4 

func (c *Rekognition) StartTextDetectionRequest(input *StartTextDetectionInput) (req *request.Request, output *StartTextDetectionOutput)

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

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 StartTextDetection for more information on using the StartTextDetection 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 StartTextDetectionRequest method.
req, resp := client.StartTextDetectionRequest(params)

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

func (*Rekognition) StartTextDetectionWithContext added in v1.29.4 

func (c *Rekognition) StartTextDetectionWithContext(ctx aws.Context, input *StartTextDetectionInput, opts ...request.Option) (*StartTextDetectionOutput, error)

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

See StartTextDetection 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) StopProjectVersion added in v1.25.47 

func (c *Rekognition) StopProjectVersion(input *StopProjectVersionInput) (*StopProjectVersionOutput, error)

StopProjectVersion API operation for Amazon Rekognition.

Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.

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 StopProjectVersion for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceInUseException The specified resource is already being used.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) StopProjectVersionRequest added in v1.25.47 

func (c *Rekognition) StopProjectVersionRequest(input *StopProjectVersionInput) (req *request.Request, output *StopProjectVersionOutput)

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

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 StopProjectVersion for more information on using the StopProjectVersion 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 StopProjectVersionRequest method.
req, resp := client.StopProjectVersionRequest(params)

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

func (*Rekognition) StopProjectVersionWithContext added in v1.25.47 

func (c *Rekognition) StopProjectVersionWithContext(ctx aws.Context, input *StopProjectVersionInput, opts ...request.Option) (*StopProjectVersionOutput, error)

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

See StopProjectVersion 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 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 StopStreamProcessor for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

  • ResourceNotFoundException The resource specified in the request cannot be found.

  • ResourceInUseException The specified resource is already being used.

  • 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 successfully.

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.

func (*Rekognition) TagResource added in v1.38.5 

func (c *Rekognition) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Rekognition.

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).

This operation requires permissions to perform the rekognition:TagResource 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 TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

  • ServiceQuotaExceededException The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) TagResourceRequest added in v1.38.5 

func (c *Rekognition) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

func (*Rekognition) TagResourceWithContext added in v1.38.5 

func (c *Rekognition) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.38.5 

func (c *Rekognition) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Rekognition.

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

This operation requires permissions to perform the rekognition:UntagResource 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 UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource specified in the request cannot be found.

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

  • AccessDeniedException You are not authorized to perform the action.

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

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

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

func (*Rekognition) UntagResourceRequest added in v1.38.5 

func (c *Rekognition) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

func (*Rekognition) UntagResourceWithContext added in v1.38.5 

func (c *Rekognition) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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) UpdateDatasetEntries added in v1.41.15 

func (c *Rekognition) UpdateDatasetEntries(input *UpdateDatasetEntriesInput) (*UpdateDatasetEntriesOutput, error)

UpdateDatasetEntries API operation for Amazon Rekognition.

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.

UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE.

To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.

This operation requires permissions to perform the rekognition:UpdateDatasetEntries 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 UpdateDatasetEntries for usage and error information.

Returned Error Types:

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

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

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

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

  • AccessDeniedException You are not authorized to perform the action.

  • LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon 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.

  • ResourceInUseException The specified resource is already being used.

  • ResourceNotFoundException The resource specified in the request cannot be found.

func (*Rekognition) UpdateDatasetEntriesRequest added in v1.41.15 

func (c *Rekognition) UpdateDatasetEntriesRequest(input *UpdateDatasetEntriesInput) (req *request.Request, output *UpdateDatasetEntriesOutput)

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

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 UpdateDatasetEntries for more information on using the UpdateDatasetEntries 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 UpdateDatasetEntriesRequest method.
req, resp := client.UpdateDatasetEntriesRequest(params)

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

func (*Rekognition) UpdateDatasetEntriesWithContext added in v1.41.15 

func (c *Rekognition) UpdateDatasetEntriesWithContext(ctx aws.Context, input *UpdateDatasetEntriesInput, opts ...request.Option) (*UpdateDatasetEntriesOutput, error)

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

See UpdateDatasetEntries 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) WaitUntilProjectVersionRunning added in v1.25.47 

func (c *Rekognition) WaitUntilProjectVersionRunning(input *DescribeProjectVersionsInput) error

WaitUntilProjectVersionRunning uses the Amazon Rekognition API operation DescribeProjectVersions to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*Rekognition) WaitUntilProjectVersionRunningWithContext added in v1.25.47 

func (c *Rekognition) WaitUntilProjectVersionRunningWithContext(ctx aws.Context, input *DescribeProjectVersionsInput, opts ...request.WaiterOption) error

WaitUntilProjectVersionRunningWithContext is an extended version of WaitUntilProjectVersionRunning. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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) WaitUntilProjectVersionTrainingCompleted added in v1.25.47 

func (c *Rekognition) WaitUntilProjectVersionTrainingCompleted(input *DescribeProjectVersionsInput) error

WaitUntilProjectVersionTrainingCompleted uses the Amazon Rekognition API operation DescribeProjectVersions to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*Rekognition) WaitUntilProjectVersionTrainingCompletedWithContext added in v1.25.47 

func (c *Rekognition) WaitUntilProjectVersionTrainingCompletedWithContext(ctx aws.Context, input *DescribeProjectVersionsInput, opts ...request.WaiterOption) error

WaitUntilProjectVersionTrainingCompletedWithContext is an extended version of WaitUntilProjectVersionTrainingCompleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 ResourceAlreadyExistsException added in v1.28.0 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A resource with the specified ID already exists.

func (*ResourceAlreadyExistsException) Code added in v1.28.0 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.28.0 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message added in v1.28.0 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.28.0 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is already being used.

func (*ResourceInUseException) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource specified in the request cannot be found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotReadyException added in v1.28.0 

type ResourceNotReadyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

func (*ResourceNotReadyException) Code added in v1.28.0 

func (s *ResourceNotReadyException) Code() string

Code returns the exception type name.

func (*ResourceNotReadyException) Error added in v1.28.0 

func (s *ResourceNotReadyException) Error() string

func (ResourceNotReadyException) GoString added in v1.28.0 

func (s ResourceNotReadyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotReadyException) Message added in v1.28.0 

func (s *ResourceNotReadyException) Message() string

Message returns the exception's message.

func (*ResourceNotReadyException) OrigErr added in v1.28.0 

func (s *ResourceNotReadyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotReadyException) RequestID added in v1.28.0 

func (s *ResourceNotReadyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotReadyException) StatusCode added in v1.28.0 

func (s *ResourceNotReadyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotReadyException) String added in v1.28.0 

func (s ResourceNotReadyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Resource-Based Policies in the Amazon Rekognition Developer Guide.

func (S3Object) GoString 

func (s S3Object) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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%. The default value is 80%.
	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.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// 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"`

	// A filter that specifies a quality bar for how much filtering is done to identify
	// faces. Filtered faces aren't searched for in the collection. If you specify
	// AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM,
	// or HIGH, filtering removes all faces that don’t meet the chosen quality
	// bar. The quality bar is based on a variety of common use cases. Low-quality
	// detections can occur for a number of reasons. Some examples are an object
	// that's misidentified as a face, a face that's too blurry, or a face with
	// a pose that's too extreme to use. If you specify NONE, no filtering is performed.
	// The default value is NONE.
	//
	// To use quality filtering, the collection you are using must be associated
	// with version 3 of the face model or higher.
	QualityFilter *string `type:"string" enum:"QualityFilter"`
	// contains filtered or unexported fields
}

func (SearchFacesByImageInput) GoString 

func (s SearchFacesByImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetQualityFilter added in v1.25.41 

func (s *SearchFacesByImageInput) SetQualityFilter(v string) *SearchFacesByImageInput

SetQualityFilter sets the QualityFilter field's value.

func (SearchFacesByImageInput) String 

func (s SearchFacesByImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Latest face model being used with the collection. For more information, see
	// Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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%. The default value is 80%.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Latest face model being used with the collection. For more information, see
	// Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SegmentDetection added in v1.32.7 

type SegmentDetection struct {

	// The duration of a video segment, expressed in frames.
	DurationFrames *int64 `type:"long"`

	// The duration of the detected segment in milliseconds.
	DurationMillis *int64 `type:"long"`

	// The duration of the timecode for the detected segment in SMPTE format.
	DurationSMPTE *string `type:"string"`

	// The frame number at the end of a video segment, using a frame index that
	// starts with 0.
	EndFrameNumber *int64 `type:"long"`

	// The frame-accurate SMPTE timecode, from the start of a video, for the end
	// of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for
	// drop frame-rates).
	EndTimecodeSMPTE *string `type:"string"`

	// The end time of the detected segment, in milliseconds, from the start of
	// the video. This value is rounded down.
	EndTimestampMillis *int64 `type:"long"`

	// If the segment is a shot detection, contains information about the shot detection.
	ShotSegment *ShotSegment `type:"structure"`

	// The frame number of the start of a video segment, using a frame index that
	// starts with 0.
	StartFrameNumber *int64 `type:"long"`

	// The frame-accurate SMPTE timecode, from the start of a video, for the start
	// of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for
	// drop frame-rates).
	StartTimecodeSMPTE *string `type:"string"`

	// The start time of the detected segment in milliseconds from the start of
	// the video. This value is rounded down. For example, if the actual timestamp
	// is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100
	// millis.
	StartTimestampMillis *int64 `type:"long"`

	// If the segment is a technical cue, contains information about the technical
	// cue.
	TechnicalCueSegment *TechnicalCueSegment `type:"structure"`

	// The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
	Type *string `type:"string" enum:"SegmentType"`
	// contains filtered or unexported fields
}

A technical cue or shot detection segment detected in a video. An array of SegmentDetection objects containing all segments detected in a stored video is returned by GetSegmentDetection.

func (SegmentDetection) GoString added in v1.32.7 

func (s SegmentDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentDetection) SetDurationFrames added in v1.40.18 

func (s *SegmentDetection) SetDurationFrames(v int64) *SegmentDetection

SetDurationFrames sets the DurationFrames field's value.

func (*SegmentDetection) SetDurationMillis added in v1.32.7 

func (s *SegmentDetection) SetDurationMillis(v int64) *SegmentDetection

SetDurationMillis sets the DurationMillis field's value.

func (*SegmentDetection) SetDurationSMPTE added in v1.32.7 

func (s *SegmentDetection) SetDurationSMPTE(v string) *SegmentDetection

SetDurationSMPTE sets the DurationSMPTE field's value.

func (*SegmentDetection) SetEndFrameNumber added in v1.40.18 

func (s *SegmentDetection) SetEndFrameNumber(v int64) *SegmentDetection

SetEndFrameNumber sets the EndFrameNumber field's value.

func (*SegmentDetection) SetEndTimecodeSMPTE added in v1.32.7 

func (s *SegmentDetection) SetEndTimecodeSMPTE(v string) *SegmentDetection

SetEndTimecodeSMPTE sets the EndTimecodeSMPTE field's value.

func (*SegmentDetection) SetEndTimestampMillis added in v1.32.7 

func (s *SegmentDetection) SetEndTimestampMillis(v int64) *SegmentDetection

SetEndTimestampMillis sets the EndTimestampMillis field's value.

func (*SegmentDetection) SetShotSegment added in v1.32.7 

func (s *SegmentDetection) SetShotSegment(v *ShotSegment) *SegmentDetection

SetShotSegment sets the ShotSegment field's value.

func (*SegmentDetection) SetStartFrameNumber added in v1.40.18 

func (s *SegmentDetection) SetStartFrameNumber(v int64) *SegmentDetection

SetStartFrameNumber sets the StartFrameNumber field's value.

func (*SegmentDetection) SetStartTimecodeSMPTE added in v1.32.7 

func (s *SegmentDetection) SetStartTimecodeSMPTE(v string) *SegmentDetection

SetStartTimecodeSMPTE sets the StartTimecodeSMPTE field's value.

func (*SegmentDetection) SetStartTimestampMillis added in v1.32.7 

func (s *SegmentDetection) SetStartTimestampMillis(v int64) *SegmentDetection

SetStartTimestampMillis sets the StartTimestampMillis field's value.

func (*SegmentDetection) SetTechnicalCueSegment added in v1.32.7 

func (s *SegmentDetection) SetTechnicalCueSegment(v *TechnicalCueSegment) *SegmentDetection

SetTechnicalCueSegment sets the TechnicalCueSegment field's value.

func (*SegmentDetection) SetType added in v1.32.7 

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

SetType sets the Type field's value.

func (SegmentDetection) String added in v1.32.7 

func (s SegmentDetection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SegmentTypeInfo added in v1.32.7 

type SegmentTypeInfo struct {

	// The version of the model used to detect segments.
	ModelVersion *string `type:"string"`

	// The type of a segment (technical cue or shot detection).
	Type *string `type:"string" enum:"SegmentType"`
	// contains filtered or unexported fields
}

Information about the type of a segment requested in a call to StartSegmentDetection. An array of SegmentTypeInfo objects is returned by the response from GetSegmentDetection.

func (SegmentTypeInfo) GoString added in v1.32.7 

func (s SegmentTypeInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentTypeInfo) SetModelVersion added in v1.32.7 

func (s *SegmentTypeInfo) SetModelVersion(v string) *SegmentTypeInfo

SetModelVersion sets the ModelVersion field's value.

func (*SegmentTypeInfo) SetType added in v1.32.7 

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

SetType sets the Type field's value.

func (SegmentTypeInfo) String added in v1.32.7 

func (s SegmentTypeInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException added in v1.35.8 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

func (*ServiceQuotaExceededException) Code added in v1.35.8 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.35.8 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.35.8 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message added in v1.35.8 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.35.8 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.35.8 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.35.8 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.35.8 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ShotSegment added in v1.32.7 

type ShotSegment struct {

	// The confidence that Amazon Rekognition Video has in the accuracy of the detected
	// segment.
	Confidence *float64 `min:"50" type:"float"`

	// An Identifier for a shot detection segment detected in a video.
	Index *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a shot detection segment detected in a video. For more information, see SegmentDetection.

func (ShotSegment) GoString added in v1.32.7 

func (s ShotSegment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShotSegment) SetConfidence added in v1.32.7 

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

SetConfidence sets the Confidence field's value.

func (*ShotSegment) SetIndex added in v1.32.7 

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

SetIndex sets the Index field's value.

func (ShotSegment) String added in v1.32.7 

func (s ShotSegment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish
	// the completion status of the celebrity recognition analysis to. The Amazon
	// SNS topic must have a topic name that begins with AmazonRekognition if you
	// are using the AmazonRekognitionServiceRole permissions policy.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	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. If you don't specify MinConfidence, GetContentModeration
	// returns labels with confidence values greater than or equal to 50 percent.
	MinConfidence *float64 `type:"float"`

	// The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish
	// the completion status of the content analysis to. The Amazon SNS topic must
	// have a topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy to access the topic.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect inappropriate, unwanted, or offensive
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video
	// to publish the completion status of the face detection operation. The Amazon
	// SNS topic must have a topic name that begins with AmazonRekognition if you
	// are using the AmazonRekognitionServiceRole permissions policy.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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%. The default
	// value is 80%.
	FaceMatchThreshold *float64 `type:"float"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video
	// to publish the completion status of the search. The Amazon SNS topic must
	// have a topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy to access the topic.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// Specifies the minimum confidence that Amazon 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. Amazon 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 Amazon Rekognition Video to publish the
	// completion status of the label detection operation to. The Amazon SNS topic
	// must have a topic name that begins with AmazonRekognition if you are using
	// the AmazonRekognitionServiceRole permissions policy.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the
	// completion status of the people detection operation to. The Amazon SNS topic
	// must have a topic name that begins with AmazonRekognition if you are using
	// the AmazonRekognitionServiceRole permissions policy.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartProjectVersionInput added in v1.25.47 

type StartProjectVersionInput struct {

	// The minimum number of inference units to use. A single inference unit represents
	// 1 hour of processing and can support up to 5 Transaction Pers Second (TPS).
	// Use a higher number to increase the TPS throughput of your model. You are
	// charged for the number of inference units that you use.
	//
	// MinInferenceUnits is a required field
	MinInferenceUnits *int64 `min:"1" type:"integer" required:"true"`

	// The Amazon Resource Name(ARN) of the model version that you want to start.
	//
	// ProjectVersionArn is a required field
	ProjectVersionArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartProjectVersionInput) GoString added in v1.25.47 

func (s StartProjectVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartProjectVersionInput) SetMinInferenceUnits added in v1.25.47 

func (s *StartProjectVersionInput) SetMinInferenceUnits(v int64) *StartProjectVersionInput

SetMinInferenceUnits sets the MinInferenceUnits field's value.

func (*StartProjectVersionInput) SetProjectVersionArn added in v1.25.47 

func (s *StartProjectVersionInput) SetProjectVersionArn(v string) *StartProjectVersionInput

SetProjectVersionArn sets the ProjectVersionArn field's value.

func (StartProjectVersionInput) String added in v1.25.47 

func (s StartProjectVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartProjectVersionInput) Validate added in v1.25.47 

func (s *StartProjectVersionInput) Validate() error

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

type StartProjectVersionOutput added in v1.25.47 

type StartProjectVersionOutput struct {

	// The current running status of the model.
	Status *string `type:"string" enum:"ProjectVersionStatus"`
	// contains filtered or unexported fields
}

func (StartProjectVersionOutput) GoString added in v1.25.47 

func (s StartProjectVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartProjectVersionOutput) SetStatus added in v1.25.47 

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

SetStatus sets the Status field's value.

func (StartProjectVersionOutput) String added in v1.25.47 

func (s StartProjectVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSegmentDetectionFilters added in v1.32.7 

type StartSegmentDetectionFilters struct {

	// Filters that are specific to shot detections.
	ShotFilter *StartShotDetectionFilter `type:"structure"`

	// Filters that are specific to technical cues.
	TechnicalCueFilter *StartTechnicalCueDetectionFilter `type:"structure"`
	// contains filtered or unexported fields
}

Filters applied to the technical cue or shot detection segments. For more information, see StartSegmentDetection.

func (StartSegmentDetectionFilters) GoString added in v1.32.7 

func (s StartSegmentDetectionFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSegmentDetectionFilters) SetShotFilter added in v1.32.7 

func (s *StartSegmentDetectionFilters) SetShotFilter(v *StartShotDetectionFilter) *StartSegmentDetectionFilters

SetShotFilter sets the ShotFilter field's value.

func (*StartSegmentDetectionFilters) SetTechnicalCueFilter added in v1.32.7 

func (s *StartSegmentDetectionFilters) SetTechnicalCueFilter(v *StartTechnicalCueDetectionFilter) *StartSegmentDetectionFilters

SetTechnicalCueFilter sets the TechnicalCueFilter field's value.

func (StartSegmentDetectionFilters) String added in v1.32.7 

func (s StartSegmentDetectionFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSegmentDetectionFilters) Validate added in v1.32.7 

func (s *StartSegmentDetectionFilters) Validate() error

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

type StartSegmentDetectionInput added in v1.32.7 

type StartSegmentDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartSegmentDetection 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"`

	// Filters for technical cue or shot detection.
	Filters *StartSegmentDetectionFilters `type:"structure"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video
	// to publish the completion status of the segment detection operation. Note
	// that the Amazon SNS topic must have a topic name that begins with AmazonRekognition
	// if you are using the AmazonRekognitionServiceRole permissions policy to access
	// the topic.
	NotificationChannel *NotificationChannel `type:"structure"`

	// An array of segment types to detect in the video. Valid values are TECHNICAL_CUE
	// and SHOT.
	//
	// SegmentTypes is a required field
	SegmentTypes []*string `min:"1" type:"list" required:"true" enum:"SegmentType"`

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetection use Video to specify a video for analysis.
	// The supported file formats are .mp4, .mov and .avi.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartSegmentDetectionInput) GoString added in v1.32.7 

func (s StartSegmentDetectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSegmentDetectionInput) SetClientRequestToken added in v1.32.7 

func (s *StartSegmentDetectionInput) SetClientRequestToken(v string) *StartSegmentDetectionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartSegmentDetectionInput) SetFilters added in v1.32.7 

func (s *StartSegmentDetectionInput) SetFilters(v *StartSegmentDetectionFilters) *StartSegmentDetectionInput

SetFilters sets the Filters field's value.

func (*StartSegmentDetectionInput) SetJobTag added in v1.32.7 

func (s *StartSegmentDetectionInput) SetJobTag(v string) *StartSegmentDetectionInput

SetJobTag sets the JobTag field's value.

func (*StartSegmentDetectionInput) SetNotificationChannel added in v1.32.7 

func (s *StartSegmentDetectionInput) SetNotificationChannel(v *NotificationChannel) *StartSegmentDetectionInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartSegmentDetectionInput) SetSegmentTypes added in v1.32.7 

func (s *StartSegmentDetectionInput) SetSegmentTypes(v []*string) *StartSegmentDetectionInput

SetSegmentTypes sets the SegmentTypes field's value.

func (*StartSegmentDetectionInput) SetVideo added in v1.32.7 

func (s *StartSegmentDetectionInput) SetVideo(v *Video) *StartSegmentDetectionInput

SetVideo sets the Video field's value.

func (StartSegmentDetectionInput) String added in v1.32.7 

func (s StartSegmentDetectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSegmentDetectionInput) Validate added in v1.32.7 

func (s *StartSegmentDetectionInput) Validate() error

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

type StartSegmentDetectionOutput added in v1.32.7 

type StartSegmentDetectionOutput struct {

	// Unique identifier for the segment detection job. The JobId is returned from
	// StartSegmentDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartSegmentDetectionOutput) GoString added in v1.32.7 

func (s StartSegmentDetectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSegmentDetectionOutput) SetJobId added in v1.32.7 

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

SetJobId sets the JobId field's value.

func (StartSegmentDetectionOutput) String added in v1.32.7 

func (s StartSegmentDetectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartShotDetectionFilter added in v1.32.7 

type StartShotDetectionFilter struct {

	// Specifies the minimum confidence that Amazon Rekognition Video must have
	// in order to return a detected segment. Confidence represents how certain
	// Amazon Rekognition is that a segment is correctly identified. 0 is the lowest
	// confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't
	// return any segments with a confidence level lower than this specified value.
	//
	// If you don't specify MinSegmentConfidence, the GetSegmentDetection returns
	// segments with confidence values greater than or equal to 50 percent.
	MinSegmentConfidence *float64 `min:"50" type:"float"`
	// contains filtered or unexported fields
}

Filters for the shot detection segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.

func (StartShotDetectionFilter) GoString added in v1.32.7 

func (s StartShotDetectionFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartShotDetectionFilter) SetMinSegmentConfidence added in v1.32.7 

func (s *StartShotDetectionFilter) SetMinSegmentConfidence(v float64) *StartShotDetectionFilter

SetMinSegmentConfidence sets the MinSegmentConfidence field's value.

func (StartShotDetectionFilter) String added in v1.32.7 

func (s StartShotDetectionFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartShotDetectionFilter) Validate added in v1.32.7 

func (s *StartShotDetectionFilter) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartStreamProcessorOutput) String added in v1.12.36 

func (s StartStreamProcessorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartTechnicalCueDetectionFilter added in v1.32.7 

type StartTechnicalCueDetectionFilter struct {

	// A filter that allows you to control the black frame detection by specifying
	// the black levels and pixel coverage of black pixels in a frame. Videos can
	// come from multiple sources, formats, and time periods, with different standards
	// and varying noise levels for black frames that need to be accounted for.
	BlackFrame *BlackFrame `type:"structure"`

	// Specifies the minimum confidence that Amazon Rekognition Video must have
	// in order to return a detected segment. Confidence represents how certain
	// Amazon Rekognition is that a segment is correctly identified. 0 is the lowest
	// confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't
	// return any segments with a confidence level lower than this specified value.
	//
	// If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments
	// with confidence values greater than or equal to 50 percent.
	MinSegmentConfidence *float64 `min:"50" type:"float"`
	// contains filtered or unexported fields
}

Filters for the technical segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.

func (StartTechnicalCueDetectionFilter) GoString added in v1.32.7 

func (s StartTechnicalCueDetectionFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTechnicalCueDetectionFilter) SetBlackFrame added in v1.40.18 

func (s *StartTechnicalCueDetectionFilter) SetBlackFrame(v *BlackFrame) *StartTechnicalCueDetectionFilter

SetBlackFrame sets the BlackFrame field's value.

func (*StartTechnicalCueDetectionFilter) SetMinSegmentConfidence added in v1.32.7 

func (s *StartTechnicalCueDetectionFilter) SetMinSegmentConfidence(v float64) *StartTechnicalCueDetectionFilter

SetMinSegmentConfidence sets the MinSegmentConfidence field's value.

func (StartTechnicalCueDetectionFilter) String added in v1.32.7 

func (s StartTechnicalCueDetectionFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTechnicalCueDetectionFilter) Validate added in v1.32.7 

func (s *StartTechnicalCueDetectionFilter) Validate() error

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

type StartTextDetectionFilters added in v1.29.4 

type StartTextDetectionFilters struct {

	// Filter focusing on a certain area of the frame. Uses a BoundingBox object
	// to set the region of the screen.
	RegionsOfInterest []*RegionOfInterest `type:"list"`

	// Filters focusing on qualities of the text, such as confidence or size.
	WordFilter *DetectionFilter `type:"structure"`
	// contains filtered or unexported fields
}

Set of optional parameters that let you set the criteria text must meet to be included in your response. WordFilter looks at a word's height, width and minimum confidence. RegionOfInterest lets you set a specific region of the screen to look for text in.

func (StartTextDetectionFilters) GoString added in v1.29.4 

func (s StartTextDetectionFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTextDetectionFilters) SetRegionsOfInterest added in v1.29.4 

func (s *StartTextDetectionFilters) SetRegionsOfInterest(v []*RegionOfInterest) *StartTextDetectionFilters

SetRegionsOfInterest sets the RegionsOfInterest field's value.

func (*StartTextDetectionFilters) SetWordFilter added in v1.29.4 

func (s *StartTextDetectionFilters) SetWordFilter(v *DetectionFilter) *StartTextDetectionFilters

SetWordFilter sets the WordFilter field's value.

func (StartTextDetectionFilters) String added in v1.29.4 

func (s StartTextDetectionFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartTextDetectionInput added in v1.29.4 

type StartTextDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartTextDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidentaly started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// Optional parameters that let you set criteria the text must meet to be included
	// in your response.
	Filters *StartTextDetectionFilters `type:"structure"`

	// An identifier returned in the completion status published by your Amazon
	// Simple Notification Service topic. For example, you can use JobTag to group
	// related jobs and identify them in the completion notification.
	JobTag *string `min:"1" type:"string"`

	// 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. Note that the Amazon SNS topic must have a topic name that
	// begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole
	// permissions policy to access the topic. For more information, see Giving
	// access to multiple Amazon SNS topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics).
	NotificationChannel *NotificationChannel `type:"structure"`

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetection use Video to specify a video for analysis.
	// The supported file formats are .mp4, .mov and .avi.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartTextDetectionInput) GoString added in v1.29.4 

func (s StartTextDetectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTextDetectionInput) SetClientRequestToken added in v1.29.4 

func (s *StartTextDetectionInput) SetClientRequestToken(v string) *StartTextDetectionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartTextDetectionInput) SetFilters added in v1.29.4 

func (s *StartTextDetectionInput) SetFilters(v *StartTextDetectionFilters) *StartTextDetectionInput

SetFilters sets the Filters field's value.

func (*StartTextDetectionInput) SetJobTag added in v1.29.4 

func (s *StartTextDetectionInput) SetJobTag(v string) *StartTextDetectionInput

SetJobTag sets the JobTag field's value.

func (*StartTextDetectionInput) SetNotificationChannel added in v1.29.4 

func (s *StartTextDetectionInput) SetNotificationChannel(v *NotificationChannel) *StartTextDetectionInput

SetNotificationChannel sets the NotificationChannel field's value.

func (*StartTextDetectionInput) SetVideo added in v1.29.4 

func (s *StartTextDetectionInput) SetVideo(v *Video) *StartTextDetectionInput

SetVideo sets the Video field's value.

func (StartTextDetectionInput) String added in v1.29.4 

func (s StartTextDetectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTextDetectionInput) Validate added in v1.29.4 

func (s *StartTextDetectionInput) Validate() error

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

type StartTextDetectionOutput added in v1.29.4 

type StartTextDetectionOutput struct {

	// Identifier for the text detection job. Use JobId to identify the job in a
	// subsequent call to GetTextDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartTextDetectionOutput) GoString added in v1.29.4 

func (s StartTextDetectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTextDetectionOutput) SetJobId added in v1.29.4 

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

SetJobId sets the JobId field's value.

func (StartTextDetectionOutput) String added in v1.29.4 

func (s StartTextDetectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopProjectVersionInput added in v1.25.47 

type StopProjectVersionInput struct {

	// The Amazon Resource Name (ARN) of the model version that you want to delete.
	//
	// This operation requires permissions to perform the rekognition:StopProjectVersion
	// action.
	//
	// ProjectVersionArn is a required field
	ProjectVersionArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopProjectVersionInput) GoString added in v1.25.47 

func (s StopProjectVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopProjectVersionInput) SetProjectVersionArn added in v1.25.47 

func (s *StopProjectVersionInput) SetProjectVersionArn(v string) *StopProjectVersionInput

SetProjectVersionArn sets the ProjectVersionArn field's value.

func (StopProjectVersionInput) String added in v1.25.47 

func (s StopProjectVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopProjectVersionInput) Validate added in v1.25.47 

func (s *StopProjectVersionInput) Validate() error

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

type StopProjectVersionOutput added in v1.25.47 

type StopProjectVersionOutput struct {

	// The current status of the stop operation.
	Status *string `type:"string" enum:"ProjectVersionStatus"`
	// contains filtered or unexported fields
}

func (StopProjectVersionOutput) GoString added in v1.25.47 

func (s StopProjectVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopProjectVersionOutput) SetStatus added in v1.25.47 

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

SetStatus sets the Status field's value.

func (StopProjectVersionOutput) String added in v1.25.47 

func (s StopProjectVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopStreamProcessorInput added in v1.12.36 

type StopStreamProcessorInput struct {

	// The name of a stream processor created by CreateStreamProcessor.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopStreamProcessorOutput) String added in v1.12.36 

func (s StopStreamProcessorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 CreateStreamProcessor. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

func (StreamProcessorOutput) GoString added in v1.12.36 

func (s StreamProcessorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Summary added in v1.25.47 

type Summary struct {

	// Provides the S3 bucket name and object name.
	//
	// The region for the S3 bucket containing the S3 object must match the region
	// you use for Amazon Rekognition operations.
	//
	// For Amazon Rekognition to process an S3 object, the user must have permission
	// to access the S3 object. For more information, see Resource-Based Policies
	// in the Amazon Rekognition Developer Guide.
	S3Object *S3Object `type:"structure"`
	// contains filtered or unexported fields
}

The S3 bucket that contains the training summary. The training summary includes aggregated evaluation metrics for the entire testing dataset and metrics for each individual label.

You get the training summary S3 bucket location by calling DescribeProjectVersions.

func (Summary) GoString added in v1.25.47 

func (s Summary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Summary) SetS3Object added in v1.25.47 

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

SetS3Object sets the S3Object field's value.

func (Summary) String added in v1.25.47 

func (s Summary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.38.5 

type TagResourceInput struct {

	// Amazon Resource Name (ARN) of the model, collection, or stream processor
	// that you want to assign the tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`

	// The key-value tags to assign to the resource.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.38.5 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.38.5 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.38.5 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.38.5 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.38.5 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.38.5 

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

func (TagResourceOutput) GoString added in v1.38.5 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.38.5 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TechnicalCueSegment added in v1.32.7 

type TechnicalCueSegment struct {

	// The confidence that Amazon Rekognition Video has in the accuracy of the detected
	// segment.
	Confidence *float64 `min:"50" type:"float"`

	// The type of the technical cue.
	Type *string `type:"string" enum:"TechnicalCueType"`
	// contains filtered or unexported fields
}

Information about a technical cue segment. For more information, see SegmentDetection.

func (TechnicalCueSegment) GoString added in v1.32.7 

func (s TechnicalCueSegment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TechnicalCueSegment) SetConfidence added in v1.32.7 

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

SetConfidence sets the Confidence field's value.

func (*TechnicalCueSegment) SetType added in v1.32.7 

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

SetType sets the Type field's value.

func (TechnicalCueSegment) String added in v1.32.7 

func (s TechnicalCueSegment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestingData added in v1.25.47 

type TestingData struct {

	// The assets used for testing.
	Assets []*Asset `type:"list"`

	// If specified, Amazon Rekognition Custom Labels temporarily splits the training
	// dataset (80%) to create a test dataset (20%) for the training job. After
	// training completes, the test dataset is not stored and the training dataset
	// reverts to its previous size.
	AutoCreate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition Custom Labels uses the training dataset to create a test dataset with a temporary split of the training dataset.

func (TestingData) GoString added in v1.25.47 

func (s TestingData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestingData) SetAssets added in v1.25.47 

func (s *TestingData) SetAssets(v []*Asset) *TestingData

SetAssets sets the Assets field's value.

func (*TestingData) SetAutoCreate added in v1.25.47 

func (s *TestingData) SetAutoCreate(v bool) *TestingData

SetAutoCreate sets the AutoCreate field's value.

func (TestingData) String added in v1.25.47 

func (s TestingData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestingData) Validate added in v1.25.47 

func (s *TestingData) Validate() error

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

type TestingDataResult added in v1.25.47 

type TestingDataResult struct {

	// The testing dataset that was supplied for training.
	Input *TestingData `type:"structure"`

	// The subset of the dataset that was actually tested. Some images (assets)
	// might not be tested due to file formatting and other issues.
	Output *TestingData `type:"structure"`

	// The location of the data validation manifest. The data validation manifest
	// is created for the test dataset during model training.
	Validation *ValidationData `type:"structure"`
	// contains filtered or unexported fields
}

Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

func (TestingDataResult) GoString added in v1.25.47 

func (s TestingDataResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestingDataResult) SetInput added in v1.25.47 

func (s *TestingDataResult) SetInput(v *TestingData) *TestingDataResult

SetInput sets the Input field's value.

func (*TestingDataResult) SetOutput added in v1.25.47 

func (s *TestingDataResult) SetOutput(v *TestingData) *TestingDataResult

SetOutput sets the Output field's value.

func (*TestingDataResult) SetValidation added in v1.35.6 

func (s *TestingDataResult) SetValidation(v *ValidationData) *TestingDataResult

SetValidation sets the Validation field's value.

func (TestingDataResult) String added in v1.25.47 

func (s TestingDataResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 DetectText.

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 Detecting Text in the Amazon Rekognition Developer Guide.

func (TextDetection) GoString added in v1.12.32 

func (s TextDetection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextDetectionResult added in v1.29.4 

type TextDetectionResult struct {

	// Details about text detected in a video.
	TextDetection *TextDetection `type:"structure"`

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

Information about text detected in a video. Incudes the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

func (TextDetectionResult) GoString added in v1.29.4 

func (s TextDetectionResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextDetectionResult) SetTextDetection added in v1.29.4 

func (s *TextDetectionResult) SetTextDetection(v *TextDetection) *TextDetectionResult

SetTextDetection sets the TextDetection field's value.

func (*TextDetectionResult) SetTimestamp added in v1.29.4 

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

SetTimestamp sets the Timestamp field's value.

func (TextDetectionResult) String added in v1.29.4 

func (s TextDetectionResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Amazon Rekognition is temporarily unable to process the request. Try your call again.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrainingData added in v1.25.47 

type TrainingData struct {

	// A Sagemaker GroundTruth manifest file that contains the training images (assets).
	Assets []*Asset `type:"list"`
	// contains filtered or unexported fields
}

The dataset used for training.

func (TrainingData) GoString added in v1.25.47 

func (s TrainingData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrainingData) SetAssets added in v1.25.47 

func (s *TrainingData) SetAssets(v []*Asset) *TrainingData

SetAssets sets the Assets field's value.

func (TrainingData) String added in v1.25.47 

func (s TrainingData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrainingData) Validate added in v1.25.47 

func (s *TrainingData) Validate() error

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

type TrainingDataResult added in v1.25.47 

type TrainingDataResult struct {

	// The training assets that you supplied for training.
	Input *TrainingData `type:"structure"`

	// The images (assets) that were actually trained by Amazon Rekognition Custom
	// Labels.
	Output *TrainingData `type:"structure"`

	// The location of the data validation manifest. The data validation manifest
	// is created for the training dataset during model training.
	Validation *ValidationData `type:"structure"`
	// contains filtered or unexported fields
}

Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

func (TrainingDataResult) GoString added in v1.25.47 

func (s TrainingDataResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrainingDataResult) SetInput added in v1.25.47 

func (s *TrainingDataResult) SetInput(v *TrainingData) *TrainingDataResult

SetInput sets the Input field's value.

func (*TrainingDataResult) SetOutput added in v1.25.47 

func (s *TrainingDataResult) SetOutput(v *TrainingData) *TrainingDataResult

SetOutput sets the Output field's value.

func (*TrainingDataResult) SetValidation added in v1.35.6 

func (s *TrainingDataResult) SetValidation(v *ValidationData) *TrainingDataResult

SetValidation sets the Validation field's value.

func (TrainingDataResult) String added in v1.25.47 

func (s TrainingDataResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnindexedFace added in v1.15.37 

type UnindexedFace struct {

	// The structure that contains attributes of a face that IndexFacesdetected,
	// but didn't index.
	FaceDetail *FaceDetail `type:"structure"`

	// An array of reasons that specify why a face wasn't indexed.
	//
	//    * EXTREME_POSE - The face is at a pose that can't be detected. For example,
	//    the head is turned too far away from the camera.
	//
	//    * EXCEEDS_MAX_FACES - The number of faces detected is already higher than
	//    that specified by the MaxFaces input parameter for IndexFaces.
	//
	//    * LOW_BRIGHTNESS - The image is too dark.
	//
	//    * LOW_SHARPNESS - The image is too blurry.
	//
	//    * LOW_CONFIDENCE - The face was detected with a low confidence.
	//
	//    * SMALL_BOUNDING_BOX - The bounding box around the face is too small.
	Reasons []*string `type:"list" enum:"Reason"`
	// contains filtered or unexported fields
}

A face that IndexFaces detected, but didn't index. Use the Reasons response attribute to determine why a face wasn't indexed.

func (UnindexedFace) GoString added in v1.15.37 

func (s UnindexedFace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnindexedFace) SetFaceDetail added in v1.15.37 

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

SetFaceDetail sets the FaceDetail field's value.

func (*UnindexedFace) SetReasons added in v1.15.37 

func (s *UnindexedFace) SetReasons(v []*string) *UnindexedFace

SetReasons sets the Reasons field's value.

func (UnindexedFace) String added in v1.15.37 

func (s UnindexedFace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.38.5 

type UntagResourceInput struct {

	// Amazon Resource Name (ARN) of the model, collection, or stream processor
	// that you want to remove the tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`

	// A list of the tags that you want to remove.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.38.5 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.38.5 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.38.5 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.38.5 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.38.5 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.38.5 

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

func (UntagResourceOutput) GoString added in v1.38.5 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.38.5 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDatasetEntriesInput added in v1.41.15 

type UpdateDatasetEntriesInput struct {

	// The changes that you want to make to the dataset.
	//
	// Changes is a required field
	Changes *DatasetChanges `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the dataset that you want to update.
	//
	// DatasetArn is a required field
	DatasetArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDatasetEntriesInput) GoString added in v1.41.15 

func (s UpdateDatasetEntriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDatasetEntriesInput) SetChanges added in v1.41.15 

func (s *UpdateDatasetEntriesInput) SetChanges(v *DatasetChanges) *UpdateDatasetEntriesInput

SetChanges sets the Changes field's value.

func (*UpdateDatasetEntriesInput) SetDatasetArn added in v1.41.15 

func (s *UpdateDatasetEntriesInput) SetDatasetArn(v string) *UpdateDatasetEntriesInput

SetDatasetArn sets the DatasetArn field's value.

func (UpdateDatasetEntriesInput) String added in v1.41.15 

func (s UpdateDatasetEntriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDatasetEntriesInput) Validate added in v1.41.15 

func (s *UpdateDatasetEntriesInput) Validate() error

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

type UpdateDatasetEntriesOutput added in v1.41.15 

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

func (UpdateDatasetEntriesOutput) GoString added in v1.41.15 

func (s UpdateDatasetEntriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDatasetEntriesOutput) String added in v1.41.15 

func (s UpdateDatasetEntriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationData added in v1.35.6 

type ValidationData struct {

	// The assets that comprise the validation data.
	Assets []*Asset `type:"list"`
	// contains filtered or unexported fields
}

Contains the Amazon S3 bucket location of the validation data for a model training job.

The validation data includes error information for individual JSON Lines in the dataset. For more information, see Debugging a Failed Model Training in the Amazon Rekognition Custom Labels Developer Guide.

You get the ValidationData object for the training dataset (TrainingDataResult) and the test dataset (TestingDataResult) by calling DescribeProjectVersions.

The assets array contains a single Asset object. The GroundTruthManifest field of the Asset object contains the S3 bucket location of the validation data.

func (ValidationData) GoString added in v1.35.6 

func (s ValidationData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationData) SetAssets added in v1.35.6 

func (s *ValidationData) SetAssets(v []*Asset) *ValidationData

SetAssets sets the Assets field's value.

func (ValidationData) String added in v1.35.6 

func (s ValidationData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 StartLabelDetection 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A description of the range of luminance values in a video, either LIMITED
	// (16 to 235) or FULL (0 to 255).
	ColorRange *string `type:"string" enum:"VideoColorRange"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VideoMetadata) SetCodec added in v1.12.36 

func (s *VideoMetadata) SetCodec(v string) *VideoMetadata

SetCodec sets the Codec field's value.

func (*VideoMetadata) SetColorRange added in v1.40.18 

func (s *VideoMetadata) SetColorRange(v string) *VideoMetadata

SetColorRange sets the ColorRange 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VideoTooLargeException added in v1.28.0 

type VideoTooLargeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

func (*VideoTooLargeException) Code added in v1.28.0 

func (s *VideoTooLargeException) Code() string

Code returns the exception type name.

func (*VideoTooLargeException) Error added in v1.28.0 

func (s *VideoTooLargeException) Error() string

func (VideoTooLargeException) GoString added in v1.28.0 

func (s VideoTooLargeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VideoTooLargeException) Message added in v1.28.0 

func (s *VideoTooLargeException) Message() string

Message returns the exception's message.

func (*VideoTooLargeException) OrigErr added in v1.28.0 

func (s *VideoTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*VideoTooLargeException) RequestID added in v1.28.0 

func (s *VideoTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*VideoTooLargeException) StatusCode added in v1.28.0 

func (s *VideoTooLargeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (VideoTooLargeException) String added in v1.28.0 

func (s VideoTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.