aws-sdk-go: github.com/aws/aws-sdk-go/service/rekognition Index | Examples | Files | Directories

package rekognition

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

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

Package Files

api.go doc.go errors.go service.go

Constants

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

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

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

    // ContentModerationSortByTimestamp is a ContentModerationSortBy enum value
    ContentModerationSortByTimestamp = "TIMESTAMP"
)
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"
)
const (
    // FaceAttributesDefault is a FaceAttributes enum value
    FaceAttributesDefault = "DEFAULT"

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

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

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

    // LabelDetectionSortByTimestamp is a LabelDetectionSortBy enum value
    LabelDetectionSortByTimestamp = "TIMESTAMP"
)
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"
)
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"
)
const (
    // PersonTrackingSortByIndex is a PersonTrackingSortBy enum value
    PersonTrackingSortByIndex = "INDEX"

    // PersonTrackingSortByTimestamp is a PersonTrackingSortBy enum value
    PersonTrackingSortByTimestamp = "TIMESTAMP"
)
const (
    // QualityFilterNone is a QualityFilter enum value
    QualityFilterNone = "NONE"

    // QualityFilterAuto is a QualityFilter enum value
    QualityFilterAuto = "AUTO"
)
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"
)
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"
)
const (
    // TextTypesLine is a TextTypes enum value
    TextTypesLine = "LINE"

    // TextTypesWord is a TextTypes enum value
    TextTypesWord = "WORD"
)
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"
)
const (

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

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

    // ErrCodeImageTooLargeException for service response error code
    // "ImageTooLargeException".
    //
    // The input image size exceeds the allowed limit. For more information, see
    // Limits 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 collection with the specified ID already exists.
    ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

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

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

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

    // ErrCodeVideoTooLargeException for service response error code
    // "VideoTooLargeException".
    //
    // The file size or duration of the supplied media is too large. The maximum
    // file size is 8GB. The maximum duration is 2 hours.
    ErrCodeVideoTooLargeException = "VideoTooLargeException"
)
const (
    ServiceName = "rekognition" // Name of service.
    EndpointsID = ServiceName   // ID to lookup a service endpoint with.
    ServiceID   = "Rekognition" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type AgeRange Uses

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 Uses

func (s AgeRange) GoString() string

GoString returns the string representation

func (*AgeRange) SetHigh Uses

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

SetHigh sets the High field's value.

func (*AgeRange) SetLow Uses

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

SetLow sets the Low field's value.

func (AgeRange) String Uses

func (s AgeRange) String() string

String returns the string representation

type Beard Uses

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 Uses

func (s Beard) GoString() string

GoString returns the string representation

func (*Beard) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Beard) SetValue Uses

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

SetValue sets the Value field's value.

func (Beard) String Uses

func (s Beard) String() string

String returns the string representation

type BoundingBox Uses

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, or text. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

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

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

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

func (BoundingBox) GoString Uses

func (s BoundingBox) GoString() string

GoString returns the string representation

func (*BoundingBox) SetHeight Uses

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

SetHeight sets the Height field's value.

func (*BoundingBox) SetLeft Uses

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

SetLeft sets the Left field's value.

func (*BoundingBox) SetTop Uses

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

SetTop sets the Top field's value.

func (*BoundingBox) SetWidth Uses

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

SetWidth sets the Width field's value.

func (BoundingBox) String Uses

func (s BoundingBox) String() string

String returns the string representation

type Celebrity Uses

type Celebrity struct {

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

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

    // The confidence, in percentage, that 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 Uses

func (s Celebrity) GoString() string

GoString returns the string representation

func (*Celebrity) SetFace Uses

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

SetFace sets the Face field's value.

func (*Celebrity) SetId Uses

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

SetId sets the Id field's value.

func (*Celebrity) SetMatchConfidence Uses

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

SetMatchConfidence sets the MatchConfidence field's value.

func (*Celebrity) SetName Uses

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

SetName sets the Name field's value.

func (*Celebrity) SetUrls Uses

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

SetUrls sets the Urls field's value.

func (Celebrity) String Uses

func (s Celebrity) String() string

String returns the string representation

type CelebrityDetail Uses

type CelebrityDetail struct {

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

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

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

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

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

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

Information about a recognized celebrity.

func (CelebrityDetail) GoString Uses

func (s CelebrityDetail) GoString() string

GoString returns the string representation

func (*CelebrityDetail) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*CelebrityDetail) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*CelebrityDetail) SetFace Uses

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

SetFace sets the Face field's value.

func (*CelebrityDetail) SetId Uses

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

SetId sets the Id field's value.

func (*CelebrityDetail) SetName Uses

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

SetName sets the Name field's value.

func (*CelebrityDetail) SetUrls Uses

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

SetUrls sets the Urls field's value.

func (CelebrityDetail) String Uses

func (s CelebrityDetail) String() string

String returns the string representation

type CelebrityRecognition Uses

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 Uses

func (s CelebrityRecognition) GoString() string

GoString returns the string representation

func (*CelebrityRecognition) SetCelebrity Uses

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

SetCelebrity sets the Celebrity field's value.

func (*CelebrityRecognition) SetTimestamp Uses

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

SetTimestamp sets the Timestamp field's value.

func (CelebrityRecognition) String Uses

func (s CelebrityRecognition) String() string

String returns the string representation

type CompareFacesInput Uses

type CompareFacesInput struct {

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

    // The input image as base64-encoded bytes or an S3 object. If you use the AWS
    // CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
    // is not supported.
    //
    // 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 Uses

func (s CompareFacesInput) GoString() string

GoString returns the string representation

func (*CompareFacesInput) SetSimilarityThreshold Uses

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

SetSimilarityThreshold sets the SimilarityThreshold field's value.

func (*CompareFacesInput) SetSourceImage Uses

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

SetSourceImage sets the SourceImage field's value.

func (*CompareFacesInput) SetTargetImage Uses

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

SetTargetImage sets the TargetImage field's value.

func (CompareFacesInput) String Uses

func (s CompareFacesInput) String() string

String returns the string representation

func (*CompareFacesInput) Validate Uses

func (s *CompareFacesInput) Validate() error

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

type CompareFacesMatch Uses

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 Uses

func (s CompareFacesMatch) GoString() string

GoString returns the string representation

func (*CompareFacesMatch) SetFace Uses

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

SetFace sets the Face field's value.

func (*CompareFacesMatch) SetSimilarity Uses

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

SetSimilarity sets the Similarity field's value.

func (CompareFacesMatch) String Uses

func (s CompareFacesMatch) String() string

String returns the string representation

type CompareFacesOutput Uses

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 Uses

func (s CompareFacesOutput) GoString() string

GoString returns the string representation

func (*CompareFacesOutput) SetFaceMatches Uses

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

SetFaceMatches sets the FaceMatches field's value.

func (*CompareFacesOutput) SetSourceImageFace Uses

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

SetSourceImageFace sets the SourceImageFace field's value.

func (*CompareFacesOutput) SetSourceImageOrientationCorrection Uses

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

SetSourceImageOrientationCorrection sets the SourceImageOrientationCorrection field's value.

func (*CompareFacesOutput) SetTargetImageOrientationCorrection Uses

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

SetTargetImageOrientationCorrection sets the TargetImageOrientationCorrection field's value.

func (*CompareFacesOutput) SetUnmatchedFaces Uses

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

SetUnmatchedFaces sets the UnmatchedFaces field's value.

func (CompareFacesOutput) String Uses

func (s CompareFacesOutput) String() string

String returns the string representation

type ComparedFace Uses

type ComparedFace struct {

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

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

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

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

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

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

func (ComparedFace) GoString Uses

func (s ComparedFace) GoString() string

GoString returns the string representation

func (*ComparedFace) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*ComparedFace) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*ComparedFace) SetLandmarks Uses

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

SetLandmarks sets the Landmarks field's value.

func (*ComparedFace) SetPose Uses

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

SetPose sets the Pose field's value.

func (*ComparedFace) SetQuality Uses

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

SetQuality sets the Quality field's value.

func (ComparedFace) String Uses

func (s ComparedFace) String() string

String returns the string representation

type ComparedSourceImageFace Uses

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 Uses

func (s ComparedSourceImageFace) GoString() string

GoString returns the string representation

func (*ComparedSourceImageFace) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*ComparedSourceImageFace) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (ComparedSourceImageFace) String Uses

func (s ComparedSourceImageFace) String() string

String returns the string representation

type ContentModerationDetection Uses

type ContentModerationDetection struct {

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

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

Information about a moderation label detection in a stored video.

func (ContentModerationDetection) GoString Uses

func (s ContentModerationDetection) GoString() string

GoString returns the string representation

func (*ContentModerationDetection) SetModerationLabel Uses

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

SetModerationLabel sets the ModerationLabel field's value.

func (*ContentModerationDetection) SetTimestamp Uses

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

SetTimestamp sets the Timestamp field's value.

func (ContentModerationDetection) String Uses

func (s ContentModerationDetection) String() string

String returns the string representation

type CreateCollectionInput Uses

type CreateCollectionInput struct {

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

func (CreateCollectionInput) GoString Uses

func (s CreateCollectionInput) GoString() string

GoString returns the string representation

func (*CreateCollectionInput) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (CreateCollectionInput) String Uses

func (s CreateCollectionInput) String() string

String returns the string representation

func (*CreateCollectionInput) Validate Uses

func (s *CreateCollectionInput) Validate() error

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

type CreateCollectionOutput Uses

type CreateCollectionOutput struct {

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

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

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

func (CreateCollectionOutput) GoString Uses

func (s CreateCollectionOutput) GoString() string

GoString returns the string representation

func (*CreateCollectionOutput) SetCollectionArn Uses

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

SetCollectionArn sets the CollectionArn field's value.

func (*CreateCollectionOutput) SetFaceModelVersion Uses

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

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*CreateCollectionOutput) SetStatusCode Uses

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

SetStatusCode sets the StatusCode field's value.

func (CreateCollectionOutput) String Uses

func (s CreateCollectionOutput) String() string

String returns the string representation

type CreateStreamProcessorInput Uses

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"`
    // contains filtered or unexported fields
}

func (CreateStreamProcessorInput) GoString Uses

func (s CreateStreamProcessorInput) GoString() string

GoString returns the string representation

func (*CreateStreamProcessorInput) SetInput Uses

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

SetInput sets the Input field's value.

func (*CreateStreamProcessorInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateStreamProcessorInput) SetOutput Uses

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

SetOutput sets the Output field's value.

func (*CreateStreamProcessorInput) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (*CreateStreamProcessorInput) SetSettings Uses

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

SetSettings sets the Settings field's value.

func (CreateStreamProcessorInput) String Uses

func (s CreateStreamProcessorInput) String() string

String returns the string representation

func (*CreateStreamProcessorInput) Validate Uses

func (s *CreateStreamProcessorInput) Validate() error

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

type CreateStreamProcessorOutput Uses

type CreateStreamProcessorOutput struct {

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

func (CreateStreamProcessorOutput) GoString Uses

func (s CreateStreamProcessorOutput) GoString() string

GoString returns the string representation

func (*CreateStreamProcessorOutput) SetStreamProcessorArn Uses

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

SetStreamProcessorArn sets the StreamProcessorArn field's value.

func (CreateStreamProcessorOutput) String Uses

func (s CreateStreamProcessorOutput) String() string

String returns the string representation

type DeleteCollectionInput Uses

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 Uses

func (s DeleteCollectionInput) GoString() string

GoString returns the string representation

func (*DeleteCollectionInput) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (DeleteCollectionInput) String Uses

func (s DeleteCollectionInput) String() string

String returns the string representation

func (*DeleteCollectionInput) Validate Uses

func (s *DeleteCollectionInput) Validate() error

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

type DeleteCollectionOutput Uses

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 Uses

func (s DeleteCollectionOutput) GoString() string

GoString returns the string representation

func (*DeleteCollectionOutput) SetStatusCode Uses

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

SetStatusCode sets the StatusCode field's value.

func (DeleteCollectionOutput) String Uses

func (s DeleteCollectionOutput) String() string

String returns the string representation

type DeleteFacesInput Uses

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 Uses

func (s DeleteFacesInput) GoString() string

GoString returns the string representation

func (*DeleteFacesInput) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (*DeleteFacesInput) SetFaceIds Uses

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

SetFaceIds sets the FaceIds field's value.

func (DeleteFacesInput) String Uses

func (s DeleteFacesInput) String() string

String returns the string representation

func (*DeleteFacesInput) Validate Uses

func (s *DeleteFacesInput) Validate() error

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

type DeleteFacesOutput Uses

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 Uses

func (s DeleteFacesOutput) GoString() string

GoString returns the string representation

func (*DeleteFacesOutput) SetDeletedFaces Uses

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

SetDeletedFaces sets the DeletedFaces field's value.

func (DeleteFacesOutput) String Uses

func (s DeleteFacesOutput) String() string

String returns the string representation

type DeleteStreamProcessorInput Uses

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 Uses

func (s DeleteStreamProcessorInput) GoString() string

GoString returns the string representation

func (*DeleteStreamProcessorInput) SetName Uses

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

SetName sets the Name field's value.

func (DeleteStreamProcessorInput) String Uses

func (s DeleteStreamProcessorInput) String() string

String returns the string representation

func (*DeleteStreamProcessorInput) Validate Uses

func (s *DeleteStreamProcessorInput) Validate() error

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

type DeleteStreamProcessorOutput Uses

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

func (DeleteStreamProcessorOutput) GoString Uses

func (s DeleteStreamProcessorOutput) GoString() string

GoString returns the string representation

func (DeleteStreamProcessorOutput) String Uses

func (s DeleteStreamProcessorOutput) String() string

String returns the string representation

type DescribeCollectionInput Uses

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 Uses

func (s DescribeCollectionInput) GoString() string

GoString returns the string representation

func (*DescribeCollectionInput) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (DescribeCollectionInput) String Uses

func (s DescribeCollectionInput) String() string

String returns the string representation

func (*DescribeCollectionInput) Validate Uses

func (s *DescribeCollectionInput) Validate() error

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

type DescribeCollectionOutput Uses

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 Uses

func (s DescribeCollectionOutput) GoString() string

GoString returns the string representation

func (*DescribeCollectionOutput) SetCollectionARN Uses

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

SetCollectionARN sets the CollectionARN field's value.

func (*DescribeCollectionOutput) SetCreationTimestamp Uses

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeCollectionOutput) SetFaceCount Uses

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

SetFaceCount sets the FaceCount field's value.

func (*DescribeCollectionOutput) SetFaceModelVersion Uses

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

SetFaceModelVersion sets the FaceModelVersion field's value.

func (DescribeCollectionOutput) String Uses

func (s DescribeCollectionOutput) String() string

String returns the string representation

type DescribeStreamProcessorInput Uses

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 Uses

func (s DescribeStreamProcessorInput) GoString() string

GoString returns the string representation

func (*DescribeStreamProcessorInput) SetName Uses

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

SetName sets the Name field's value.

func (DescribeStreamProcessorInput) String Uses

func (s DescribeStreamProcessorInput) String() string

String returns the string representation

func (*DescribeStreamProcessorInput) Validate Uses

func (s *DescribeStreamProcessorInput) Validate() error

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

type DescribeStreamProcessorOutput Uses

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 Uses

func (s DescribeStreamProcessorOutput) GoString() string

GoString returns the string representation

func (*DescribeStreamProcessorOutput) SetCreationTimestamp Uses

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

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeStreamProcessorOutput) SetInput Uses

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

SetInput sets the Input field's value.

func (*DescribeStreamProcessorOutput) SetLastUpdateTimestamp Uses

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

SetLastUpdateTimestamp sets the LastUpdateTimestamp field's value.

func (*DescribeStreamProcessorOutput) SetName Uses

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

SetName sets the Name field's value.

func (*DescribeStreamProcessorOutput) SetOutput Uses

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

SetOutput sets the Output field's value.

func (*DescribeStreamProcessorOutput) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeStreamProcessorOutput) SetSettings Uses

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

SetSettings sets the Settings field's value.

func (*DescribeStreamProcessorOutput) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DescribeStreamProcessorOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*DescribeStreamProcessorOutput) SetStreamProcessorArn Uses

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

SetStreamProcessorArn sets the StreamProcessorArn field's value.

func (DescribeStreamProcessorOutput) String Uses

func (s DescribeStreamProcessorOutput) String() string

String returns the string representation

type DetectFacesInput Uses

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

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

func (s DetectFacesInput) GoString() string

GoString returns the string representation

func (*DetectFacesInput) SetAttributes Uses

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

SetAttributes sets the Attributes field's value.

func (*DetectFacesInput) SetImage Uses

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

SetImage sets the Image field's value.

func (DetectFacesInput) String Uses

func (s DetectFacesInput) String() string

String returns the string representation

func (*DetectFacesInput) Validate Uses

func (s *DetectFacesInput) Validate() error

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

type DetectFacesOutput Uses

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 Uses

func (s DetectFacesOutput) GoString() string

GoString returns the string representation

func (*DetectFacesOutput) SetFaceDetails Uses

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

SetFaceDetails sets the FaceDetails field's value.

func (*DetectFacesOutput) SetOrientationCorrection Uses

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

SetOrientationCorrection sets the OrientationCorrection field's value.

func (DetectFacesOutput) String Uses

func (s DetectFacesOutput) String() string

String returns the string representation

type DetectLabelsInput Uses

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 Uses

func (s DetectLabelsInput) GoString() string

GoString returns the string representation

func (*DetectLabelsInput) SetImage Uses

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

SetImage sets the Image field's value.

func (*DetectLabelsInput) SetMaxLabels Uses

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

SetMaxLabels sets the MaxLabels field's value.

func (*DetectLabelsInput) SetMinConfidence Uses

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

SetMinConfidence sets the MinConfidence field's value.

func (DetectLabelsInput) String Uses

func (s DetectLabelsInput) String() string

String returns the string representation

func (*DetectLabelsInput) Validate Uses

func (s *DetectLabelsInput) Validate() error

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

type DetectLabelsOutput Uses

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 Uses

func (s DetectLabelsOutput) GoString() string

GoString returns the string representation

func (*DetectLabelsOutput) SetLabelModelVersion Uses

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

SetLabelModelVersion sets the LabelModelVersion field's value.

func (*DetectLabelsOutput) SetLabels Uses

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

SetLabels sets the Labels field's value.

func (*DetectLabelsOutput) SetOrientationCorrection Uses

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

SetOrientationCorrection sets the OrientationCorrection field's value.

func (DetectLabelsOutput) String Uses

func (s DetectLabelsOutput) String() string

String returns the string representation

type DetectModerationLabelsInput Uses

type DetectModerationLabelsInput struct {

    // The input image as base64-encoded bytes or an S3 object. If you use the AWS
    // CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
    // is not supported.
    //
    // 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 Uses

func (s DetectModerationLabelsInput) GoString() string

GoString returns the string representation

func (*DetectModerationLabelsInput) SetImage Uses

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

SetImage sets the Image field's value.

func (*DetectModerationLabelsInput) SetMinConfidence Uses

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

SetMinConfidence sets the MinConfidence field's value.

func (DetectModerationLabelsInput) String Uses

func (s DetectModerationLabelsInput) String() string

String returns the string representation

func (*DetectModerationLabelsInput) Validate Uses

func (s *DetectModerationLabelsInput) Validate() error

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

type DetectModerationLabelsOutput Uses

type DetectModerationLabelsOutput struct {

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

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

func (s DetectModerationLabelsOutput) GoString() string

GoString returns the string representation

func (*DetectModerationLabelsOutput) SetModerationLabels Uses

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

SetModerationLabels sets the ModerationLabels field's value.

func (*DetectModerationLabelsOutput) SetModerationModelVersion Uses

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

SetModerationModelVersion sets the ModerationModelVersion field's value.

func (DetectModerationLabelsOutput) String Uses

func (s DetectModerationLabelsOutput) String() string

String returns the string representation

type DetectTextInput Uses

type DetectTextInput struct {

    // The input image as base64-encoded bytes or an Amazon S3 object. If you use
    // the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
    //
    // 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 Uses

func (s DetectTextInput) GoString() string

GoString returns the string representation

func (*DetectTextInput) SetImage Uses

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

SetImage sets the Image field's value.

func (DetectTextInput) String Uses

func (s DetectTextInput) String() string

String returns the string representation

func (*DetectTextInput) Validate Uses

func (s *DetectTextInput) Validate() error

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

type DetectTextOutput Uses

type DetectTextOutput struct {

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

func (DetectTextOutput) GoString Uses

func (s DetectTextOutput) GoString() string

GoString returns the string representation

func (*DetectTextOutput) SetTextDetections Uses

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

SetTextDetections sets the TextDetections field's value.

func (DetectTextOutput) String Uses

func (s DetectTextOutput) String() string

String returns the string representation

type Emotion Uses

type Emotion struct {

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

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

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

func (Emotion) GoString Uses

func (s Emotion) GoString() string

GoString returns the string representation

func (*Emotion) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Emotion) SetType Uses

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

SetType sets the Type field's value.

func (Emotion) String Uses

func (s Emotion) String() string

String returns the string representation

type EyeOpen Uses

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 Uses

func (s EyeOpen) GoString() string

GoString returns the string representation

func (*EyeOpen) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*EyeOpen) SetValue Uses

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

SetValue sets the Value field's value.

func (EyeOpen) String Uses

func (s EyeOpen) String() string

String returns the string representation

type Eyeglasses Uses

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 Uses

func (s Eyeglasses) GoString() string

GoString returns the string representation

func (*Eyeglasses) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Eyeglasses) SetValue Uses

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

SetValue sets the Value field's value.

func (Eyeglasses) String Uses

func (s Eyeglasses) String() string

String returns the string representation

type Face Uses

type Face struct {

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

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

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

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

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

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

func (Face) GoString Uses

func (s Face) GoString() string

GoString returns the string representation

func (*Face) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*Face) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Face) SetExternalImageId Uses

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

SetExternalImageId sets the ExternalImageId field's value.

func (*Face) SetFaceId Uses

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

SetFaceId sets the FaceId field's value.

func (*Face) SetImageId Uses

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

SetImageId sets the ImageId field's value.

func (Face) String Uses

func (s Face) String() string

String returns the string representation

type FaceDetail Uses

type FaceDetail struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Structure containing attributes of the face that the algorithm detected.

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

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 Uses

func (s FaceDetail) GoString() string

GoString returns the string representation

func (*FaceDetail) SetAgeRange Uses

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

SetAgeRange sets the AgeRange field's value.

func (*FaceDetail) SetBeard Uses

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

SetBeard sets the Beard field's value.

func (*FaceDetail) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*FaceDetail) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*FaceDetail) SetEmotions Uses

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

SetEmotions sets the Emotions field's value.

func (*FaceDetail) SetEyeglasses Uses

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

SetEyeglasses sets the Eyeglasses field's value.

func (*FaceDetail) SetEyesOpen Uses

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

SetEyesOpen sets the EyesOpen field's value.

func (*FaceDetail) SetGender Uses

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

SetGender sets the Gender field's value.

func (*FaceDetail) SetLandmarks Uses

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

SetLandmarks sets the Landmarks field's value.

func (*FaceDetail) SetMouthOpen Uses

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

SetMouthOpen sets the MouthOpen field's value.

func (*FaceDetail) SetMustache Uses

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

SetMustache sets the Mustache field's value.

func (*FaceDetail) SetPose Uses

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

SetPose sets the Pose field's value.

func (*FaceDetail) SetQuality Uses

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

SetQuality sets the Quality field's value.

func (*FaceDetail) SetSmile Uses

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

SetSmile sets the Smile field's value.

func (*FaceDetail) SetSunglasses Uses

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

SetSunglasses sets the Sunglasses field's value.

func (FaceDetail) String Uses

func (s FaceDetail) String() string

String returns the string representation

type FaceDetection Uses

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 Uses

func (s FaceDetection) GoString() string

GoString returns the string representation

func (*FaceDetection) SetFace Uses

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

SetFace sets the Face field's value.

func (*FaceDetection) SetTimestamp Uses

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

SetTimestamp sets the Timestamp field's value.

func (FaceDetection) String Uses

func (s FaceDetection) String() string

String returns the string representation

type FaceMatch Uses

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 Uses

func (s FaceMatch) GoString() string

GoString returns the string representation

func (*FaceMatch) SetFace Uses

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

SetFace sets the Face field's value.

func (*FaceMatch) SetSimilarity Uses

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

SetSimilarity sets the Similarity field's value.

func (FaceMatch) String Uses

func (s FaceMatch) String() string

String returns the string representation

type FaceRecord Uses

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 Uses

func (s FaceRecord) GoString() string

GoString returns the string representation

func (*FaceRecord) SetFace Uses

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

SetFace sets the Face field's value.

func (*FaceRecord) SetFaceDetail Uses

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

SetFaceDetail sets the FaceDetail field's value.

func (FaceRecord) String Uses

func (s FaceRecord) String() string

String returns the string representation

type FaceSearchSettings Uses

type FaceSearchSettings struct {

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

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

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

func (FaceSearchSettings) GoString Uses

func (s FaceSearchSettings) GoString() string

GoString returns the string representation

func (*FaceSearchSettings) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (*FaceSearchSettings) SetFaceMatchThreshold Uses

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

SetFaceMatchThreshold sets the FaceMatchThreshold field's value.

func (FaceSearchSettings) String Uses

func (s FaceSearchSettings) String() string

String returns the string representation

func (*FaceSearchSettings) Validate Uses

func (s *FaceSearchSettings) Validate() error

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

type Gender Uses

type Gender struct {

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

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

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

func (Gender) GoString Uses

func (s Gender) GoString() string

GoString returns the string representation

func (*Gender) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Gender) SetValue Uses

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

SetValue sets the Value field's value.

func (Gender) String Uses

func (s Gender) String() string

String returns the string representation

type Geometry Uses

type Geometry struct {

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

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

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

func (Geometry) GoString Uses

func (s Geometry) GoString() string

GoString returns the string representation

func (*Geometry) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*Geometry) SetPolygon Uses

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

SetPolygon sets the Polygon field's value.

func (Geometry) String Uses

func (s Geometry) String() string

String returns the string representation

type GetCelebrityInfoInput Uses

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 Uses

func (s GetCelebrityInfoInput) GoString() string

GoString returns the string representation

func (*GetCelebrityInfoInput) SetId Uses

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

SetId sets the Id field's value.

func (GetCelebrityInfoInput) String Uses

func (s GetCelebrityInfoInput) String() string

String returns the string representation

func (*GetCelebrityInfoInput) Validate Uses

func (s *GetCelebrityInfoInput) Validate() error

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

type GetCelebrityInfoOutput Uses

type GetCelebrityInfoOutput struct {

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

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

func (GetCelebrityInfoOutput) GoString Uses

func (s GetCelebrityInfoOutput) GoString() string

GoString returns the string representation

func (*GetCelebrityInfoOutput) SetName Uses

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

SetName sets the Name field's value.

func (*GetCelebrityInfoOutput) SetUrls Uses

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

SetUrls sets the Urls field's value.

func (GetCelebrityInfoOutput) String Uses

func (s GetCelebrityInfoOutput) String() string

String returns the string representation

type GetCelebrityRecognitionInput Uses

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 Uses

func (s GetCelebrityRecognitionInput) GoString() string

GoString returns the string representation

func (*GetCelebrityRecognitionInput) SetJobId Uses

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

SetJobId sets the JobId field's value.

func (*GetCelebrityRecognitionInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetCelebrityRecognitionInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetCelebrityRecognitionInput) SetSortBy Uses

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

SetSortBy sets the SortBy field's value.

func (GetCelebrityRecognitionInput) String Uses

func (s GetCelebrityRecognitionInput) String() string

String returns the string representation

func (*GetCelebrityRecognitionInput) Validate Uses

func (s *GetCelebrityRecognitionInput) Validate() error

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

type GetCelebrityRecognitionOutput Uses

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 Uses

func (s GetCelebrityRecognitionOutput) GoString() string

GoString returns the string representation

func (*GetCelebrityRecognitionOutput) SetCelebrities Uses

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

SetCelebrities sets the Celebrities field's value.

func (*GetCelebrityRecognitionOutput) SetJobStatus Uses

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

SetJobStatus sets the JobStatus field's value.

func (*GetCelebrityRecognitionOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetCelebrityRecognitionOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetCelebrityRecognitionOutput) SetVideoMetadata Uses

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetCelebrityRecognitionOutput) String Uses

func (s GetCelebrityRecognitionOutput) String() string

String returns the string representation

type GetContentModerationInput Uses

type GetContentModerationInput struct {

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

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

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

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

func (GetContentModerationInput) GoString Uses

func (s GetContentModerationInput) GoString() string

GoString returns the string representation

func (*GetContentModerationInput) SetJobId Uses

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

SetJobId sets the JobId field's value.

func (*GetContentModerationInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetContentModerationInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetContentModerationInput) SetSortBy Uses

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

SetSortBy sets the SortBy field's value.

func (GetContentModerationInput) String Uses

func (s GetContentModerationInput) String() string

String returns the string representation

func (*GetContentModerationInput) Validate Uses

func (s *GetContentModerationInput) Validate() error

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

type GetContentModerationOutput Uses

type GetContentModerationOutput struct {

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

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

    // Version number of the moderation detection model that was used to detect
    // unsafe 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 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 Uses

func (s GetContentModerationOutput) GoString() string

GoString returns the string representation

func (*GetContentModerationOutput) SetJobStatus Uses

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

SetJobStatus sets the JobStatus field's value.

func (*GetContentModerationOutput) SetModerationLabels Uses

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

SetModerationLabels sets the ModerationLabels field's value.

func (*GetContentModerationOutput) SetModerationModelVersion Uses

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

SetModerationModelVersion sets the ModerationModelVersion field's value.

func (*GetContentModerationOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetContentModerationOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetContentModerationOutput) SetVideoMetadata Uses

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetContentModerationOutput) String Uses

func (s GetContentModerationOutput) String() string

String returns the string representation

type GetFaceDetectionInput Uses

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 Uses

func (s GetFaceDetectionInput) GoString() string

GoString returns the string representation

func (*GetFaceDetectionInput) SetJobId Uses

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

SetJobId sets the JobId field's value.

func (*GetFaceDetectionInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetFaceDetectionInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (GetFaceDetectionInput) String Uses

func (s GetFaceDetectionInput) String() string

String returns the string representation

func (*GetFaceDetectionInput) Validate Uses

func (s *GetFaceDetectionInput) Validate() error

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

type GetFaceDetectionOutput Uses

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 Uses

func (s GetFaceDetectionOutput) GoString() string

GoString returns the string representation

func (*GetFaceDetectionOutput) SetFaces Uses

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

SetFaces sets the Faces field's value.

func (*GetFaceDetectionOutput) SetJobStatus Uses

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

SetJobStatus sets the JobStatus field's value.

func (*GetFaceDetectionOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetFaceDetectionOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetFaceDetectionOutput) SetVideoMetadata Uses

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetFaceDetectionOutput) String Uses

func (s GetFaceDetectionOutput) String() string

String returns the string representation

type GetFaceSearchInput Uses

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 Uses

func (s GetFaceSearchInput) GoString() string

GoString returns the string representation

func (*GetFaceSearchInput) SetJobId Uses

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

SetJobId sets the JobId field's value.

func (*GetFaceSearchInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetFaceSearchInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetFaceSearchInput) SetSortBy Uses

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

SetSortBy sets the SortBy field's value.

func (GetFaceSearchInput) String Uses

func (s GetFaceSearchInput) String() string

String returns the string representation

func (*GetFaceSearchInput) Validate Uses

func (s *GetFaceSearchInput) Validate() error

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

type GetFaceSearchOutput Uses

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 Uses

func (s GetFaceSearchOutput) GoString() string

GoString returns the string representation

func (*GetFaceSearchOutput) SetJobStatus Uses

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

SetJobStatus sets the JobStatus field's value.

func (*GetFaceSearchOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetFaceSearchOutput) SetPersons Uses

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

SetPersons sets the Persons field's value.

func (*GetFaceSearchOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetFaceSearchOutput) SetVideoMetadata Uses

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetFaceSearchOutput) String Uses

func (s GetFaceSearchOutput) String() string

String returns the string representation

type GetLabelDetectionInput Uses

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 Uses

func (s GetLabelDetectionInput) GoString() string

GoString returns the string representation

func (*GetLabelDetectionInput) SetJobId Uses

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

SetJobId sets the JobId field's value.

func (*GetLabelDetectionInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetLabelDetectionInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetLabelDetectionInput) SetSortBy Uses

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

SetSortBy sets the SortBy field's value.

func (GetLabelDetectionInput) String Uses

func (s GetLabelDetectionInput) String() string

String returns the string representation

func (*GetLabelDetectionInput) Validate Uses

func (s *GetLabelDetectionInput) Validate() error

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

type GetLabelDetectionOutput Uses

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 Uses

func (s GetLabelDetectionOutput) GoString() string

GoString returns the string representation

func (*GetLabelDetectionOutput) SetJobStatus Uses

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

SetJobStatus sets the JobStatus field's value.

func (*GetLabelDetectionOutput) SetLabelModelVersion Uses

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

SetLabelModelVersion sets the LabelModelVersion field's value.

func (*GetLabelDetectionOutput) SetLabels Uses

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

SetLabels sets the Labels field's value.

func (*GetLabelDetectionOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetLabelDetectionOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetLabelDetectionOutput) SetVideoMetadata Uses

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetLabelDetectionOutput) String Uses

func (s GetLabelDetectionOutput) String() string

String returns the string representation

type GetPersonTrackingInput Uses

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 Uses

func (s GetPersonTrackingInput) GoString() string

GoString returns the string representation

func (*GetPersonTrackingInput) SetJobId Uses

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

SetJobId sets the JobId field's value.

func (*GetPersonTrackingInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetPersonTrackingInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetPersonTrackingInput) SetSortBy Uses

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

SetSortBy sets the SortBy field's value.

func (GetPersonTrackingInput) String Uses

func (s GetPersonTrackingInput) String() string

String returns the string representation

func (*GetPersonTrackingInput) Validate Uses

func (s *GetPersonTrackingInput) Validate() error

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

type GetPersonTrackingOutput Uses

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 Uses

func (s GetPersonTrackingOutput) GoString() string

GoString returns the string representation

func (*GetPersonTrackingOutput) SetJobStatus Uses

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

SetJobStatus sets the JobStatus field's value.

func (*GetPersonTrackingOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetPersonTrackingOutput) SetPersons Uses

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

SetPersons sets the Persons field's value.

func (*GetPersonTrackingOutput) SetStatusMessage Uses

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

SetStatusMessage sets the StatusMessage field's value.

func (*GetPersonTrackingOutput) SetVideoMetadata Uses

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

SetVideoMetadata sets the VideoMetadata field's value.

func (GetPersonTrackingOutput) String Uses

func (s GetPersonTrackingOutput) String() string

String returns the string representation

type Image Uses

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 Uses

func (s Image) GoString() string

GoString returns the string representation

func (*Image) SetBytes Uses

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

SetBytes sets the Bytes field's value.

func (*Image) SetS3Object Uses

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

SetS3Object sets the S3Object field's value.

func (Image) String Uses

func (s Image) String() string

String returns the string representation

func (*Image) Validate Uses

func (s *Image) Validate() error

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

type ImageQuality Uses

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 Uses

func (s ImageQuality) GoString() string

GoString returns the string representation

func (*ImageQuality) SetBrightness Uses

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

SetBrightness sets the Brightness field's value.

func (*ImageQuality) SetSharpness Uses

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

SetSharpness sets the Sharpness field's value.

func (ImageQuality) String Uses

func (s ImageQuality) String() string

String returns the string representation

type IndexFacesInput Uses

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

    // 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 how much filtering is done to identify faces that
    // are detected with low quality. Filtered faces aren't indexed. If you specify
    // AUTO, filtering prioritizes the identification of faces that don’t meet
    // the required quality bar chosen by Amazon Rekognition. 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 AUTO.
    //
    // To use quality filtering, the collection you are using must be associated
    // with version 3 of the face model.
    QualityFilter *string `type:"string" enum:"QualityFilter"`
    // contains filtered or unexported fields
}

func (IndexFacesInput) GoString Uses

func (s IndexFacesInput) GoString() string

GoString returns the string representation

func (*IndexFacesInput) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (*IndexFacesInput) SetDetectionAttributes Uses

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

SetDetectionAttributes sets the DetectionAttributes field's value.

func (*IndexFacesInput) SetExternalImageId Uses

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

SetExternalImageId sets the ExternalImageId field's value.

func (*IndexFacesInput) SetImage Uses

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

SetImage sets the Image field's value.

func (*IndexFacesInput) SetMaxFaces Uses

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

SetMaxFaces sets the MaxFaces field's value.

func (*IndexFacesInput) SetQualityFilter Uses

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

SetQualityFilter sets the QualityFilter field's value.

func (IndexFacesInput) String Uses

func (s IndexFacesInput) String() string

String returns the string representation

func (*IndexFacesInput) Validate Uses

func (s *IndexFacesInput) Validate() error

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

type IndexFacesOutput Uses

type IndexFacesOutput struct {

    // The version number of the face detection model that's associated with the
    // input collection (CollectionId).
    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 Uses

func (s IndexFacesOutput) GoString() string

GoString returns the string representation

func (*IndexFacesOutput) SetFaceModelVersion Uses

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

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*IndexFacesOutput) SetFaceRecords Uses

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

SetFaceRecords sets the FaceRecords field's value.

func (*IndexFacesOutput) SetOrientationCorrection Uses

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

SetOrientationCorrection sets the OrientationCorrection field's value.

func (*IndexFacesOutput) SetUnindexedFaces Uses

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

SetUnindexedFaces sets the UnindexedFaces field's value.

func (IndexFacesOutput) String Uses

func (s IndexFacesOutput) String() string

String returns the string representation

type Instance Uses

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 Uses

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*Instance) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (Instance) String Uses

func (s Instance) String() string

String returns the string representation

type KinesisDataStream Uses

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 Uses

func (s KinesisDataStream) GoString() string

GoString returns the string representation

func (*KinesisDataStream) SetArn Uses

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

SetArn sets the Arn field's value.

func (KinesisDataStream) String Uses

func (s KinesisDataStream) String() string

String returns the string representation

type KinesisVideoStream Uses

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 Uses

func (s KinesisVideoStream) GoString() string

GoString returns the string representation

func (*KinesisVideoStream) SetArn Uses

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

SetArn sets the Arn field's value.

func (KinesisVideoStream) String Uses

func (s KinesisVideoStream) String() string

String returns the string representation

type Label Uses

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 Uses

func (s Label) GoString() string

GoString returns the string representation

func (*Label) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Label) SetInstances Uses

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

SetInstances sets the Instances field's value.

func (*Label) SetName Uses

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

SetName sets the Name field's value.

func (*Label) SetParents Uses

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

SetParents sets the Parents field's value.

func (Label) String Uses

func (s Label) String() string

String returns the string representation

type LabelDetection Uses

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 Uses

func (s LabelDetection) GoString() string

GoString returns the string representation

func (*LabelDetection) SetLabel Uses

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

SetLabel sets the Label field's value.

func (*LabelDetection) SetTimestamp Uses

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

SetTimestamp sets the Timestamp field's value.

func (LabelDetection) String Uses

func (s LabelDetection) String() string

String returns the string representation

type Landmark Uses

type Landmark struct {

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

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

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

Indicates the location of the landmark on the face.

func (Landmark) GoString Uses

func (s Landmark) GoString() string

GoString returns the string representation

func (*Landmark) SetType Uses

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

SetType sets the Type field's value.

func (*Landmark) SetX Uses

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

SetX sets the X field's value.

func (*Landmark) SetY Uses

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

SetY sets the Y field's value.

func (Landmark) String Uses

func (s Landmark) String() string

String returns the string representation

type ListCollectionsInput Uses

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 Uses

func (s ListCollectionsInput) GoString() string

GoString returns the string representation

func (*ListCollectionsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListCollectionsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListCollectionsInput) String Uses

func (s ListCollectionsInput) String() string

String returns the string representation

type ListCollectionsOutput Uses

type ListCollectionsOutput struct {

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

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

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

func (ListCollectionsOutput) GoString Uses

func (s ListCollectionsOutput) GoString() string

GoString returns the string representation

func (*ListCollectionsOutput) SetCollectionIds Uses

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

SetCollectionIds sets the CollectionIds field's value.

func (*ListCollectionsOutput) SetFaceModelVersions Uses

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

SetFaceModelVersions sets the FaceModelVersions field's value.

func (*ListCollectionsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListCollectionsOutput) String Uses

func (s ListCollectionsOutput) String() string

String returns the string representation

type ListFacesInput Uses

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 Uses

func (s ListFacesInput) GoString() string

GoString returns the string representation

func (*ListFacesInput) SetCollectionId Uses

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

SetCollectionId sets the CollectionId field's value.

func (*ListFacesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListFacesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListFacesInput) String Uses

func (s ListFacesInput) String() string

String returns the string representation

func (*ListFacesInput) Validate Uses

func (s *ListFacesInput) Validate() error

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

type ListFacesOutput Uses

type ListFacesOutput struct {

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

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

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

func (ListFacesOutput) GoString Uses

func (s ListFacesOutput) GoString() string

GoString returns the string representation

func (*ListFacesOutput) SetFaceModelVersion Uses

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

SetFaceModelVersion sets the FaceModelVersion field's value.

func (*ListFacesOutput) SetFaces Uses

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

SetFaces sets the Faces field's value.

func (*ListFacesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListFacesOutput) String Uses

func (s ListFacesOutput) String() string

String returns the string representation

type ListStreamProcessorsInput Uses

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 Uses

func (s ListStreamProcessorsInput) GoString() string

GoString returns the string representation

func (*ListStreamProcessorsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListStreamProcessorsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListStreamProcessorsInput) String Uses

func (s ListStreamProcessorsInput) String() string

String returns the string representation

func (*ListStreamProcessorsInput) Validate Uses

func (s *ListStreamProcessorsInput) Validate() error

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

type ListStreamProcessorsOutput Uses

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 Uses

func (s ListStreamProcessorsOutput) GoString() string

GoString returns the string representation

func (*ListStreamProcessorsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListStreamProcessorsOutput) SetStreamProcessors Uses

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

SetStreamProcessors sets the StreamProcessors field's value.

func (ListStreamProcessorsOutput) String Uses

func (s ListStreamProcessorsOutput) String() string

String returns the string representation

type ModerationLabel Uses

type ModerationLabel struct {

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

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

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

Provides information about a single type of moderated content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

func (ModerationLabel) GoString Uses

func (s ModerationLabel) GoString() string

GoString returns the string representation

func (*ModerationLabel) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*ModerationLabel) SetName Uses

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

SetName sets the Name field's value.

func (*ModerationLabel) SetParentName Uses

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

SetParentName sets the ParentName field's value.

func (ModerationLabel) String Uses

func (s ModerationLabel) String() string

String returns the string representation

type MouthOpen Uses

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 Uses

func (s MouthOpen) GoString() string

GoString returns the string representation

func (*MouthOpen) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*MouthOpen) SetValue Uses

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

SetValue sets the Value field's value.

func (MouthOpen) String Uses

func (s MouthOpen) String() string

String returns the string representation

type Mustache Uses

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 Uses

func (s Mustache) GoString() string

GoString returns the string representation

func (*Mustache) SetConfidence Uses

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

SetConfidence sets the Confidence field's value.

func (*Mustache) SetValue Uses

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

SetValue sets the Value field's value.

func (Mustache) String Uses

func (s Mustache) String() string

String returns the string representation

type NotificationChannel Uses

type NotificationChannel struct {

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

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

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

func (NotificationChannel) GoString Uses

func (s NotificationChannel) GoString() string

GoString returns the string representation

func (*NotificationChannel) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (*NotificationChannel) SetSNSTopicArn Uses

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

SetSNSTopicArn sets the SNSTopicArn field's value.

func (NotificationChannel) String Uses

func (s NotificationChannel) String() string

String returns the string representation

func (*NotificationChannel) Validate Uses

func (s *NotificationChannel) Validate() error

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

type Parent Uses

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 Uses

func (s Parent) GoString() string

GoString returns the string representation

func (*Parent) SetName Uses

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

SetName sets the Name field's value.

func (Parent) String Uses

func (s Parent) String() string

String returns the string representation

type PersonDetail Uses

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 Uses

func (s PersonDetail) GoString() string

GoString returns the string representation

func (*PersonDetail) SetBoundingBox Uses

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

SetBoundingBox sets the BoundingBox field's value.

func (*PersonDetail) SetFace Uses

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

SetFace sets the Face field's value.

func (*PersonDetail) SetIndex Uses

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

SetIndex sets the Index field's value.

func (PersonDetail) String Uses

func (s PersonDetail) String() string

String returns the string representation

type PersonDetection Uses

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 Uses

func (s PersonDetection) GoString() string

GoString returns the string representation

func (*PersonDetection) SetPerson Uses

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

SetPerson sets the Person field's value.

func (*PersonDetection) SetTimestamp Uses

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

SetTimestamp sets the Timestamp field's value.

func (PersonDetection) String Uses

func (s PersonDetection) String() string

String returns the string representation

type PersonMatch Uses

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 Uses

func (s PersonMatch) GoString() string

GoString returns the string representation

func (*PersonMatch) SetFaceMatches Uses

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

SetFaceMatches sets the FaceMatches field's value.

func (*PersonMatch) SetPerson Uses

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

SetPerson sets the Person field's value.

func (*PersonMatch) SetTimestamp Uses

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

SetTimestamp sets the Timestamp field's value.

func (PersonMatch) String Uses

func (s PersonMatch) String() string

String returns the string representation

type Point Uses

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. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Rekognition Developer Guide.

func (Point) GoString Uses

func (s Point) GoString() string

GoString returns the string representation

func (*Point) SetX Uses

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

SetX sets the X field's value.

func (*Point) SetY Uses

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

SetY sets the Y field's value.

func (Point) String Uses

func (s Point) String() string

String returns the string representation

type Pose Uses

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 Uses

func (s Pose) GoString() string

GoString returns the string representation

func (*Pose) SetPitch Uses

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

SetPitch sets the Pitch field's value.

func (*Pose) SetRoll Uses

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

SetRoll sets the Roll field's value.

func (*Pose) SetYaw Uses

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

SetYaw sets the Yaw field's value.

func (Pose) String Uses

func (s Pose) String() string

String returns the string representation

type RecognizeCelebritiesInput Uses

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 Uses

func (s RecognizeCelebritiesInput) GoString() string

GoString returns the string representation

func (*RecognizeCelebritiesInput) SetImage Uses

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

SetImage sets the Image field's value.

func (RecognizeCelebritiesInput) String Uses

func (s RecognizeCelebritiesInput) String() string

String returns the string representation

func (*RecognizeCelebritiesInput) Validate Uses

func (s *RecognizeCelebritiesInput) Validate() error

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

type RecognizeCelebritiesOutput Uses

type RecognizeCelebritiesOutput struct {

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

    // The orientation of the input image (counterclockwise direction). If your
    // application displays the image, you can use this value to correct the orientation.
    // The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces
    // represent face locations before the image orientation is corrected.
    //
    // If the input image is in .jpeg format, it might contain exchangeable image
    // (Exif) metadata that includes the image's orientation. If so, and the Exif
    // metadata for the input image populates the orientation field, the value of
    // OrientationCorrection is null. 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 Uses

func (s RecognizeCelebritiesOutput) GoString() string

GoString returns the string representation

func (*RecognizeCelebritiesOutput) SetCelebrityFaces Uses

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

SetCelebrityFaces sets the CelebrityFaces field's value.

func (*RecognizeCelebritiesOutput) SetOrientationCorrection Uses

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

SetOrientationCorrection sets the OrientationCorrection field's value.

func (*RecognizeCelebritiesOutput) SetUnrecognizedFaces Uses

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

SetUnrecognizedFaces sets the UnrecognizedFaces field's value.

func (RecognizeCelebritiesOutput) String Uses

func (s RecognizeCelebritiesOutput) String() string

String returns the string representation

type Rekognition Uses

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 Uses

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

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

Example:

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

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

func (*Rekognition) CompareFaces Uses

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

CompareFaces API operation for Amazon Rekognition.

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

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

You pass the input and target images either as base64-encoded image bytes or as 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, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

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

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

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

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

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

For an example, see 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 Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

To compare two images

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

Code:

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)

func (*Rekognition) CompareFacesRequest Uses

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 Uses

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 Uses

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.

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

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

Returned Error Codes:

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

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

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

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

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

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

To create a collection

This operation creates a Rekognition collection for storing image data.

Code:

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

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

fmt.Println(result)

func (*Rekognition) CreateCollectionRequest Uses

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 Uses

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

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

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

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

func (*Rekognition) CreateStreamProcessor Uses

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.

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

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

Returned Error Codes:

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

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

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

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

* ErrCodeResourceInUseException "ResourceInUseException"

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

func (*Rekognition) CreateStreamProcessorRequest Uses

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 Uses

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 Uses

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

DeleteCollection API operation for Amazon Rekognition.

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

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

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

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

Returned Error Codes:

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

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

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

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

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

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

To delete a collection

This operation deletes a Rekognition collection.

Code:

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)

func (*Rekognition) DeleteCollectionRequest Uses

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 Uses

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

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

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

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

func (*Rekognition) DeleteFaces Uses

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

DeleteFaces API operation for Amazon Rekognition.

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

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

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

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

Returned Error Codes:

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

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

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

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

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

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

To delete a face

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

Code:

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)

func (*Rekognition) DeleteFacesRequest Uses

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 Uses

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

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

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

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

func (*Rekognition) DeleteStreamProcessor Uses

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 Codes:

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

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

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

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

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

* ErrCodeResourceInUseException "ResourceInUseException"

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

func (*Rekognition) DeleteStreamProcessorRequest Uses

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 Uses

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 Uses

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 Codes:

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

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

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

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

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

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

func (*Rekognition) DescribeCollectionRequest Uses

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 Uses

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) DescribeStreamProcessor Uses

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 Codes:

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

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

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

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

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

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

func (*Rekognition) DescribeStreamProcessorRequest Uses

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 Uses

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

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

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

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

func (*Rekognition) DetectFaces Uses

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), gender, 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 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 Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

To detect faces in an image

This operation detects faces in an image stored in an AWS S3 bucket.

Code:

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)

func (*Rekognition) DetectFacesRequest Uses

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 Uses

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 Uses

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 Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

To detect labels

This operation detects labels in the supplied image

Code:

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)

func (*Rekognition) DetectLabelsRequest Uses

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 Uses

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 Uses

func (c *Rekognition) DetectModerationLabels(input *DetectModerationLabelsInput) (*DetectModerationLabelsOutput, error)

DetectModerationLabels API operation for Amazon Rekognition.

Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate.

For information about moderation labels, see 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 Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

func (*Rekognition) DetectModerationLabelsRequest Uses

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 Uses

func (c *Rekognition) DetectModerationLabelsWithContext(ctx aws.Context, input *DetectModerationLabelsInput, opts ...request.Option) (*DetectModerationLabelsOutput, error)

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

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

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

func (*Rekognition) DetectText Uses

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 ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image.

A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

To be detected, text must be within +/- 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 Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

func (*Rekognition) DetectTextRequest Uses

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 Uses

func (c *Rekognition) DetectTextWithContext(ctx aws.Context, input *DetectTextInput, opts ...request.Option) (*DetectTextOutput, error)

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

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

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

func (*Rekognition) GetCelebrityInfo Uses

func (c *Rekognition) GetCelebrityInfo(input *GetCelebrityInfoInput) (*GetCelebrityInfoOutput, error)

GetCelebrityInfo API operation for Amazon Rekognition.

Gets the name and additional information about a celebrity based on his or her 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 Codes:

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

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

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

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

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

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

func (*Rekognition) GetCelebrityInfoRequest Uses

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 Uses

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 Uses

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.

GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see 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 Codes:

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

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

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

func (*Rekognition) GetCelebrityRecognitionPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (c *Rekognition) GetContentModeration(input *GetContentModerationInput) (*GetContentModerationOutput, error)

GetContentModeration API operation for Amazon Rekognition.

Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.

Content moderation analysis of a 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 moderation 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 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 Detecting Unsafe Content 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 Codes:

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

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

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

func (*Rekognition) GetContentModerationPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

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

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

func (*Rekognition) GetFaceDetectionPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

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

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

func (*Rekognition) GetFaceSearchPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

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

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

func (*Rekognition) GetLabelDetectionPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

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

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

func (*Rekognition) GetPersonTrackingPages Uses

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 Uses

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 Uses

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 Uses

func (c *Rekognition) GetPersonTrackingWithContext(ctx aws.Context, input *GetPersonTrackingInput, opts ...request.Option) (*GetPersonTrackingOutput, error)

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

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

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

func (*Rekognition) IndexFaces Uses

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 the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. 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. 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.

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 like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the 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 Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

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

To add a face to a collection

This operation detects faces in an image and adds them to the specified Rekognition collection.

Code:

svc := rekognition.New(session.New())
input := &rekognition.IndexFacesInput{
    CollectionId:    aws.String("myphotos"),
    ExternalImageId: aws.String("myphotoid"),
    Image: &rekognition.Image{
        S3Object: &rekognition.S3Object{
            Bucket: aws.String("mybucket"),
            Name:   aws.String("myphoto"),
        },
    },
}

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

fmt.Println(result)

func (*Rekognition) IndexFacesRequest Uses

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 Uses

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 Uses

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 Codes:

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

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

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

To list the collections

This operation returns a list of Rekognition collections.

Code:

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)

func (*Rekognition) ListCollectionsPages Uses

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 Uses

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 Uses

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 Uses

func (c *Rekognition) ListCollectionsWithContext(ctx aws.Context, input *ListCollectionsInput, opts ...request.Option) (*ListCollectionsOutput, error)

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

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

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

func (*Rekognition) ListFaces Uses

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 Codes:

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

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

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

To list the faces in a collection

This operation lists the faces in a Rekognition collection.

Code:

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)

func (*Rekognition) ListFacesPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

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

* ErrCodeInvalidPaginationTokenException "InvalidPaginationTokenException"
Pagination token in the request is not valid.

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

func (*Rekognition) ListStreamProcessorsPages Uses

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 Uses

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 Uses

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 Uses

func (c *Rekognition) ListStreamProcessorsWithContext(ctx aws.Context, input *ListStreamProcessorsInput, opts ...request.Option) (*ListStreamProcessorsOutput, error)

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

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

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

func (*Rekognition) RecognizeCelebrities Uses

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 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 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 Codes:

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

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

func (*Rekognition) RecognizeCelebritiesRequest Uses

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 Uses

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 Uses

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 Codes:

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

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

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

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

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

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

To delete a face

This operation searches for matching faces in the collection the supplied face belongs to.

Code:

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)

func (*Rekognition) SearchFacesByImage Uses

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.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

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

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

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

Returned Error Codes:

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

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

* ErrCodeImageTooLargeException "ImageTooLargeException"
The input image size exceeds the allowed limit. For more information, see
Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

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

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

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

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

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

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.

Code:

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)

func (*Rekognition) SearchFacesByImageRequest Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
A ClientRequestToken input parameter was reused with an operation, but at
least one of the other input parameters is different from the previous call
to the operation.

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

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

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

* ErrCodeVideoTooLargeException "VideoTooLargeException"
The file size or duration of the supplied media is too large. The maximum
file size is 8GB. The maximum duration is 2 hours.

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

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

func (*Rekognition) StartCelebrityRecognitionRequest Uses

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 Uses

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 Uses

func (c *Rekognition) StartContentModeration(input *StartContentModerationInput) (*StartContentModerationOutput, error)

StartContentModeration API operation for Amazon Rekognition.

Starts asynchronous detection of explicit or suggestive adult content in a stored video.

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 moderation 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 moderation 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 Detecting Unsafe Content 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 Codes:

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

* ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
A ClientRequestToken input parameter was reused with an operation, but at
least one of the other input parameters is different from the previous call
to the operation.

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

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

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

* ErrCodeVideoTooLargeException "VideoTooLargeException"
The file size or duration of the supplied media is too large. The maximum
file size is 8GB. The maximum duration is 2 hours.

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

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

func (*Rekognition) StartContentModerationRequest Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
A ClientRequestToken input parameter was reused with an operation, but at
least one of the other input parameters is different from the previous call
to the operation.

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

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

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

* ErrCodeVideoTooLargeException "VideoTooLargeException"
The file size or duration of the supplied media is too large. The maximum
file size is 8GB. The maximum duration is 2 hours.

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

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

func (*Rekognition) StartFaceDetectionRequest Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
A ClientRequestToken input parameter was reused with an operation, but at
least one of the other input parameters is different from the previous call
to the operation.

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

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

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

* ErrCodeVideoTooLargeException "VideoTooLargeException"
The file size or duration of the supplied media is too large. The maximum
file size is 8GB. The maximum duration is 2 hours.

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

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

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

func (*Rekognition) StartFaceSearchRequest Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
A ClientRequestToken input parameter was reused with an operation, but at
least one of the other input parameters is different from the previous call
to the operation.

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

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

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

* ErrCodeVideoTooLargeException "VideoTooLargeException"
The file size or duration of the supplied media is too large. The maximum
file size is 8GB. The maximum duration is 2 hours.

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

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

func (*Rekognition) StartLabelDetectionRequest Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
A ClientRequestToken input parameter was reused with an operation, but at
least one of the other input parameters is different from the previous call
to the operation.

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

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

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

* ErrCodeVideoTooLargeException "VideoTooLargeException"
The file size or duration of the supplied media is too large. The maximum
file size is 8GB. The maximum duration is 2 hours.

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

* ErrCodeLimitExceededException "LimitExceededException"
An Amazon Rekognition service limit was exceeded. For example, if you start
too many 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.

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

func (*Rekognition) StartPersonTrackingRequest Uses

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 Uses

func (c *Rekognition) StartPersonTrackingWithContext(ctx aws.Context, input *StartPersonTrackingInput, opts ...request.Option) (*StartPersonTrackingOutput, error)

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

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

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

func (*Rekognition) StartStreamProcessor Uses

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 Codes:

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

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

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

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

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

* ErrCodeResourceInUseException "ResourceInUseException"

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

func (*Rekognition) StartStreamProcessorRequest Uses

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 Uses

func (c *Rekognition) StartStreamProcessorWithContext(ctx aws.Context, input *StartStreamProcessorInput, opts ...request.Option) (*StartStreamProcessorOutput, error)

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

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

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

func (*Rekognition) StopStreamProcessor Uses

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 Codes:

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

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

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

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

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

* ErrCodeResourceInUseException "ResourceInUseException"

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

func (*Rekognition) StopStreamProcessorRequest Uses

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 Uses

func (c *Rekognition) StopStreamProcessorWithContext(ctx aws.Context, input *StopStreamProcessorInput, opts ...request.Option) (*StopStreamProcessorOutput, error)

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

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

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

type S3Object Uses

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 Uses

func (s S3Object) GoString() string

GoString returns the string representation

func (*S3Object) SetBucket Uses

func (s *S3Object) SetBucket(v string) *S3Object

SetBucket sets the Bucket field's value.

func (*S3Object) SetName Uses

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

SetName sets the Name field's value.

func (*S3Object) SetVersion Uses

func (s *S3Object) SetVersion(v string) *S3Object

SetVersion sets the Version field's value.

func (S3Object) String Uses

func (s S3Object) String() string

String returns the string representation

func (*S3Object) Validate Uses

func (s *S3Object) Validate() error

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

type SearchFacesByImageInput Uses

type SearchFacesByImageInput struct {

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

    // (Optional) Specifies the minimum confidence in the face match to return.
    // For example, don't return any matches where confidence in matches is less
    // than 70%.
    FaceMatchThreshold *float64 `type:"float"`

    // The input image as base64-encoded bytes or an S3 object. If you use the AWS
    // CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
    // is not supported.
    //
    // 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"`
    // contains filtered or unexported fields
}

func (SearchFacesByImageInput)