rekognition

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 37

Documentation

Overview

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

This is the Amazon Rekognition API reference.

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

Using the Client

To use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/rekognition/#New

Index

Examples

Constants

View Source 
const (
	ServiceName = "Amazon Rekognition" // Service's name
	ServiceID   = "Rekognition"        // Service's identifier
	EndpointsID = "rekognition"        // Service's Endpoint identifier
)
View Source 
const (

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

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

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

	// ErrCodeImageTooLargeException for service response error code
	// "ImageTooLargeException".
	//
	// The input image size exceeds the allowed limit. 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".
	//
	// The specified resource is already being used.
	ErrCodeResourceInUseException = "ResourceInUseException"

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

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

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

	// ErrCodeVideoTooLargeException for service response error code
	// "VideoTooLargeException".
	//
	// The file size or duration of the supplied media is too large. The maximum
	// file size is 10GB. The maximum duration is 6 hours.
	ErrCodeVideoTooLargeException = "VideoTooLargeException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AgeRange 

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) String 

func (s AgeRange) String() string

String returns the string representation

type Asset added in v0.18.0 

type Asset struct {

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

Assets are the images that you use to train and evaluate a model version. Assets are referenced by Sagemaker GroundTruth manifest files.

func (Asset) String added in v0.18.0 

func (s Asset) String() string

String returns the string representation

func (*Asset) Validate added in v0.18.0 

func (s *Asset) Validate() error

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

type Attribute 

type Attribute string
const (
	AttributeDefault Attribute = "DEFAULT"
	AttributeAll     Attribute = "ALL"
)

Enum values for Attribute

func (Attribute) MarshalValue added in v0.3.0 

func (enum Attribute) MarshalValue() (string, error)

func (Attribute) MarshalValueBuf added in v0.3.0 

func (enum Attribute) MarshalValueBuf(b []byte) ([]byte, error)

type AudioMetadata added in v0.24.0 

type AudioMetadata struct {

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

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

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

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

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

func (AudioMetadata) String added in v0.24.0 

func (s AudioMetadata) String() string

String returns the string representation

type Beard 

type Beard struct {

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

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

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

func (Beard) String 

func (s Beard) String() string

String returns the string representation

type BoundingBox 

type BoundingBox struct {

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

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

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

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

Identifies the bounding box around the 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) String 

func (s BoundingBox) String() string

String returns the string representation

type Celebrity 

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) String 

func (s Celebrity) String() string

String returns the string representation

type CelebrityDetail added in v0.2.0 

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) String added in v0.2.0 

func (s CelebrityDetail) String() string

String returns the string representation

type CelebrityRecognition added in v0.2.0 

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) String added in v0.2.0 

func (s CelebrityRecognition) String() string

String returns the string representation

type CelebrityRecognitionSortBy added in v0.2.0 

type CelebrityRecognitionSortBy string
const (
	CelebrityRecognitionSortById        CelebrityRecognitionSortBy = "ID"
	CelebrityRecognitionSortByTimestamp CelebrityRecognitionSortBy = "TIMESTAMP"
)

Enum values for CelebrityRecognitionSortBy

func (CelebrityRecognitionSortBy) MarshalValue added in v0.3.0 

func (enum CelebrityRecognitionSortBy) MarshalValue() (string, error)

func (CelebrityRecognitionSortBy) MarshalValueBuf added in v0.3.0 

func (enum CelebrityRecognitionSortBy) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := rekognition.New(myConfig)

func (*Client) CompareFacesRequest added in v0.9.0 

func (c *Client) CompareFacesRequest(input *CompareFacesInput) CompareFacesRequest

CompareFacesRequest returns a request value for making 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.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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. 

// Example sending a request using CompareFacesRequest.
req := client.CompareFacesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To compare two images

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

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	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"),
			},
		},
	}

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

	fmt.Println(result)
}

Output:

func (*Client) CreateCollectionRequest added in v0.9.0 

func (c *Client) CreateCollectionRequest(input *CreateCollectionInput) CreateCollectionRequest

CreateCollectionRequest returns a request value for making 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. 

// Example sending a request using CreateCollectionRequest.
req := client.CreateCollectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To create a collection

This operation creates a Rekognition collection for storing image data. 

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

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

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

	fmt.Println(result)
}

Output:

func (*Client) CreateProjectRequest added in v0.18.0 

func (c *Client) CreateProjectRequest(input *CreateProjectInput) CreateProjectRequest

CreateProjectRequest returns a request value for making API operation for Amazon Rekognition.

Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) and operations (training, evaluation and detection).

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

// Example sending a request using CreateProjectRequest.
req := client.CreateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) CreateProjectVersionRequest added in v0.18.0 

func (c *Client) CreateProjectVersionRequest(input *CreateProjectVersionInput) CreateProjectVersionRequest

CreateProjectVersionRequest returns a request value for making API operation for Amazon Rekognition.

Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify one training dataset and one testing dataset. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

After evaluating the model, you start the model by calling StartProjectVersion.

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

// Example sending a request using CreateProjectVersionRequest.
req := client.CreateProjectVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) CreateStreamProcessorRequest added in v0.9.0 

func (c *Client) CreateStreamProcessorRequest(input *CreateStreamProcessorInput) CreateStreamProcessorRequest

CreateStreamProcessorRequest returns a request value for making 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. 

// Example sending a request using CreateStreamProcessorRequest.
req := client.CreateStreamProcessorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DeleteCollectionRequest added in v0.9.0 

func (c *Client) DeleteCollectionRequest(input *DeleteCollectionInput) DeleteCollectionRequest

DeleteCollectionRequest returns a request value for making 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. 

// Example sending a request using DeleteCollectionRequest.
req := client.DeleteCollectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To delete a collection

This operation deletes a Rekognition collection. 

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

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

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

	fmt.Println(result)
}

Output:

func (*Client) DeleteFacesRequest added in v0.9.0 

func (c *Client) DeleteFacesRequest(input *DeleteFacesInput) DeleteFacesRequest

DeleteFacesRequest returns a request value for making 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. 

// Example sending a request using DeleteFacesRequest.
req := client.DeleteFacesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To delete a face

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

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

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

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

	fmt.Println(result)
}

Output:

func (*Client) DeleteProjectRequest added in v0.21.0 

func (c *Client) DeleteProjectRequest(input *DeleteProjectInput) DeleteProjectRequest

DeleteProjectRequest returns a request value for making API operation for Amazon Rekognition.

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.

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

// Example sending a request using DeleteProjectRequest.
req := client.DeleteProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DeleteProjectVersionRequest added in v0.21.0 

func (c *Client) DeleteProjectVersionRequest(input *DeleteProjectVersionInput) DeleteProjectVersionRequest

DeleteProjectVersionRequest returns a request value for making API operation for Amazon Rekognition.

Deletes an Amazon Rekognition Custom Labels model.

You can't delete a model if it is running or if it is training. To check the status of a model, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. If the model is training, wait until it finishes.

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

// Example sending a request using DeleteProjectVersionRequest.
req := client.DeleteProjectVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DeleteStreamProcessorRequest added in v0.9.0 

func (c *Client) DeleteStreamProcessorRequest(input *DeleteStreamProcessorInput) DeleteStreamProcessorRequest

DeleteStreamProcessorRequest returns a request value for making 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. 

// Example sending a request using DeleteStreamProcessorRequest.
req := client.DeleteStreamProcessorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DescribeCollectionRequest added in v0.9.0 

func (c *Client) DescribeCollectionRequest(input *DescribeCollectionInput) DescribeCollectionRequest

DescribeCollectionRequest returns a request value for making 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. 

// Example sending a request using DescribeCollectionRequest.
req := client.DescribeCollectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DescribeProjectVersionsRequest added in v0.18.0 

func (c *Client) DescribeProjectVersionsRequest(input *DescribeProjectVersionsInput) DescribeProjectVersionsRequest

DescribeProjectVersionsRequest returns a request value for making API operation for Amazon Rekognition.

Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all models are returned.

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

// Example sending a request using DescribeProjectVersionsRequest.
req := client.DescribeProjectVersionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DescribeProjectsRequest added in v0.18.0 

func (c *Client) DescribeProjectsRequest(input *DescribeProjectsInput) DescribeProjectsRequest

DescribeProjectsRequest returns a request value for making API operation for Amazon Rekognition.

Lists and gets information about your Amazon Rekognition Custom Labels projects.

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

// Example sending a request using DescribeProjectsRequest.
req := client.DescribeProjectsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DescribeStreamProcessorRequest added in v0.9.0 

func (c *Client) DescribeStreamProcessorRequest(input *DescribeStreamProcessorInput) DescribeStreamProcessorRequest

DescribeStreamProcessorRequest returns a request value for making 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. 

// Example sending a request using DescribeStreamProcessorRequest.
req := client.DescribeStreamProcessorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DetectCustomLabelsRequest added in v0.18.0 

func (c *Client) DetectCustomLabelsRequest(input *DetectCustomLabelsInput) DetectCustomLabelsRequest

DetectCustomLabelsRequest returns a request value for making API operation for Amazon Rekognition.

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

You specify which version of a model version to use by using the ProjectVersionArn input parameter.

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

For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry).

During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn't return labels whose confidence value is below the model's calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model's calculated threshold. You can get the model's calculated threshold from the model's training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0.

You can also add the MaxResults parameter to limit the number of labels returned.

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

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

// Example sending a request using DetectCustomLabelsRequest.
req := client.DetectCustomLabelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DetectFacesRequest added in v0.9.0 

func (c *Client) DetectFacesRequest(input *DetectFacesInput) DetectFacesRequest

DetectFacesRequest returns a request value for making API operation for Amazon Rekognition.

Detects faces within an image that is provided as input.

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

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

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

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

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

// Example sending a request using DetectFacesRequest.
req := client.DetectFacesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To detect faces in an image

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

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	input := &rekognition.DetectFacesInput{
		Image: &rekognition.Image{
			S3Object: &rekognition.S3Object{
				Bucket: aws.String("mybucket"),
				Name:   aws.String("myphoto"),
			},
		},
	}

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

	fmt.Println(result)
}

Output:

func (*Client) DetectLabelsRequest added in v0.9.0 

func (c *Client) DetectLabelsRequest(input *DetectLabelsInput) DetectLabelsRequest

DetectLabelsRequest returns a request value for making 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. 

// Example sending a request using DetectLabelsRequest.
req := client.DetectLabelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To detect labels

This operation detects labels in the supplied image 

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	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),
	}

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

	fmt.Println(result)
}

Output:

func (*Client) DetectModerationLabelsRequest added in v0.9.0 

func (c *Client) DetectModerationLabelsRequest(input *DetectModerationLabelsInput) DetectModerationLabelsRequest

DetectModerationLabelsRequest returns a request value for making API operation for Amazon Rekognition.

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

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

For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

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

// Example sending a request using DetectModerationLabelsRequest.
req := client.DetectModerationLabelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) DetectTextRequest added in v0.9.0 

func (c *Client) DetectTextRequest(input *DetectTextInput) DetectTextRequest

DetectTextRequest returns a request value for making 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. 

// Example sending a request using DetectTextRequest.
req := client.DetectTextRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetCelebrityInfoRequest added in v0.9.0 

func (c *Client) GetCelebrityInfoRequest(input *GetCelebrityInfoInput) GetCelebrityInfoRequest

GetCelebrityInfoRequest returns a request value for making 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. 

// Example sending a request using GetCelebrityInfoRequest.
req := client.GetCelebrityInfoRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetCelebrityRecognitionRequest added in v0.9.0 

func (c *Client) GetCelebrityRecognitionRequest(input *GetCelebrityRecognitionInput) GetCelebrityRecognitionRequest

GetCelebrityRecognitionRequest returns a request value for making 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. 

// Example sending a request using GetCelebrityRecognitionRequest.
req := client.GetCelebrityRecognitionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetContentModerationRequest added in v0.9.0 

func (c *Client) GetContentModerationRequest(input *GetContentModerationInput) GetContentModerationRequest

GetContentModerationRequest returns a request value for making API operation for Amazon Rekognition.

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

Unsafe content 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 unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

GetContentModeration returns detected unsafe content 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. 

// Example sending a request using GetContentModerationRequest.
req := client.GetContentModerationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetFaceDetectionRequest added in v0.9.0 

func (c *Client) GetFaceDetectionRequest(input *GetFaceDetectionInput) GetFaceDetectionRequest

GetFaceDetectionRequest returns a request value for making 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. 

// Example sending a request using GetFaceDetectionRequest.
req := client.GetFaceDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetFaceSearchRequest added in v0.9.0 

func (c *Client) GetFaceSearchRequest(input *GetFaceSearchInput) GetFaceSearchRequest

GetFaceSearchRequest returns a request value for making 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. 

// Example sending a request using GetFaceSearchRequest.
req := client.GetFaceSearchRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetLabelDetectionRequest added in v0.9.0 

func (c *Client) GetLabelDetectionRequest(input *GetLabelDetectionInput) GetLabelDetectionRequest

GetLabelDetectionRequest returns a request value for making 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. 

// Example sending a request using GetLabelDetectionRequest.
req := client.GetLabelDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetPersonTrackingRequest added in v0.9.0 

func (c *Client) GetPersonTrackingRequest(input *GetPersonTrackingInput) GetPersonTrackingRequest

GetPersonTrackingRequest returns a request value for making 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. 

// Example sending a request using GetPersonTrackingRequest.
req := client.GetPersonTrackingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetSegmentDetectionRequest added in v0.24.0 

func (c *Client) GetSegmentDetectionRequest(input *GetSegmentDetectionInput) GetSegmentDetectionRequest

GetSegmentDetectionRequest returns a request value for making API operation for Amazon Rekognition.

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.

GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide. 

// Example sending a request using GetSegmentDetectionRequest.
req := client.GetSegmentDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetTextDetectionRequest added in v0.20.0 

func (c *Client) GetTextDetectionRequest(input *GetTextDetectionInput) GetTextDetectionRequest

GetTextDetectionRequest returns a request value for making API operation for Amazon Rekognition.

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.

GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.

Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.

Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection. 

// Example sending a request using GetTextDetectionRequest.
req := client.GetTextDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) IndexFacesRequest added in v0.9.0 

func (c *Client) IndexFacesRequest(input *IndexFacesInput) IndexFacesRequest

IndexFacesRequest returns a request value for making API operation for Amazon Rekognition.

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.

For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.

To get the number of faces in a collection, call DescribeCollection.

If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.

If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:

  • The number of faces detected exceeds the value of the MaxFaces request parameter.

  • The face is too small compared to the image dimensions.

  • The face is too blurry.

  • The image is too dark.

  • The face has an extreme pose.

  • The face doesn’t have enough detail to be suitable for face search.

In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

  • The bounding box, BoundingBox, of the detected face.

  • A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.

  • A face ID, FaceId, assigned by the service for each face that's detected and stored.

  • An image ID, ImageId, assigned by the service for the input image.

If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, 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. 

// Example sending a request using IndexFacesRequest.
req := client.IndexFacesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To add a face to a collection

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

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	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"),
			},
		},
	}

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

	fmt.Println(result)
}

Output:

func (*Client) ListCollectionsRequest added in v0.9.0 

func (c *Client) ListCollectionsRequest(input *ListCollectionsInput) ListCollectionsRequest

ListCollectionsRequest returns a request value for making 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. 

// Example sending a request using ListCollectionsRequest.
req := client.ListCollectionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To list the collections

This operation returns a list of Rekognition collections. 

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	input := &rekognition.ListCollectionsInput{}

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

	fmt.Println(result)
}

Output:

func (*Client) ListFacesRequest added in v0.9.0 

func (c *Client) ListFacesRequest(input *ListFacesInput) ListFacesRequest

ListFacesRequest returns a request value for making 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. 

// Example sending a request using ListFacesRequest.
req := client.ListFacesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To list the faces in a collection

This operation lists the faces in a Rekognition collection. 

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	input := &rekognition.ListFacesInput{
		CollectionId: aws.String("myphotos"),
		MaxResults:   aws.Int64(20),
	}

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

	fmt.Println(result)
}

Output:

func (*Client) ListStreamProcessorsRequest added in v0.9.0 

func (c *Client) ListStreamProcessorsRequest(input *ListStreamProcessorsInput) ListStreamProcessorsRequest

ListStreamProcessorsRequest returns a request value for making API operation for Amazon Rekognition.

Gets a list of stream processors that you have created with CreateStreamProcessor. 

// Example sending a request using ListStreamProcessorsRequest.
req := client.ListStreamProcessorsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) RecognizeCelebritiesRequest added in v0.9.0 

func (c *Client) RecognizeCelebritiesRequest(input *RecognizeCelebritiesInput) RecognizeCelebritiesRequest

RecognizeCelebritiesRequest returns a request value for making 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. 

// Example sending a request using RecognizeCelebritiesRequest.
req := client.RecognizeCelebritiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) SearchFacesByImageRequest added in v0.9.0 

func (c *Client) SearchFacesByImageRequest(input *SearchFacesByImageInput) SearchFacesByImageRequest

SearchFacesByImageRequest returns a request value for making 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.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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

// Example sending a request using SearchFacesByImageRequest.
req := client.SearchFacesByImageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To search for faces matching a supplied image

This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image. 

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	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),
	}

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

	fmt.Println(result)
}

Output:

func (*Client) SearchFacesRequest added in v0.9.0 

func (c *Client) SearchFacesRequest(input *SearchFacesInput) SearchFacesRequest

SearchFacesRequest returns a request value for making 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. 

// Example sending a request using SearchFacesRequest.
req := client.SearchFacesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}
Example (Shared00)

To delete a face

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

package main

import (
	"context"
	"fmt"

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

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := rekognition.New(cfg)
	input := &rekognition.SearchFacesInput{
		CollectionId:       aws.String("myphotos"),
		FaceId:             aws.String("70008e50-75e4-55d0-8e80-363fb73b3a14"),
		FaceMatchThreshold: aws.Float64(90.000000),
		MaxFaces:           aws.Int64(10),
	}

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

	fmt.Println(result)
}

Output:

func (*Client) StartCelebrityRecognitionRequest added in v0.9.0 

func (c *Client) StartCelebrityRecognitionRequest(input *StartCelebrityRecognitionInput) StartCelebrityRecognitionRequest

StartCelebrityRecognitionRequest returns a request value for making 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. 

// Example sending a request using StartCelebrityRecognitionRequest.
req := client.StartCelebrityRecognitionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartContentModerationRequest added in v0.9.0 

func (c *Client) StartContentModerationRequest(input *StartContentModerationInput) StartContentModerationRequest

StartContentModerationRequest returns a request value for making API operation for Amazon Rekognition.

Starts asynchronous detection of unsafe 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 unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. 

// Example sending a request using StartContentModerationRequest.
req := client.StartContentModerationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartFaceDetectionRequest added in v0.9.0 

func (c *Client) StartFaceDetectionRequest(input *StartFaceDetectionInput) StartFaceDetectionRequest

StartFaceDetectionRequest returns a request value for making 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. 

// Example sending a request using StartFaceDetectionRequest.
req := client.StartFaceDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartFaceSearchRequest added in v0.9.0 

func (c *Client) StartFaceSearchRequest(input *StartFaceSearchInput) StartFaceSearchRequest

StartFaceSearchRequest returns a request value for making 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. 

// Example sending a request using StartFaceSearchRequest.
req := client.StartFaceSearchRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartLabelDetectionRequest added in v0.9.0 

func (c *Client) StartLabelDetectionRequest(input *StartLabelDetectionInput) StartLabelDetectionRequest

StartLabelDetectionRequest returns a request value for making 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. 

// Example sending a request using StartLabelDetectionRequest.
req := client.StartLabelDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartPersonTrackingRequest added in v0.9.0 

func (c *Client) StartPersonTrackingRequest(input *StartPersonTrackingInput) StartPersonTrackingRequest

StartPersonTrackingRequest returns a request value for making 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. 

// Example sending a request using StartPersonTrackingRequest.
req := client.StartPersonTrackingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartProjectVersionRequest added in v0.18.0 

func (c *Client) StartProjectVersionRequest(input *StartProjectVersionInput) StartProjectVersionRequest

StartProjectVersionRequest returns a request value for making API operation for Amazon Rekognition.

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

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

// Example sending a request using StartProjectVersionRequest.
req := client.StartProjectVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartSegmentDetectionRequest added in v0.24.0 

func (c *Client) StartSegmentDetectionRequest(input *StartSegmentDetectionInput) StartSegmentDetectionRequest

StartSegmentDetectionRequest returns a request value for making API operation for Amazon Rekognition.

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide. 

// Example sending a request using StartSegmentDetectionRequest.
req := client.StartSegmentDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartStreamProcessorRequest added in v0.9.0 

func (c *Client) StartStreamProcessorRequest(input *StartStreamProcessorInput) StartStreamProcessorRequest

StartStreamProcessorRequest returns a request value for making 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. 

// Example sending a request using StartStreamProcessorRequest.
req := client.StartStreamProcessorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StartTextDetectionRequest added in v0.20.0 

func (c *Client) StartTextDetectionRequest(input *StartTextDetectionInput) StartTextDetectionRequest

StartTextDetectionRequest returns a request value for making API operation for Amazon Rekognition.

Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection. 

// Example sending a request using StartTextDetectionRequest.
req := client.StartTextDetectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StopProjectVersionRequest added in v0.18.0 

func (c *Client) StopProjectVersionRequest(input *StopProjectVersionInput) StopProjectVersionRequest

StopProjectVersionRequest returns a request value for making API operation for Amazon Rekognition.

Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. 

// Example sending a request using StopProjectVersionRequest.
req := client.StopProjectVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) StopStreamProcessorRequest added in v0.9.0 

func (c *Client) StopStreamProcessorRequest(input *StopStreamProcessorInput) StopStreamProcessorRequest

StopStreamProcessorRequest returns a request value for making API operation for Amazon Rekognition.

Stops a running stream processor that was created by CreateStreamProcessor. 

// Example sending a request using StopStreamProcessorRequest.
req := client.StopStreamProcessorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) WaitUntilProjectVersionRunning added in v0.18.0 

func (c *Client) WaitUntilProjectVersionRunning(ctx context.Context, input *DescribeProjectVersionsInput, opts ...aws.WaiterOption) error

WaitUntilProjectVersionRunning uses the Amazon Rekognition API operation DescribeProjectVersions to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 (*Client) WaitUntilProjectVersionTrainingCompleted added in v0.18.0 

func (c *Client) WaitUntilProjectVersionTrainingCompleted(ctx context.Context, input *DescribeProjectVersionsInput, opts ...aws.WaiterOption) error

WaitUntilProjectVersionTrainingCompleted uses the Amazon Rekognition API operation DescribeProjectVersions to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 CompareFacesInput 

type CompareFacesInput struct {

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

	// 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) String 

func (s CompareFacesInput) String() string

String returns the string representation

func (*CompareFacesInput) Validate 

func (s *CompareFacesInput) Validate() error

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

type CompareFacesMatch 

type CompareFacesMatch struct {

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

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

Provides information about a face in a target image that matches the source image face 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) String 

func (s CompareFacesMatch) String() string

String returns the string representation

type CompareFacesOutput 

type CompareFacesOutput struct {

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

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

	// The 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 OrientationCorrection `type:"string" enum:"true"`

	// 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 OrientationCorrection `type:"string" enum:"true"`

	// 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) String 

func (s CompareFacesOutput) String() string

String returns the string representation

type CompareFacesRequest 

type CompareFacesRequest struct {
	*aws.Request
	Input *CompareFacesInput
	Copy  func(*CompareFacesInput) CompareFacesRequest
}

CompareFacesRequest is the request type for the CompareFaces API operation.

func (CompareFacesRequest) Send 

func (r CompareFacesRequest) Send(ctx context.Context) (*CompareFacesResponse, error)

Send marshals and sends the CompareFaces API request.

type CompareFacesResponse added in v0.9.0 

type CompareFacesResponse struct {
	*CompareFacesOutput
	// contains filtered or unexported fields
}

CompareFacesResponse is the response type for the CompareFaces API operation.

func (*CompareFacesResponse) SDKResponseMetdata added in v0.9.0 

func (r *CompareFacesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CompareFaces request.

type ComparedFace 

type ComparedFace struct {

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

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

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

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

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

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

func (ComparedFace) String 

func (s ComparedFace) String() string

String returns the string representation

type ComparedSourceImageFace 

type ComparedSourceImageFace struct {

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

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

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

func (ComparedSourceImageFace) String 

func (s ComparedSourceImageFace) String() string

String returns the string representation

type ContentClassifier added in v0.18.0 

type ContentClassifier string
const (
	ContentClassifierFreeOfPersonallyIdentifiableInformation ContentClassifier = "FreeOfPersonallyIdentifiableInformation"
	ContentClassifierFreeOfAdultContent                      ContentClassifier = "FreeOfAdultContent"
)

Enum values for ContentClassifier

func (ContentClassifier) MarshalValue added in v0.18.0 

func (enum ContentClassifier) MarshalValue() (string, error)

func (ContentClassifier) MarshalValueBuf added in v0.18.0 

func (enum ContentClassifier) MarshalValueBuf(b []byte) ([]byte, error)

type ContentModerationDetection added in v0.2.0 

type ContentModerationDetection struct {

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

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

Information about an unsafe content label detection in a stored video.

func (ContentModerationDetection) String added in v0.2.0 

func (s ContentModerationDetection) String() string

String returns the string representation

type ContentModerationSortBy added in v0.2.0 

type ContentModerationSortBy string
const (
	ContentModerationSortByName      ContentModerationSortBy = "NAME"
	ContentModerationSortByTimestamp ContentModerationSortBy = "TIMESTAMP"
)

Enum values for ContentModerationSortBy

func (ContentModerationSortBy) MarshalValue added in v0.3.0 

func (enum ContentModerationSortBy) MarshalValue() (string, error)

func (ContentModerationSortBy) MarshalValueBuf added in v0.3.0 

func (enum ContentModerationSortBy) MarshalValueBuf(b []byte) ([]byte, error)

type CreateCollectionInput 

type CreateCollectionInput struct {

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

func (CreateCollectionInput) String 

func (s CreateCollectionInput) String() string

String returns the string representation

func (*CreateCollectionInput) Validate 

func (s *CreateCollectionInput) Validate() error

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

type CreateCollectionOutput 

type CreateCollectionOutput struct {

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

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

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

func (CreateCollectionOutput) String 

func (s CreateCollectionOutput) String() string

String returns the string representation

type CreateCollectionRequest 

type CreateCollectionRequest struct {
	*aws.Request
	Input *CreateCollectionInput
	Copy  func(*CreateCollectionInput) CreateCollectionRequest
}

CreateCollectionRequest is the request type for the CreateCollection API operation.

func (CreateCollectionRequest) Send 

func (r CreateCollectionRequest) Send(ctx context.Context) (*CreateCollectionResponse, error)

Send marshals and sends the CreateCollection API request.

type CreateCollectionResponse added in v0.9.0 

type CreateCollectionResponse struct {
	*CreateCollectionOutput
	// contains filtered or unexported fields
}

CreateCollectionResponse is the response type for the CreateCollection API operation.

func (*CreateCollectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateCollectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCollection request.

type CreateProjectInput added in v0.18.0 

type CreateProjectInput struct {

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

func (CreateProjectInput) String added in v0.18.0 

func (s CreateProjectInput) String() string

String returns the string representation

func (*CreateProjectInput) Validate added in v0.18.0 

func (s *CreateProjectInput) Validate() error

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

type CreateProjectOutput added in v0.18.0 

type CreateProjectOutput struct {

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

func (CreateProjectOutput) String added in v0.18.0 

func (s CreateProjectOutput) String() string

String returns the string representation

type CreateProjectRequest added in v0.18.0 

type CreateProjectRequest struct {
	*aws.Request
	Input *CreateProjectInput
	Copy  func(*CreateProjectInput) CreateProjectRequest
}

CreateProjectRequest is the request type for the CreateProject API operation.

func (CreateProjectRequest) Send added in v0.18.0 

func (r CreateProjectRequest) Send(ctx context.Context) (*CreateProjectResponse, error)

Send marshals and sends the CreateProject API request.

type CreateProjectResponse added in v0.18.0 

type CreateProjectResponse struct {
	*CreateProjectOutput
	// contains filtered or unexported fields
}

CreateProjectResponse is the response type for the CreateProject API operation.

func (*CreateProjectResponse) SDKResponseMetdata added in v0.18.0 

func (r *CreateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProject request.

type CreateProjectVersionInput added in v0.18.0 

type CreateProjectVersionInput struct {

	// The Amazon S3 location to store the results of training.
	//
	// OutputConfig is a required field
	OutputConfig *OutputConfig `type:"structure" required:"true"`

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

	// The dataset to use for testing.
	//
	// TestingData is a required field
	TestingData *TestingData `type:"structure" required:"true"`

	// The dataset to use for training.
	//
	// TrainingData is a required field
	TrainingData *TrainingData `type:"structure" required:"true"`

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

func (CreateProjectVersionInput) String added in v0.18.0 

func (s CreateProjectVersionInput) String() string

String returns the string representation

func (*CreateProjectVersionInput) Validate added in v0.18.0 

func (s *CreateProjectVersionInput) Validate() error

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

type CreateProjectVersionOutput added in v0.18.0 

type CreateProjectVersionOutput struct {

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

func (CreateProjectVersionOutput) String added in v0.18.0 

func (s CreateProjectVersionOutput) String() string

String returns the string representation

type CreateProjectVersionRequest added in v0.18.0 

type CreateProjectVersionRequest struct {
	*aws.Request
	Input *CreateProjectVersionInput
	Copy  func(*CreateProjectVersionInput) CreateProjectVersionRequest
}

CreateProjectVersionRequest is the request type for the CreateProjectVersion API operation.

func (CreateProjectVersionRequest) Send added in v0.18.0 

func (r CreateProjectVersionRequest) Send(ctx context.Context) (*CreateProjectVersionResponse, error)

Send marshals and sends the CreateProjectVersion API request.

type CreateProjectVersionResponse added in v0.18.0 

type CreateProjectVersionResponse struct {
	*CreateProjectVersionOutput
	// contains filtered or unexported fields
}

CreateProjectVersionResponse is the response type for the CreateProjectVersion API operation.

func (*CreateProjectVersionResponse) SDKResponseMetdata added in v0.18.0 

func (r *CreateProjectVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProjectVersion request.

type CreateStreamProcessorInput added in v0.2.0 

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) String added in v0.2.0 

func (s CreateStreamProcessorInput) String() string

String returns the string representation

func (*CreateStreamProcessorInput) Validate added in v0.2.0 

func (s *CreateStreamProcessorInput) Validate() error

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

type CreateStreamProcessorOutput added in v0.2.0 

type CreateStreamProcessorOutput struct {

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

func (CreateStreamProcessorOutput) String added in v0.2.0 

func (s CreateStreamProcessorOutput) String() string

String returns the string representation

type CreateStreamProcessorRequest added in v0.2.0 

type CreateStreamProcessorRequest struct {
	*aws.Request
	Input *CreateStreamProcessorInput
	Copy  func(*CreateStreamProcessorInput) CreateStreamProcessorRequest
}

CreateStreamProcessorRequest is the request type for the CreateStreamProcessor API operation.

func (CreateStreamProcessorRequest) Send added in v0.2.0 

func (r CreateStreamProcessorRequest) Send(ctx context.Context) (*CreateStreamProcessorResponse, error)

Send marshals and sends the CreateStreamProcessor API request.

type CreateStreamProcessorResponse added in v0.9.0 

type CreateStreamProcessorResponse struct {
	*CreateStreamProcessorOutput
	// contains filtered or unexported fields
}

CreateStreamProcessorResponse is the response type for the CreateStreamProcessor API operation.

func (*CreateStreamProcessorResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateStreamProcessorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateStreamProcessor request.

type CustomLabel added in v0.18.0 

type CustomLabel struct {

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

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

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

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

func (CustomLabel) String added in v0.18.0 

func (s CustomLabel) String() string

String returns the string representation

type DeleteCollectionInput 

type DeleteCollectionInput struct {

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

func (DeleteCollectionInput) String 

func (s DeleteCollectionInput) String() string

String returns the string representation

func (*DeleteCollectionInput) Validate 

func (s *DeleteCollectionInput) Validate() error

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

type DeleteCollectionOutput 

type DeleteCollectionOutput struct {

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

func (DeleteCollectionOutput) String 

func (s DeleteCollectionOutput) String() string

String returns the string representation

type DeleteCollectionRequest 

type DeleteCollectionRequest struct {
	*aws.Request
	Input *DeleteCollectionInput
	Copy  func(*DeleteCollectionInput) DeleteCollectionRequest
}

DeleteCollectionRequest is the request type for the DeleteCollection API operation.

func (DeleteCollectionRequest) Send 

func (r DeleteCollectionRequest) Send(ctx context.Context) (*DeleteCollectionResponse, error)

Send marshals and sends the DeleteCollection API request.

type DeleteCollectionResponse added in v0.9.0 

type DeleteCollectionResponse struct {
	*DeleteCollectionOutput
	// contains filtered or unexported fields
}

DeleteCollectionResponse is the response type for the DeleteCollection API operation.

func (*DeleteCollectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteCollectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCollection request.

type DeleteFacesInput 

type DeleteFacesInput struct {

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

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

func (DeleteFacesInput) String 

func (s DeleteFacesInput) String() string

String returns the string representation

func (*DeleteFacesInput) Validate 

func (s *DeleteFacesInput) Validate() error

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

type DeleteFacesOutput 

type DeleteFacesOutput struct {

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

func (DeleteFacesOutput) String 

func (s DeleteFacesOutput) String() string

String returns the string representation

type DeleteFacesRequest 

type DeleteFacesRequest struct {
	*aws.Request
	Input *DeleteFacesInput
	Copy  func(*DeleteFacesInput) DeleteFacesRequest
}

DeleteFacesRequest is the request type for the DeleteFaces API operation.

func (DeleteFacesRequest) Send 

func (r DeleteFacesRequest) Send(ctx context.Context) (*DeleteFacesResponse, error)

Send marshals and sends the DeleteFaces API request.

type DeleteFacesResponse added in v0.9.0 

type DeleteFacesResponse struct {
	*DeleteFacesOutput
	// contains filtered or unexported fields
}

DeleteFacesResponse is the response type for the DeleteFaces API operation.

func (*DeleteFacesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteFacesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFaces request.

type DeleteProjectInput added in v0.21.0 

type DeleteProjectInput struct {

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

func (DeleteProjectInput) String added in v0.21.0 

func (s DeleteProjectInput) String() string

String returns the string representation

func (*DeleteProjectInput) Validate added in v0.21.0 

func (s *DeleteProjectInput) Validate() error

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

type DeleteProjectOutput added in v0.21.0 

type DeleteProjectOutput struct {

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

func (DeleteProjectOutput) String added in v0.21.0 

func (s DeleteProjectOutput) String() string

String returns the string representation

type DeleteProjectRequest added in v0.21.0 

type DeleteProjectRequest struct {
	*aws.Request
	Input *DeleteProjectInput
	Copy  func(*DeleteProjectInput) DeleteProjectRequest
}

DeleteProjectRequest is the request type for the DeleteProject API operation.

func (DeleteProjectRequest) Send added in v0.21.0 

func (r DeleteProjectRequest) Send(ctx context.Context) (*DeleteProjectResponse, error)

Send marshals and sends the DeleteProject API request.

type DeleteProjectResponse added in v0.21.0 

type DeleteProjectResponse struct {
	*DeleteProjectOutput
	// contains filtered or unexported fields
}

DeleteProjectResponse is the response type for the DeleteProject API operation.

func (*DeleteProjectResponse) SDKResponseMetdata added in v0.21.0 

func (r *DeleteProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProject request.

type DeleteProjectVersionInput added in v0.21.0 

type DeleteProjectVersionInput struct {

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

func (DeleteProjectVersionInput) String added in v0.21.0 

func (s DeleteProjectVersionInput) String() string

String returns the string representation

func (*DeleteProjectVersionInput) Validate added in v0.21.0 

func (s *DeleteProjectVersionInput) Validate() error

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

type DeleteProjectVersionOutput added in v0.21.0 

type DeleteProjectVersionOutput struct {

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

func (DeleteProjectVersionOutput) String added in v0.21.0 

func (s DeleteProjectVersionOutput) String() string

String returns the string representation

type DeleteProjectVersionRequest added in v0.21.0 

type DeleteProjectVersionRequest struct {
	*aws.Request
	Input *DeleteProjectVersionInput
	Copy  func(*DeleteProjectVersionInput) DeleteProjectVersionRequest
}

DeleteProjectVersionRequest is the request type for the DeleteProjectVersion API operation.

func (DeleteProjectVersionRequest) Send added in v0.21.0 

func (r DeleteProjectVersionRequest) Send(ctx context.Context) (*DeleteProjectVersionResponse, error)

Send marshals and sends the DeleteProjectVersion API request.

type DeleteProjectVersionResponse added in v0.21.0 

type DeleteProjectVersionResponse struct {
	*DeleteProjectVersionOutput
	// contains filtered or unexported fields
}

DeleteProjectVersionResponse is the response type for the DeleteProjectVersion API operation.

func (*DeleteProjectVersionResponse) SDKResponseMetdata added in v0.21.0 

func (r *DeleteProjectVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProjectVersion request.

type DeleteStreamProcessorInput added in v0.2.0 

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) String added in v0.2.0 

func (s DeleteStreamProcessorInput) String() string

String returns the string representation

func (*DeleteStreamProcessorInput) Validate added in v0.2.0 

func (s *DeleteStreamProcessorInput) Validate() error

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

type DeleteStreamProcessorOutput added in v0.2.0 

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

func (DeleteStreamProcessorOutput) String added in v0.2.0 

func (s DeleteStreamProcessorOutput) String() string

String returns the string representation

type DeleteStreamProcessorRequest added in v0.2.0 

type DeleteStreamProcessorRequest struct {
	*aws.Request
	Input *DeleteStreamProcessorInput
	Copy  func(*DeleteStreamProcessorInput) DeleteStreamProcessorRequest
}

DeleteStreamProcessorRequest is the request type for the DeleteStreamProcessor API operation.

func (DeleteStreamProcessorRequest) Send added in v0.2.0 

func (r DeleteStreamProcessorRequest) Send(ctx context.Context) (*DeleteStreamProcessorResponse, error)

Send marshals and sends the DeleteStreamProcessor API request.

type DeleteStreamProcessorResponse added in v0.9.0 

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

DeleteStreamProcessorResponse is the response type for the DeleteStreamProcessor API operation.

func (*DeleteStreamProcessorResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteStreamProcessorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteStreamProcessor request.

type DescribeCollectionInput added in v0.5.0 

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) String added in v0.5.0 

func (s DescribeCollectionInput) String() string

String returns the string representation

func (*DescribeCollectionInput) Validate added in v0.5.0 

func (s *DescribeCollectionInput) Validate() error

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

type DescribeCollectionOutput added in v0.5.0 

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) String added in v0.5.0 

func (s DescribeCollectionOutput) String() string

String returns the string representation

type DescribeCollectionRequest added in v0.5.0 

type DescribeCollectionRequest struct {
	*aws.Request
	Input *DescribeCollectionInput
	Copy  func(*DescribeCollectionInput) DescribeCollectionRequest
}

DescribeCollectionRequest is the request type for the DescribeCollection API operation.

func (DescribeCollectionRequest) Send added in v0.5.0 

func (r DescribeCollectionRequest) Send(ctx context.Context) (*DescribeCollectionResponse, error)

Send marshals and sends the DescribeCollection API request.

type DescribeCollectionResponse added in v0.9.0 

type DescribeCollectionResponse struct {
	*DescribeCollectionOutput
	// contains filtered or unexported fields
}

DescribeCollectionResponse is the response type for the DescribeCollection API operation.

func (*DescribeCollectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeCollectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCollection request.

type DescribeProjectVersionsInput added in v0.18.0 

type DescribeProjectVersionsInput struct {

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

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

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

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

func (DescribeProjectVersionsInput) String added in v0.18.0 

func (s DescribeProjectVersionsInput) String() string

String returns the string representation

func (*DescribeProjectVersionsInput) Validate added in v0.18.0 

func (s *DescribeProjectVersionsInput) Validate() error

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

type DescribeProjectVersionsOutput added in v0.18.0 

type DescribeProjectVersionsOutput struct {

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

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

func (DescribeProjectVersionsOutput) String added in v0.18.0 

func (s DescribeProjectVersionsOutput) String() string

String returns the string representation

type DescribeProjectVersionsPaginator added in v0.18.0 

type DescribeProjectVersionsPaginator struct {
	aws.Pager
}

DescribeProjectVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeProjectVersionsPaginator added in v0.18.0 

func NewDescribeProjectVersionsPaginator(req DescribeProjectVersionsRequest) DescribeProjectVersionsPaginator

NewDescribeProjectVersionsRequestPaginator returns a paginator for DescribeProjectVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeProjectVersionsRequest(input)
p := rekognition.NewDescribeProjectVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeProjectVersionsPaginator) CurrentPage added in v0.18.0 

func (p *DescribeProjectVersionsPaginator) CurrentPage() *DescribeProjectVersionsOutput

type DescribeProjectVersionsRequest added in v0.18.0 

type DescribeProjectVersionsRequest struct {
	*aws.Request
	Input *DescribeProjectVersionsInput
	Copy  func(*DescribeProjectVersionsInput) DescribeProjectVersionsRequest
}

DescribeProjectVersionsRequest is the request type for the DescribeProjectVersions API operation.

func (DescribeProjectVersionsRequest) Send added in v0.18.0 

func (r DescribeProjectVersionsRequest) Send(ctx context.Context) (*DescribeProjectVersionsResponse, error)

Send marshals and sends the DescribeProjectVersions API request.

type DescribeProjectVersionsResponse added in v0.18.0 

type DescribeProjectVersionsResponse struct {
	*DescribeProjectVersionsOutput
	// contains filtered or unexported fields
}

DescribeProjectVersionsResponse is the response type for the DescribeProjectVersions API operation.

func (*DescribeProjectVersionsResponse) SDKResponseMetdata added in v0.18.0 

func (r *DescribeProjectVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProjectVersions request.

type DescribeProjectsInput added in v0.18.0 

type DescribeProjectsInput struct {

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

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

func (DescribeProjectsInput) String added in v0.18.0 

func (s DescribeProjectsInput) String() string

String returns the string representation

func (*DescribeProjectsInput) Validate added in v0.18.0 

func (s *DescribeProjectsInput) Validate() error

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

type DescribeProjectsOutput added in v0.18.0 

type DescribeProjectsOutput struct {

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

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

func (DescribeProjectsOutput) String added in v0.18.0 

func (s DescribeProjectsOutput) String() string

String returns the string representation

type DescribeProjectsPaginator added in v0.18.0 

type DescribeProjectsPaginator struct {
	aws.Pager
}

DescribeProjectsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeProjectsPaginator added in v0.18.0 

func NewDescribeProjectsPaginator(req DescribeProjectsRequest) DescribeProjectsPaginator

NewDescribeProjectsRequestPaginator returns a paginator for DescribeProjects. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeProjectsRequest(input)
p := rekognition.NewDescribeProjectsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeProjectsPaginator) CurrentPage added in v0.18.0 

func (p *DescribeProjectsPaginator) CurrentPage() *DescribeProjectsOutput

type DescribeProjectsRequest added in v0.18.0 

type DescribeProjectsRequest struct {
	*aws.Request
	Input *DescribeProjectsInput
	Copy  func(*DescribeProjectsInput) DescribeProjectsRequest
}

DescribeProjectsRequest is the request type for the DescribeProjects API operation.

func (DescribeProjectsRequest) Send added in v0.18.0 

func (r DescribeProjectsRequest) Send(ctx context.Context) (*DescribeProjectsResponse, error)

Send marshals and sends the DescribeProjects API request.

type DescribeProjectsResponse added in v0.18.0 

type DescribeProjectsResponse struct {
	*DescribeProjectsOutput
	// contains filtered or unexported fields
}

DescribeProjectsResponse is the response type for the DescribeProjects API operation.

func (*DescribeProjectsResponse) SDKResponseMetdata added in v0.18.0 

func (r *DescribeProjectsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProjects request.

type DescribeStreamProcessorInput added in v0.2.0 

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) String added in v0.2.0 

func (s DescribeStreamProcessorInput) String() string

String returns the string representation

func (*DescribeStreamProcessorInput) Validate added in v0.2.0 

func (s *DescribeStreamProcessorInput) Validate() error

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

type DescribeStreamProcessorOutput added in v0.2.0 

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 StreamProcessorStatus `type:"string" enum:"true"`

	// 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) String added in v0.2.0 

func (s DescribeStreamProcessorOutput) String() string

String returns the string representation

type DescribeStreamProcessorRequest added in v0.2.0 

type DescribeStreamProcessorRequest struct {
	*aws.Request
	Input *DescribeStreamProcessorInput
	Copy  func(*DescribeStreamProcessorInput) DescribeStreamProcessorRequest
}

DescribeStreamProcessorRequest is the request type for the DescribeStreamProcessor API operation.

func (DescribeStreamProcessorRequest) Send added in v0.2.0 

func (r DescribeStreamProcessorRequest) Send(ctx context.Context) (*DescribeStreamProcessorResponse, error)

Send marshals and sends the DescribeStreamProcessor API request.

type DescribeStreamProcessorResponse added in v0.9.0 

type DescribeStreamProcessorResponse struct {
	*DescribeStreamProcessorOutput
	// contains filtered or unexported fields
}

DescribeStreamProcessorResponse is the response type for the DescribeStreamProcessor API operation.

func (*DescribeStreamProcessorResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeStreamProcessorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeStreamProcessor request.

type DetectCustomLabelsInput added in v0.18.0 

type DetectCustomLabelsInput struct {

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

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

	// Specifies the minimum confidence level for the labels to return. Amazon Rekognition
	// doesn't return any labels with a confidence lower than this specified value.
	// If you specify a value of 0, all labels are return, regardless of the default
	// thresholds that the model version applies.
	MinConfidence *float64 `type:"float"`

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

func (DetectCustomLabelsInput) String added in v0.18.0 

func (s DetectCustomLabelsInput) String() string

String returns the string representation

func (*DetectCustomLabelsInput) Validate added in v0.18.0 

func (s *DetectCustomLabelsInput) Validate() error

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

type DetectCustomLabelsOutput added in v0.18.0 

type DetectCustomLabelsOutput struct {

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

func (DetectCustomLabelsOutput) String added in v0.18.0 

func (s DetectCustomLabelsOutput) String() string

String returns the string representation

type DetectCustomLabelsRequest added in v0.18.0 

type DetectCustomLabelsRequest struct {
	*aws.Request
	Input *DetectCustomLabelsInput
	Copy  func(*DetectCustomLabelsInput) DetectCustomLabelsRequest
}

DetectCustomLabelsRequest is the request type for the DetectCustomLabels API operation.

func (DetectCustomLabelsRequest) Send added in v0.18.0 

func (r DetectCustomLabelsRequest) Send(ctx context.Context) (*DetectCustomLabelsResponse, error)

Send marshals and sends the DetectCustomLabels API request.

type DetectCustomLabelsResponse added in v0.18.0 

type DetectCustomLabelsResponse struct {
	*DetectCustomLabelsOutput
	// contains filtered or unexported fields
}

DetectCustomLabelsResponse is the response type for the DetectCustomLabels API operation.

func (*DetectCustomLabelsResponse) SDKResponseMetdata added in v0.18.0 

func (r *DetectCustomLabelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectCustomLabels request.

type DetectFacesInput 

type DetectFacesInput struct {

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

func (s DetectFacesInput) String() string

String returns the string representation

func (*DetectFacesInput) Validate 

func (s *DetectFacesInput) Validate() error

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

type DetectFacesOutput 

type DetectFacesOutput struct {

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

	// The 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 OrientationCorrection `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DetectFacesOutput) String 

func (s DetectFacesOutput) String() string

String returns the string representation

type DetectFacesRequest 

type DetectFacesRequest struct {
	*aws.Request
	Input *DetectFacesInput
	Copy  func(*DetectFacesInput) DetectFacesRequest
}

DetectFacesRequest is the request type for the DetectFaces API operation.

func (DetectFacesRequest) Send 

func (r DetectFacesRequest) Send(ctx context.Context) (*DetectFacesResponse, error)

Send marshals and sends the DetectFaces API request.

type DetectFacesResponse added in v0.9.0 

type DetectFacesResponse struct {
	*DetectFacesOutput
	// contains filtered or unexported fields
}

DetectFacesResponse is the response type for the DetectFaces API operation.

func (*DetectFacesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DetectFacesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectFaces request.

type DetectLabelsInput 

type DetectLabelsInput struct {

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing image bytes is not supported.
	// Images stored in an S3 Bucket do not need to be base64-encoded.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

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

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

func (DetectLabelsInput) String 

func (s DetectLabelsInput) String() string

String returns the string representation

func (*DetectLabelsInput) Validate 

func (s *DetectLabelsInput) Validate() error

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

type DetectLabelsOutput 

type DetectLabelsOutput struct {

	// 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 OrientationCorrection `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DetectLabelsOutput) String 

func (s DetectLabelsOutput) String() string

String returns the string representation

type DetectLabelsRequest 

type DetectLabelsRequest struct {
	*aws.Request
	Input *DetectLabelsInput
	Copy  func(*DetectLabelsInput) DetectLabelsRequest
}

DetectLabelsRequest is the request type for the DetectLabels API operation.

func (DetectLabelsRequest) Send 

func (r DetectLabelsRequest) Send(ctx context.Context) (*DetectLabelsResponse, error)

Send marshals and sends the DetectLabels API request.

type DetectLabelsResponse added in v0.9.0 

type DetectLabelsResponse struct {
	*DetectLabelsOutput
	// contains filtered or unexported fields
}

DetectLabelsResponse is the response type for the DetectLabels API operation.

func (*DetectLabelsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DetectLabelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectLabels request.

type DetectModerationLabelsInput 

type DetectModerationLabelsInput struct {

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

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

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

func (DetectModerationLabelsInput) String 

func (s DetectModerationLabelsInput) String() string

String returns the string representation

func (*DetectModerationLabelsInput) Validate 

func (s *DetectModerationLabelsInput) Validate() error

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

type DetectModerationLabelsOutput 

type DetectModerationLabelsOutput struct {

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

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

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

func (DetectModerationLabelsOutput) String 

func (s DetectModerationLabelsOutput) String() string

String returns the string representation

type DetectModerationLabelsRequest 

type DetectModerationLabelsRequest struct {
	*aws.Request
	Input *DetectModerationLabelsInput
	Copy  func(*DetectModerationLabelsInput) DetectModerationLabelsRequest
}

DetectModerationLabelsRequest is the request type for the DetectModerationLabels API operation.

func (DetectModerationLabelsRequest) Send 

func (r DetectModerationLabelsRequest) Send(ctx context.Context) (*DetectModerationLabelsResponse, error)

Send marshals and sends the DetectModerationLabels API request.

type DetectModerationLabelsResponse added in v0.9.0 

type DetectModerationLabelsResponse struct {
	*DetectModerationLabelsOutput
	// contains filtered or unexported fields
}

DetectModerationLabelsResponse is the response type for the DetectModerationLabels API operation.

func (*DetectModerationLabelsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DetectModerationLabelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectModerationLabels request.

type DetectTextFilters added in v0.20.0 

type DetectTextFilters struct {

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

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

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

func (DetectTextFilters) String added in v0.20.0 

func (s DetectTextFilters) String() string

String returns the string representation

type DetectTextInput added in v0.2.0 

type DetectTextInput struct {

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

	// The input image as base64-encoded bytes or an Amazon S3 object. If you use
	// the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetectTextInput) String added in v0.2.0 

func (s DetectTextInput) String() string

String returns the string representation

func (*DetectTextInput) Validate added in v0.2.0 

func (s *DetectTextInput) Validate() error

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

type DetectTextOutput added in v0.2.0 

type DetectTextOutput struct {

	// An array of text that was detected in the input image.
	TextDetections []TextDetection `type:"list"`

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

func (DetectTextOutput) String added in v0.2.0 

func (s DetectTextOutput) String() string

String returns the string representation

type DetectTextRequest added in v0.2.0 

type DetectTextRequest struct {
	*aws.Request
	Input *DetectTextInput
	Copy  func(*DetectTextInput) DetectTextRequest
}

DetectTextRequest is the request type for the DetectText API operation.

func (DetectTextRequest) Send added in v0.2.0 

func (r DetectTextRequest) Send(ctx context.Context) (*DetectTextResponse, error)

Send marshals and sends the DetectText API request.

type DetectTextResponse added in v0.9.0 

type DetectTextResponse struct {
	*DetectTextOutput
	// contains filtered or unexported fields
}

DetectTextResponse is the response type for the DetectText API operation.

func (*DetectTextResponse) SDKResponseMetdata added in v0.9.0 

func (r *DetectTextResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectText request.

type DetectionFilter added in v0.20.0 

type DetectionFilter struct {

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

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

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

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

func (DetectionFilter) String added in v0.20.0 

func (s DetectionFilter) String() string

String returns the string representation

type Emotion 

type Emotion struct {

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

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

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

func (Emotion) String 

func (s Emotion) String() string

String returns the string representation

type EmotionName 

type EmotionName string
const (
	EmotionNameHappy     EmotionName = "HAPPY"
	EmotionNameSad       EmotionName = "SAD"
	EmotionNameAngry     EmotionName = "ANGRY"
	EmotionNameConfused  EmotionName = "CONFUSED"
	EmotionNameDisgusted EmotionName = "DISGUSTED"
	EmotionNameSurprised EmotionName = "SURPRISED"
	EmotionNameCalm      EmotionName = "CALM"
	EmotionNameUnknown   EmotionName = "UNKNOWN"
	EmotionNameFear      EmotionName = "FEAR"
)

Enum values for EmotionName

func (EmotionName) MarshalValue added in v0.3.0 

func (enum EmotionName) MarshalValue() (string, error)

func (EmotionName) MarshalValueBuf added in v0.3.0 

func (enum EmotionName) MarshalValueBuf(b []byte) ([]byte, error)

type EvaluationResult added in v0.18.0 

type EvaluationResult struct {

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

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

The evaluation results for the training of a model.

func (EvaluationResult) String added in v0.18.0 

func (s EvaluationResult) String() string

String returns the string representation

type EyeOpen 

type EyeOpen struct {

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

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

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

func (EyeOpen) String 

func (s EyeOpen) String() string

String returns the string representation

type Eyeglasses 

type Eyeglasses struct {

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

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

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

func (Eyeglasses) String 

func (s Eyeglasses) String() string

String returns the string representation

type Face 

type Face struct {

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

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

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

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

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

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

func (Face) String 

func (s Face) String() string

String returns the string representation

type FaceAttributes added in v0.2.0 

type FaceAttributes string
const (
	FaceAttributesDefault FaceAttributes = "DEFAULT"
	FaceAttributesAll     FaceAttributes = "ALL"
)

Enum values for FaceAttributes

func (FaceAttributes) MarshalValue added in v0.3.0 

func (enum FaceAttributes) MarshalValue() (string, error)

func (FaceAttributes) MarshalValueBuf added in v0.3.0 

func (enum FaceAttributes) MarshalValueBuf(b []byte) ([]byte, error)

type FaceDetail 

type FaceDetail struct {

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

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

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

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

	// The emotions that appear to be expressed on the face, and the confidence
	// level in the determination. The API is only making a determination of the
	// physical appearance of a person's face. It is not a determination of the
	// person’s internal emotional state and should not be used in such a way.
	// For example, a person pretending to have a sad face might not be sad emotionally.
	Emotions []Emotion `type:"list"`

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

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

	// The predicted gender of a detected face.
	Gender *Gender `type:"structure"`

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

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

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

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

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

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

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

Structure containing attributes of the face that the algorithm detected.

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

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

  • GetCelebrityRecognition

  • GetPersonTracking

  • GetFaceSearch

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

func (FaceDetail) String 

func (s FaceDetail) String() string

String returns the string representation

type FaceDetection added in v0.2.0 

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) String added in v0.2.0 

func (s FaceDetection) String() string

String returns the string representation

type FaceMatch 

type FaceMatch struct {

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

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

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

func (FaceMatch) String 

func (s FaceMatch) String() string

String returns the string representation

type FaceRecord 

type FaceRecord struct {

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

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

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

func (FaceRecord) String 

func (s FaceRecord) String() string

String returns the string representation

type FaceSearchSettings added in v0.2.0 

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 80. 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) String added in v0.2.0 

func (s FaceSearchSettings) String() string

String returns the string representation

func (*FaceSearchSettings) Validate added in v0.2.0 

func (s *FaceSearchSettings) Validate() error

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

type FaceSearchSortBy added in v0.2.0 

type FaceSearchSortBy string
const (
	FaceSearchSortByIndex     FaceSearchSortBy = "INDEX"
	FaceSearchSortByTimestamp FaceSearchSortBy = "TIMESTAMP"
)

Enum values for FaceSearchSortBy

func (FaceSearchSortBy) MarshalValue added in v0.3.0 

func (enum FaceSearchSortBy) MarshalValue() (string, error)

func (FaceSearchSortBy) MarshalValueBuf added in v0.3.0 

func (enum FaceSearchSortBy) MarshalValueBuf(b []byte) ([]byte, error)

type Gender 

type Gender struct {

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

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

The predicted gender of a detected face.

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

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

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

func (Gender) String 

func (s Gender) String() string

String returns the string representation

type GenderType 

type GenderType string
const (
	GenderTypeMale   GenderType = "Male"
	GenderTypeFemale GenderType = "Female"
)

Enum values for GenderType

func (GenderType) MarshalValue added in v0.3.0 

func (enum GenderType) MarshalValue() (string, error)

func (GenderType) MarshalValueBuf added in v0.3.0 

func (enum GenderType) MarshalValueBuf(b []byte) ([]byte, error)

type Geometry added in v0.2.0 

type Geometry struct {

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

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

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

func (Geometry) String added in v0.2.0 

func (s Geometry) String() string

String returns the string representation

type GetCelebrityInfoInput 

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) String 

func (s GetCelebrityInfoInput) String() string

String returns the string representation

func (*GetCelebrityInfoInput) Validate 

func (s *GetCelebrityInfoInput) Validate() error

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

type GetCelebrityInfoOutput 

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) String 

func (s GetCelebrityInfoOutput) String() string

String returns the string representation

type GetCelebrityInfoRequest 

type GetCelebrityInfoRequest struct {
	*aws.Request
	Input *GetCelebrityInfoInput
	Copy  func(*GetCelebrityInfoInput) GetCelebrityInfoRequest
}

GetCelebrityInfoRequest is the request type for the GetCelebrityInfo API operation.

func (GetCelebrityInfoRequest) Send 

func (r GetCelebrityInfoRequest) Send(ctx context.Context) (*GetCelebrityInfoResponse, error)

Send marshals and sends the GetCelebrityInfo API request.

type GetCelebrityInfoResponse added in v0.9.0 

type GetCelebrityInfoResponse struct {
	*GetCelebrityInfoOutput
	// contains filtered or unexported fields
}

GetCelebrityInfoResponse is the response type for the GetCelebrityInfo API operation.

func (*GetCelebrityInfoResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCelebrityInfoResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCelebrityInfo request.

type GetCelebrityRecognitionInput added in v0.2.0 

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 CelebrityRecognitionSortBy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetCelebrityRecognitionInput) String added in v0.2.0 

func (s GetCelebrityRecognitionInput) String() string

String returns the string representation

func (*GetCelebrityRecognitionInput) Validate added in v0.2.0 

func (s *GetCelebrityRecognitionInput) Validate() error

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

type GetCelebrityRecognitionOutput added in v0.2.0 

type GetCelebrityRecognitionOutput struct {

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

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

	// 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) String added in v0.2.0 

func (s GetCelebrityRecognitionOutput) String() string

String returns the string representation

type GetCelebrityRecognitionPaginator added in v0.9.0 

type GetCelebrityRecognitionPaginator struct {
	aws.Pager
}

GetCelebrityRecognitionPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetCelebrityRecognitionPaginator added in v0.9.0 

func NewGetCelebrityRecognitionPaginator(req GetCelebrityRecognitionRequest) GetCelebrityRecognitionPaginator

NewGetCelebrityRecognitionRequestPaginator returns a paginator for GetCelebrityRecognition. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetCelebrityRecognitionRequest(input)
p := rekognition.NewGetCelebrityRecognitionRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetCelebrityRecognitionPaginator) CurrentPage added in v0.9.0 

func (p *GetCelebrityRecognitionPaginator) CurrentPage() *GetCelebrityRecognitionOutput

type GetCelebrityRecognitionRequest added in v0.2.0 

type GetCelebrityRecognitionRequest struct {
	*aws.Request
	Input *GetCelebrityRecognitionInput
	Copy  func(*GetCelebrityRecognitionInput) GetCelebrityRecognitionRequest
}

GetCelebrityRecognitionRequest is the request type for the GetCelebrityRecognition API operation.

func (GetCelebrityRecognitionRequest) Send added in v0.2.0 

func (r GetCelebrityRecognitionRequest) Send(ctx context.Context) (*GetCelebrityRecognitionResponse, error)

Send marshals and sends the GetCelebrityRecognition API request.

type GetCelebrityRecognitionResponse added in v0.9.0 

type GetCelebrityRecognitionResponse struct {
	*GetCelebrityRecognitionOutput
	// contains filtered or unexported fields
}

GetCelebrityRecognitionResponse is the response type for the GetCelebrityRecognition API operation.

func (*GetCelebrityRecognitionResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCelebrityRecognitionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCelebrityRecognition request.

type GetContentModerationInput added in v0.2.0 

type GetContentModerationInput struct {

	// The identifier for the unsafe content 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 unsafe content 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 ContentModerationSortBy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetContentModerationInput) String added in v0.2.0 

func (s GetContentModerationInput) String() string

String returns the string representation

func (*GetContentModerationInput) Validate added in v0.2.0 

func (s *GetContentModerationInput) Validate() error

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

type GetContentModerationOutput added in v0.2.0 

type GetContentModerationOutput struct {

	// The current status of the unsafe content analysis job.
	JobStatus VideoJobStatus `type:"string" enum:"true"`

	// The detected unsafe content 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 unsafe
	// content 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) String added in v0.2.0 

func (s GetContentModerationOutput) String() string

String returns the string representation

type GetContentModerationPaginator added in v0.9.0 

type GetContentModerationPaginator struct {
	aws.Pager
}

GetContentModerationPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetContentModerationPaginator added in v0.9.0 

func NewGetContentModerationPaginator(req GetContentModerationRequest) GetContentModerationPaginator

NewGetContentModerationRequestPaginator returns a paginator for GetContentModeration. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetContentModerationRequest(input)
p := rekognition.NewGetContentModerationRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetContentModerationPaginator) CurrentPage added in v0.9.0 

func (p *GetContentModerationPaginator) CurrentPage() *GetContentModerationOutput

type GetContentModerationRequest added in v0.2.0 

type GetContentModerationRequest struct {
	*aws.Request
	Input *GetContentModerationInput
	Copy  func(*GetContentModerationInput) GetContentModerationRequest
}

GetContentModerationRequest is the request type for the GetContentModeration API operation.

func (GetContentModerationRequest) Send added in v0.2.0 

func (r GetContentModerationRequest) Send(ctx context.Context) (*GetContentModerationResponse, error)

Send marshals and sends the GetContentModeration API request.

type GetContentModerationResponse added in v0.9.0 

type GetContentModerationResponse struct {
	*GetContentModerationOutput
	// contains filtered or unexported fields
}

GetContentModerationResponse is the response type for the GetContentModeration API operation.

func (*GetContentModerationResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetContentModerationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetContentModeration request.

type GetFaceDetectionInput added in v0.2.0 

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) String added in v0.2.0 

func (s GetFaceDetectionInput) String() string

String returns the string representation

func (*GetFaceDetectionInput) Validate added in v0.2.0 

func (s *GetFaceDetectionInput) Validate() error

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

type GetFaceDetectionOutput added in v0.2.0 

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 VideoJobStatus `type:"string" enum:"true"`

	// 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) String added in v0.2.0 

func (s GetFaceDetectionOutput) String() string

String returns the string representation

type GetFaceDetectionPaginator added in v0.9.0 

type GetFaceDetectionPaginator struct {
	aws.Pager
}

GetFaceDetectionPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetFaceDetectionPaginator added in v0.9.0 

func NewGetFaceDetectionPaginator(req GetFaceDetectionRequest) GetFaceDetectionPaginator

NewGetFaceDetectionRequestPaginator returns a paginator for GetFaceDetection. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetFaceDetectionRequest(input)
p := rekognition.NewGetFaceDetectionRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetFaceDetectionPaginator) CurrentPage added in v0.9.0 

func (p *GetFaceDetectionPaginator) CurrentPage() *GetFaceDetectionOutput

type GetFaceDetectionRequest added in v0.2.0 

type GetFaceDetectionRequest struct {
	*aws.Request
	Input *GetFaceDetectionInput
	Copy  func(*GetFaceDetectionInput) GetFaceDetectionRequest
}

GetFaceDetectionRequest is the request type for the GetFaceDetection API operation.

func (GetFaceDetectionRequest) Send added in v0.2.0 

func (r GetFaceDetectionRequest) Send(ctx context.Context) (*GetFaceDetectionResponse, error)

Send marshals and sends the GetFaceDetection API request.

type GetFaceDetectionResponse added in v0.9.0 

type GetFaceDetectionResponse struct {
	*GetFaceDetectionOutput
	// contains filtered or unexported fields
}

GetFaceDetectionResponse is the response type for the GetFaceDetection API operation.

func (*GetFaceDetectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetFaceDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFaceDetection request.

type GetFaceSearchInput added in v0.2.0 

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 FaceSearchSortBy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetFaceSearchInput) String added in v0.2.0 

func (s GetFaceSearchInput) String() string

String returns the string representation

func (*GetFaceSearchInput) Validate added in v0.2.0 

func (s *GetFaceSearchInput) Validate() error

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

type GetFaceSearchOutput added in v0.2.0 

type GetFaceSearchOutput struct {

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

	// 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) String added in v0.2.0 

func (s GetFaceSearchOutput) String() string

String returns the string representation

type GetFaceSearchPaginator added in v0.9.0 

type GetFaceSearchPaginator struct {
	aws.Pager
}

GetFaceSearchPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetFaceSearchPaginator added in v0.9.0 

func NewGetFaceSearchPaginator(req GetFaceSearchRequest) GetFaceSearchPaginator

NewGetFaceSearchRequestPaginator returns a paginator for GetFaceSearch. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetFaceSearchRequest(input)
p := rekognition.NewGetFaceSearchRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetFaceSearchPaginator) CurrentPage added in v0.9.0 

func (p *GetFaceSearchPaginator) CurrentPage() *GetFaceSearchOutput

type GetFaceSearchRequest added in v0.2.0 

type GetFaceSearchRequest struct {
	*aws.Request
	Input *GetFaceSearchInput
	Copy  func(*GetFaceSearchInput) GetFaceSearchRequest
}

GetFaceSearchRequest is the request type for the GetFaceSearch API operation.

func (GetFaceSearchRequest) Send added in v0.2.0 

func (r GetFaceSearchRequest) Send(ctx context.Context) (*GetFaceSearchResponse, error)

Send marshals and sends the GetFaceSearch API request.

type GetFaceSearchResponse added in v0.9.0 

type GetFaceSearchResponse struct {
	*GetFaceSearchOutput
	// contains filtered or unexported fields
}

GetFaceSearchResponse is the response type for the GetFaceSearch API operation.

func (*GetFaceSearchResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetFaceSearchResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFaceSearch request.

type GetLabelDetectionInput added in v0.2.0 

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 LabelDetectionSortBy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetLabelDetectionInput) String added in v0.2.0 

func (s GetLabelDetectionInput) String() string

String returns the string representation

func (*GetLabelDetectionInput) Validate added in v0.2.0 

func (s *GetLabelDetectionInput) Validate() error

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

type GetLabelDetectionOutput added in v0.2.0 

type GetLabelDetectionOutput struct {

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

	// 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) String added in v0.2.0 

func (s GetLabelDetectionOutput) String() string

String returns the string representation

type GetLabelDetectionPaginator added in v0.9.0 

type GetLabelDetectionPaginator struct {
	aws.Pager
}

GetLabelDetectionPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetLabelDetectionPaginator added in v0.9.0 

func NewGetLabelDetectionPaginator(req GetLabelDetectionRequest) GetLabelDetectionPaginator

NewGetLabelDetectionRequestPaginator returns a paginator for GetLabelDetection. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetLabelDetectionRequest(input)
p := rekognition.NewGetLabelDetectionRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetLabelDetectionPaginator) CurrentPage added in v0.9.0 

func (p *GetLabelDetectionPaginator) CurrentPage() *GetLabelDetectionOutput

type GetLabelDetectionRequest added in v0.2.0 

type GetLabelDetectionRequest struct {
	*aws.Request
	Input *GetLabelDetectionInput
	Copy  func(*GetLabelDetectionInput) GetLabelDetectionRequest
}

GetLabelDetectionRequest is the request type for the GetLabelDetection API operation.

func (GetLabelDetectionRequest) Send added in v0.2.0 

func (r GetLabelDetectionRequest) Send(ctx context.Context) (*GetLabelDetectionResponse, error)

Send marshals and sends the GetLabelDetection API request.

type GetLabelDetectionResponse added in v0.9.0 

type GetLabelDetectionResponse struct {
	*GetLabelDetectionOutput
	// contains filtered or unexported fields
}

GetLabelDetectionResponse is the response type for the GetLabelDetection API operation.

func (*GetLabelDetectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetLabelDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetLabelDetection request.

type GetPersonTrackingInput added in v0.2.0 

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 PersonTrackingSortBy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetPersonTrackingInput) String added in v0.2.0 

func (s GetPersonTrackingInput) String() string

String returns the string representation

func (*GetPersonTrackingInput) Validate added in v0.2.0 

func (s *GetPersonTrackingInput) Validate() error

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

type GetPersonTrackingOutput added in v0.2.0 

type GetPersonTrackingOutput struct {

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

	// 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) String added in v0.2.0 

func (s GetPersonTrackingOutput) String() string

String returns the string representation

type GetPersonTrackingPaginator added in v0.9.0 

type GetPersonTrackingPaginator struct {
	aws.Pager
}

GetPersonTrackingPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetPersonTrackingPaginator added in v0.9.0 

func NewGetPersonTrackingPaginator(req GetPersonTrackingRequest) GetPersonTrackingPaginator

NewGetPersonTrackingRequestPaginator returns a paginator for GetPersonTracking. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetPersonTrackingRequest(input)
p := rekognition.NewGetPersonTrackingRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetPersonTrackingPaginator) CurrentPage added in v0.9.0 

func (p *GetPersonTrackingPaginator) CurrentPage() *GetPersonTrackingOutput

type GetPersonTrackingRequest added in v0.2.0 

type GetPersonTrackingRequest struct {
	*aws.Request
	Input *GetPersonTrackingInput
	Copy  func(*GetPersonTrackingInput) GetPersonTrackingRequest
}

GetPersonTrackingRequest is the request type for the GetPersonTracking API operation.

func (GetPersonTrackingRequest) Send added in v0.2.0 

func (r GetPersonTrackingRequest) Send(ctx context.Context) (*GetPersonTrackingResponse, error)

Send marshals and sends the GetPersonTracking API request.

type GetPersonTrackingResponse added in v0.9.0 

type GetPersonTrackingResponse struct {
	*GetPersonTrackingOutput
	// contains filtered or unexported fields
}

GetPersonTrackingResponse is the response type for the GetPersonTracking API operation.

func (*GetPersonTrackingResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetPersonTrackingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetPersonTracking request.

type GetSegmentDetectionInput added in v0.24.0 

type GetSegmentDetectionInput struct {

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

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (GetSegmentDetectionInput) String added in v0.24.0 

func (s GetSegmentDetectionInput) String() string

String returns the string representation

func (*GetSegmentDetectionInput) Validate added in v0.24.0 

func (s *GetSegmentDetectionInput) Validate() error

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

type GetSegmentDetectionOutput added in v0.24.0 

type GetSegmentDetectionOutput struct {

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

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

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

	// An array of segments detected in a video.
	Segments []SegmentDetection `type:"list"`

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

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

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

func (GetSegmentDetectionOutput) String added in v0.24.0 

func (s GetSegmentDetectionOutput) String() string

String returns the string representation

type GetSegmentDetectionPaginator added in v0.24.0 

type GetSegmentDetectionPaginator struct {
	aws.Pager
}

GetSegmentDetectionPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetSegmentDetectionPaginator added in v0.24.0 

func NewGetSegmentDetectionPaginator(req GetSegmentDetectionRequest) GetSegmentDetectionPaginator

NewGetSegmentDetectionRequestPaginator returns a paginator for GetSegmentDetection. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetSegmentDetectionRequest(input)
p := rekognition.NewGetSegmentDetectionRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetSegmentDetectionPaginator) CurrentPage added in v0.24.0 

func (p *GetSegmentDetectionPaginator) CurrentPage() *GetSegmentDetectionOutput

type GetSegmentDetectionRequest added in v0.24.0 

type GetSegmentDetectionRequest struct {
	*aws.Request
	Input *GetSegmentDetectionInput
	Copy  func(*GetSegmentDetectionInput) GetSegmentDetectionRequest
}

GetSegmentDetectionRequest is the request type for the GetSegmentDetection API operation.

func (GetSegmentDetectionRequest) Send added in v0.24.0 

func (r GetSegmentDetectionRequest) Send(ctx context.Context) (*GetSegmentDetectionResponse, error)

Send marshals and sends the GetSegmentDetection API request.

type GetSegmentDetectionResponse added in v0.24.0 

type GetSegmentDetectionResponse struct {
	*GetSegmentDetectionOutput
	// contains filtered or unexported fields
}

GetSegmentDetectionResponse is the response type for the GetSegmentDetection API operation.

func (*GetSegmentDetectionResponse) SDKResponseMetdata added in v0.24.0 

func (r *GetSegmentDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSegmentDetection request.

type GetTextDetectionInput added in v0.20.0 

type GetTextDetectionInput struct {

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

	// Maximum number of results to return per paginated call. The largest value
	// you can specify is 1000.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (GetTextDetectionInput) String added in v0.20.0 

func (s GetTextDetectionInput) String() string

String returns the string representation

func (*GetTextDetectionInput) Validate added in v0.20.0 

func (s *GetTextDetectionInput) Validate() error

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

type GetTextDetectionOutput added in v0.20.0 

type GetTextDetectionOutput struct {

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

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

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

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

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

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

func (GetTextDetectionOutput) String added in v0.20.0 

func (s GetTextDetectionOutput) String() string

String returns the string representation

type GetTextDetectionPaginator added in v0.20.0 

type GetTextDetectionPaginator struct {
	aws.Pager
}

GetTextDetectionPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetTextDetectionPaginator added in v0.20.0 

func NewGetTextDetectionPaginator(req GetTextDetectionRequest) GetTextDetectionPaginator

NewGetTextDetectionRequestPaginator returns a paginator for GetTextDetection. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetTextDetectionRequest(input)
p := rekognition.NewGetTextDetectionRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetTextDetectionPaginator) CurrentPage added in v0.20.0 

func (p *GetTextDetectionPaginator) CurrentPage() *GetTextDetectionOutput

type GetTextDetectionRequest added in v0.20.0 

type GetTextDetectionRequest struct {
	*aws.Request
	Input *GetTextDetectionInput
	Copy  func(*GetTextDetectionInput) GetTextDetectionRequest
}

GetTextDetectionRequest is the request type for the GetTextDetection API operation.

func (GetTextDetectionRequest) Send added in v0.20.0 

func (r GetTextDetectionRequest) Send(ctx context.Context) (*GetTextDetectionResponse, error)

Send marshals and sends the GetTextDetection API request.

type GetTextDetectionResponse added in v0.20.0 

type GetTextDetectionResponse struct {
	*GetTextDetectionOutput
	// contains filtered or unexported fields
}

GetTextDetectionResponse is the response type for the GetTextDetection API operation.

func (*GetTextDetectionResponse) SDKResponseMetdata added in v0.20.0 

func (r *GetTextDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTextDetection request.

type GroundTruthManifest added in v0.18.0 

type GroundTruthManifest struct {

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

The S3 bucket that contains the Ground Truth manifest file.

func (GroundTruthManifest) String added in v0.18.0 

func (s GroundTruthManifest) String() string

String returns the string representation

func (*GroundTruthManifest) Validate added in v0.18.0 

func (s *GroundTruthManifest) Validate() error

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

type HumanLoopActivationOutput added in v0.18.0 

type HumanLoopActivationOutput struct {

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

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

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

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

func (HumanLoopActivationOutput) String added in v0.18.0 

func (s HumanLoopActivationOutput) String() string

String returns the string representation

type HumanLoopConfig added in v0.18.0 

type HumanLoopConfig struct {

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

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

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

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

func (HumanLoopConfig) String added in v0.18.0 

func (s HumanLoopConfig) String() string

String returns the string representation

func (*HumanLoopConfig) Validate added in v0.18.0 

func (s *HumanLoopConfig) Validate() error

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

type HumanLoopDataAttributes added in v0.18.0 

type HumanLoopDataAttributes struct {

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

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

func (HumanLoopDataAttributes) String added in v0.18.0 

func (s HumanLoopDataAttributes) String() string

String returns the string representation

type Image 

type Image struct {

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

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

Provides the input image either as bytes or an S3 object.

You pass image bytes to 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) String 

func (s Image) String() string

String returns the string representation

func (*Image) Validate 

func (s *Image) Validate() error

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

type ImageQuality 

type ImageQuality struct {

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

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

Identifies face image brightness and sharpness.

func (ImageQuality) String 

func (s ImageQuality) String() string

String returns the string representation

type IndexFacesInput 

type IndexFacesInput struct {

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

	// An array of facial attributes that you want to be returned. This can be the
	// default list of attributes or all attributes. If you don't specify a value
	// for Attributes or if you specify ["DEFAULT"], the API returns the following
	// subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and
	// Landmarks. If you provide ["ALL"], all facial attributes are returned, but
	// the operation 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 []Attribute `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 a quality bar for how much filtering is done to identify
	// faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition
	// chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes
	// all faces that don’t meet the chosen quality bar. The default value is
	// AUTO. The quality bar is based on a variety of common use cases. Low-quality
	// detections can occur for a number of reasons. Some examples are an object
	// that's misidentified as a face, a face that's too blurry, or a face with
	// a pose that's too extreme to use. If you specify NONE, no filtering is performed.
	//
	// To use quality filtering, the collection you are using must be associated
	// with version 3 of the face model or higher.
	QualityFilter QualityFilter `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (IndexFacesInput) String 

func (s IndexFacesInput) String() string

String returns the string representation

func (*IndexFacesInput) Validate 

func (s *IndexFacesInput) Validate() error

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

type IndexFacesOutput 

type IndexFacesOutput struct {

	// 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 OrientationCorrection `type:"string" enum:"true"`

	// 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) String 

func (s IndexFacesOutput) String() string

String returns the string representation

type IndexFacesRequest 

type IndexFacesRequest struct {
	*aws.Request
	Input *IndexFacesInput
	Copy  func(*IndexFacesInput) IndexFacesRequest
}

IndexFacesRequest is the request type for the IndexFaces API operation.

func (IndexFacesRequest) Send 

func (r IndexFacesRequest) Send(ctx context.Context) (*IndexFacesResponse, error)

Send marshals and sends the IndexFaces API request.

type IndexFacesResponse added in v0.9.0 

type IndexFacesResponse struct {
	*IndexFacesOutput
	// contains filtered or unexported fields
}

IndexFacesResponse is the response type for the IndexFaces API operation.

func (*IndexFacesResponse) SDKResponseMetdata added in v0.9.0 

func (r *IndexFacesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the IndexFaces request.

type Instance added in v0.6.0 

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) String added in v0.6.0 

func (s Instance) String() string

String returns the string representation

type KinesisDataStream added in v0.2.0 

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) String added in v0.2.0 

func (s KinesisDataStream) String() string

String returns the string representation

type KinesisVideoStream added in v0.2.0 

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) String added in v0.2.0 

func (s KinesisVideoStream) String() string

String returns the string representation

type Label 

type Label struct {

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

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

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

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

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

func (Label) String 

func (s Label) String() string

String returns the string representation

type LabelDetection added in v0.2.0 

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) String added in v0.2.0 

func (s LabelDetection) String() string

String returns the string representation

type LabelDetectionSortBy added in v0.2.0 

type LabelDetectionSortBy string
const (
	LabelDetectionSortByName      LabelDetectionSortBy = "NAME"
	LabelDetectionSortByTimestamp LabelDetectionSortBy = "TIMESTAMP"
)

Enum values for LabelDetectionSortBy

func (LabelDetectionSortBy) MarshalValue added in v0.3.0 

func (enum LabelDetectionSortBy) MarshalValue() (string, error)

func (LabelDetectionSortBy) MarshalValueBuf added in v0.3.0 

func (enum LabelDetectionSortBy) MarshalValueBuf(b []byte) ([]byte, error)

type Landmark 

type Landmark struct {

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

	// 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) String 

func (s Landmark) String() string

String returns the string representation

type LandmarkType 

type LandmarkType string
const (
	LandmarkTypeEyeLeft           LandmarkType = "eyeLeft"
	LandmarkTypeEyeRight          LandmarkType = "eyeRight"
	LandmarkTypeNose              LandmarkType = "nose"
	LandmarkTypeMouthLeft         LandmarkType = "mouthLeft"
	LandmarkTypeMouthRight        LandmarkType = "mouthRight"
	LandmarkTypeLeftEyeBrowLeft   LandmarkType = "leftEyeBrowLeft"
	LandmarkTypeLeftEyeBrowRight  LandmarkType = "leftEyeBrowRight"
	LandmarkTypeLeftEyeBrowUp     LandmarkType = "leftEyeBrowUp"
	LandmarkTypeRightEyeBrowLeft  LandmarkType = "rightEyeBrowLeft"
	LandmarkTypeRightEyeBrowRight LandmarkType = "rightEyeBrowRight"
	LandmarkTypeRightEyeBrowUp    LandmarkType = "rightEyeBrowUp"
	LandmarkTypeLeftEyeLeft       LandmarkType = "leftEyeLeft"
	LandmarkTypeLeftEyeRight      LandmarkType = "leftEyeRight"
	LandmarkTypeLeftEyeUp         LandmarkType = "leftEyeUp"
	LandmarkTypeLeftEyeDown       LandmarkType = "leftEyeDown"
	LandmarkTypeRightEyeLeft      LandmarkType = "rightEyeLeft"
	LandmarkTypeRightEyeRight     LandmarkType = "rightEyeRight"
	LandmarkTypeRightEyeUp        LandmarkType = "rightEyeUp"
	LandmarkTypeRightEyeDown      LandmarkType = "rightEyeDown"
	LandmarkTypeNoseLeft          LandmarkType = "noseLeft"
	LandmarkTypeNoseRight         LandmarkType = "noseRight"
	LandmarkTypeMouthUp           LandmarkType = "mouthUp"
	LandmarkTypeMouthDown         LandmarkType = "mouthDown"
	LandmarkTypeLeftPupil         LandmarkType = "leftPupil"
	LandmarkTypeRightPupil        LandmarkType = "rightPupil"
	LandmarkTypeUpperJawlineLeft  LandmarkType = "upperJawlineLeft"
	LandmarkTypeMidJawlineLeft    LandmarkType = "midJawlineLeft"
	LandmarkTypeChinBottom        LandmarkType = "chinBottom"
	LandmarkTypeMidJawlineRight   LandmarkType = "midJawlineRight"
	LandmarkTypeUpperJawlineRight LandmarkType = "upperJawlineRight"
)

Enum values for LandmarkType

func (LandmarkType) MarshalValue added in v0.3.0 

func (enum LandmarkType) MarshalValue() (string, error)

func (LandmarkType) MarshalValueBuf added in v0.3.0 

func (enum LandmarkType) MarshalValueBuf(b []byte) ([]byte, error)

type ListCollectionsInput 

type ListCollectionsInput struct {

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

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

func (ListCollectionsInput) String 

func (s ListCollectionsInput) String() string

String returns the string representation

type ListCollectionsOutput 

type ListCollectionsOutput struct {

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

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

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

func (ListCollectionsOutput) String 

func (s ListCollectionsOutput) String() string

String returns the string representation

type ListCollectionsPaginator added in v0.9.0 

type ListCollectionsPaginator struct {
	aws.Pager
}

ListCollectionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListCollectionsPaginator added in v0.9.0 

func NewListCollectionsPaginator(req ListCollectionsRequest) ListCollectionsPaginator

NewListCollectionsRequestPaginator returns a paginator for ListCollections. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListCollectionsRequest(input)
p := rekognition.NewListCollectionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListCollectionsPaginator) CurrentPage added in v0.9.0 

func (p *ListCollectionsPaginator) CurrentPage() *ListCollectionsOutput

type ListCollectionsRequest 

type ListCollectionsRequest struct {
	*aws.Request
	Input *ListCollectionsInput
	Copy  func(*ListCollectionsInput) ListCollectionsRequest
}

ListCollectionsRequest is the request type for the ListCollections API operation.

func (ListCollectionsRequest) Send 

func (r ListCollectionsRequest) Send(ctx context.Context) (*ListCollectionsResponse, error)

Send marshals and sends the ListCollections API request.

type ListCollectionsResponse added in v0.9.0 

type ListCollectionsResponse struct {
	*ListCollectionsOutput
	// contains filtered or unexported fields
}

ListCollectionsResponse is the response type for the ListCollections API operation.

func (*ListCollectionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListCollectionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListCollections request.

type ListFacesInput 

type ListFacesInput struct {

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

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

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

func (ListFacesInput) String 

func (s ListFacesInput) String() string

String returns the string representation

func (*ListFacesInput) Validate 

func (s *ListFacesInput) Validate() error

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

type ListFacesOutput 

type ListFacesOutput struct {

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

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

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

func (ListFacesOutput) String 

func (s ListFacesOutput) String() string

String returns the string representation

type ListFacesPaginator added in v0.9.0 

type ListFacesPaginator struct {
	aws.Pager
}

ListFacesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListFacesPaginator added in v0.9.0 

func NewListFacesPaginator(req ListFacesRequest) ListFacesPaginator

NewListFacesRequestPaginator returns a paginator for ListFaces. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListFacesRequest(input)
p := rekognition.NewListFacesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListFacesPaginator) CurrentPage added in v0.9.0 

func (p *ListFacesPaginator) CurrentPage() *ListFacesOutput

type ListFacesRequest 

type ListFacesRequest struct {
	*aws.Request
	Input *ListFacesInput
	Copy  func(*ListFacesInput) ListFacesRequest
}

ListFacesRequest is the request type for the ListFaces API operation.

func (ListFacesRequest) Send 

func (r ListFacesRequest) Send(ctx context.Context) (*ListFacesResponse, error)

Send marshals and sends the ListFaces API request.

type ListFacesResponse added in v0.9.0 

type ListFacesResponse struct {
	*ListFacesOutput
	// contains filtered or unexported fields
}

ListFacesResponse is the response type for the ListFaces API operation.

func (*ListFacesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListFacesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListFaces request.

type ListStreamProcessorsInput added in v0.2.0 

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) String added in v0.2.0 

func (s ListStreamProcessorsInput) String() string

String returns the string representation

func (*ListStreamProcessorsInput) Validate added in v0.2.0 

func (s *ListStreamProcessorsInput) Validate() error

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

type ListStreamProcessorsOutput added in v0.2.0 

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) String added in v0.2.0 

func (s ListStreamProcessorsOutput) String() string

String returns the string representation

type ListStreamProcessorsPaginator added in v0.9.0 

type ListStreamProcessorsPaginator struct {
	aws.Pager
}

ListStreamProcessorsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListStreamProcessorsPaginator added in v0.9.0 

func NewListStreamProcessorsPaginator(req ListStreamProcessorsRequest) ListStreamProcessorsPaginator

NewListStreamProcessorsRequestPaginator returns a paginator for ListStreamProcessors. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListStreamProcessorsRequest(input)
p := rekognition.NewListStreamProcessorsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListStreamProcessorsPaginator) CurrentPage added in v0.9.0 

func (p *ListStreamProcessorsPaginator) CurrentPage() *ListStreamProcessorsOutput

type ListStreamProcessorsRequest added in v0.2.0 

type ListStreamProcessorsRequest struct {
	*aws.Request
	Input *ListStreamProcessorsInput
	Copy  func(*ListStreamProcessorsInput) ListStreamProcessorsRequest
}

ListStreamProcessorsRequest is the request type for the ListStreamProcessors API operation.

func (ListStreamProcessorsRequest) Send added in v0.2.0 

func (r ListStreamProcessorsRequest) Send(ctx context.Context) (*ListStreamProcessorsResponse, error)

Send marshals and sends the ListStreamProcessors API request.

type ListStreamProcessorsResponse added in v0.9.0 

type ListStreamProcessorsResponse struct {
	*ListStreamProcessorsOutput
	// contains filtered or unexported fields
}

ListStreamProcessorsResponse is the response type for the ListStreamProcessors API operation.

func (*ListStreamProcessorsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListStreamProcessorsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListStreamProcessors request.

type ModerationLabel 

type ModerationLabel struct {

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

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

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

Provides information about a single type of unsafe 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) String 

func (s ModerationLabel) String() string

String returns the string representation

type MouthOpen 

type MouthOpen struct {

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

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

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

func (MouthOpen) String 

func (s MouthOpen) String() string

String returns the string representation

type Mustache 

type Mustache struct {

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

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

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

func (Mustache) String 

func (s Mustache) String() string

String returns the string representation

type NotificationChannel added in v0.2.0 

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) String added in v0.2.0 

func (s NotificationChannel) String() string

String returns the string representation

func (*NotificationChannel) Validate added in v0.2.0 

func (s *NotificationChannel) Validate() error

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

type OrientationCorrection 

type OrientationCorrection string
const (
	OrientationCorrectionRotate0   OrientationCorrection = "ROTATE_0"
	OrientationCorrectionRotate90  OrientationCorrection = "ROTATE_90"
	OrientationCorrectionRotate180 OrientationCorrection = "ROTATE_180"
	OrientationCorrectionRotate270 OrientationCorrection = "ROTATE_270"
)

Enum values for OrientationCorrection

func (OrientationCorrection) MarshalValue added in v0.3.0 

func (enum OrientationCorrection) MarshalValue() (string, error)

func (OrientationCorrection) MarshalValueBuf added in v0.3.0 

func (enum OrientationCorrection) MarshalValueBuf(b []byte) ([]byte, error)

type OutputConfig added in v0.18.0 

type OutputConfig struct {

	// The S3 bucket where training output is placed.
	S3Bucket *string `min:"3" type:"string"`

	// The prefix applied to the training output files.
	S3KeyPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

The S3 bucket and folder location where training output is placed.

func (OutputConfig) String added in v0.18.0 

func (s OutputConfig) String() string

String returns the string representation

func (*OutputConfig) Validate added in v0.18.0 

func (s *OutputConfig) Validate() error

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

type Parent added in v0.6.0 

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) String added in v0.6.0 

func (s Parent) String() string

String returns the string representation

type PersonDetail added in v0.2.0 

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) String added in v0.2.0 

func (s PersonDetail) String() string

String returns the string representation

type PersonDetection added in v0.2.0 

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) String added in v0.2.0 

func (s PersonDetection) String() string

String returns the string representation

type PersonMatch added in v0.2.0 

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) String added in v0.2.0 

func (s PersonMatch) String() string

String returns the string representation

type PersonTrackingSortBy added in v0.2.0 

type PersonTrackingSortBy string
const (
	PersonTrackingSortByIndex     PersonTrackingSortBy = "INDEX"
	PersonTrackingSortByTimestamp PersonTrackingSortBy = "TIMESTAMP"
)

Enum values for PersonTrackingSortBy

func (PersonTrackingSortBy) MarshalValue added in v0.3.0 

func (enum PersonTrackingSortBy) MarshalValue() (string, error)

func (PersonTrackingSortBy) MarshalValueBuf added in v0.3.0 

func (enum PersonTrackingSortBy) MarshalValueBuf(b []byte) ([]byte, error)

type Point added in v0.2.0 

type Point struct {

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

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

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

An array of Point objects, Polygon, is returned by DetectText and by DetectCustomLabels. Polygon represents a fine-grained polygon around a detected item. For more information, see Geometry in the Amazon Rekognition Developer Guide.

func (Point) String added in v0.2.0 

func (s Point) String() string

String returns the string representation

type Pose 

type Pose struct {

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

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

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

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

func (Pose) String 

func (s Pose) String() string

String returns the string representation

type ProjectDescription added in v0.18.0 

type ProjectDescription struct {

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

	// The Amazon Resource Name (ARN) of the project.
	ProjectArn *string `min:"20" type:"string"`

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

A description of a Amazon Rekognition Custom Labels project.

func (ProjectDescription) String added in v0.18.0 

func (s ProjectDescription) String() string

String returns the string representation

type ProjectStatus added in v0.18.0 

type ProjectStatus string
const (
	ProjectStatusCreating ProjectStatus = "CREATING"
	ProjectStatusCreated  ProjectStatus = "CREATED"
	ProjectStatusDeleting ProjectStatus = "DELETING"
)

Enum values for ProjectStatus

func (ProjectStatus) MarshalValue added in v0.18.0 

func (enum ProjectStatus) MarshalValue() (string, error)

func (ProjectStatus) MarshalValueBuf added in v0.18.0 

func (enum ProjectStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ProjectVersionDescription added in v0.18.0 

type ProjectVersionDescription struct {

	// The duration, in seconds, that the model version has been billed for training.
	// This value is only returned if the model version has been successfully trained.
	BillableTrainingTimeInSeconds *int64 `type:"long"`

	// The Unix datetime for the date and time that training started.
	CreationTimestamp *time.Time `type:"timestamp"`

	// The training results. EvaluationResult is only returned if training is successful.
	EvaluationResult *EvaluationResult `type:"structure"`

	// The minimum number of inference units used by the model. For more information,
	// see StartProjectVersion.
	MinInferenceUnits *int64 `min:"1" type:"integer"`

	// The location where training results are saved.
	OutputConfig *OutputConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the model version.
	ProjectVersionArn *string `min:"20" type:"string"`

	// The current status of the model version.
	Status ProjectVersionStatus `type:"string" enum:"true"`

	// A descriptive message for an error or warning that occurred.
	StatusMessage *string `type:"string"`

	// The manifest file that represents the testing results.
	TestingDataResult *TestingDataResult `type:"structure"`

	// The manifest file that represents the training results.
	TrainingDataResult *TrainingDataResult `type:"structure"`

	// The Unix date and time that training of the model ended.
	TrainingEndTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The description of a version of a model.

func (ProjectVersionDescription) String added in v0.18.0 

func (s ProjectVersionDescription) String() string

String returns the string representation

type ProjectVersionStatus added in v0.18.0 

type ProjectVersionStatus string
const (
	ProjectVersionStatusTrainingInProgress ProjectVersionStatus = "TRAINING_IN_PROGRESS"
	ProjectVersionStatusTrainingCompleted  ProjectVersionStatus = "TRAINING_COMPLETED"
	ProjectVersionStatusTrainingFailed     ProjectVersionStatus = "TRAINING_FAILED"
	ProjectVersionStatusStarting           ProjectVersionStatus = "STARTING"
	ProjectVersionStatusRunning            ProjectVersionStatus = "RUNNING"
	ProjectVersionStatusFailed             ProjectVersionStatus = "FAILED"
	ProjectVersionStatusStopping           ProjectVersionStatus = "STOPPING"
	ProjectVersionStatusStopped            ProjectVersionStatus = "STOPPED"
	ProjectVersionStatusDeleting           ProjectVersionStatus = "DELETING"
)

Enum values for ProjectVersionStatus

func (ProjectVersionStatus) MarshalValue added in v0.18.0 

func (enum ProjectVersionStatus) MarshalValue() (string, error)

func (ProjectVersionStatus) MarshalValueBuf added in v0.18.0 

func (enum ProjectVersionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type QualityFilter added in v0.5.0 

type QualityFilter string
const (
	QualityFilterNone   QualityFilter = "NONE"
	QualityFilterAuto   QualityFilter = "AUTO"
	QualityFilterLow    QualityFilter = "LOW"
	QualityFilterMedium QualityFilter = "MEDIUM"
	QualityFilterHigh   QualityFilter = "HIGH"
)

Enum values for QualityFilter

func (QualityFilter) MarshalValue added in v0.5.0 

func (enum QualityFilter) MarshalValue() (string, error)

func (QualityFilter) MarshalValueBuf added in v0.5.0 

func (enum QualityFilter) MarshalValueBuf(b []byte) ([]byte, error)

type Reason added in v0.5.0 

type Reason string
const (
	ReasonExceedsMaxFaces  Reason = "EXCEEDS_MAX_FACES"
	ReasonExtremePose      Reason = "EXTREME_POSE"
	ReasonLowBrightness    Reason = "LOW_BRIGHTNESS"
	ReasonLowSharpness     Reason = "LOW_SHARPNESS"
	ReasonLowConfidence    Reason = "LOW_CONFIDENCE"
	ReasonSmallBoundingBox Reason = "SMALL_BOUNDING_BOX"
	ReasonLowFaceQuality   Reason = "LOW_FACE_QUALITY"
)

Enum values for Reason

func (Reason) MarshalValue added in v0.5.0 

func (enum Reason) MarshalValue() (string, error)

func (Reason) MarshalValueBuf added in v0.5.0 

func (enum Reason) MarshalValueBuf(b []byte) ([]byte, error)

type RecognizeCelebritiesInput 

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) String 

func (s RecognizeCelebritiesInput) String() string

String returns the string representation

func (*RecognizeCelebritiesInput) Validate 

func (s *RecognizeCelebritiesInput) Validate() error

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

type RecognizeCelebritiesOutput 

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 OrientationCorrection `type:"string" enum:"true"`

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

func (RecognizeCelebritiesOutput) String 

func (s RecognizeCelebritiesOutput) String() string

String returns the string representation

type RecognizeCelebritiesRequest 

type RecognizeCelebritiesRequest struct {
	*aws.Request
	Input *RecognizeCelebritiesInput
	Copy  func(*RecognizeCelebritiesInput) RecognizeCelebritiesRequest
}

RecognizeCelebritiesRequest is the request type for the RecognizeCelebrities API operation.

func (RecognizeCelebritiesRequest) Send 

func (r RecognizeCelebritiesRequest) Send(ctx context.Context) (*RecognizeCelebritiesResponse, error)

Send marshals and sends the RecognizeCelebrities API request.

type RecognizeCelebritiesResponse added in v0.9.0 

type RecognizeCelebritiesResponse struct {
	*RecognizeCelebritiesOutput
	// contains filtered or unexported fields
}

RecognizeCelebritiesResponse is the response type for the RecognizeCelebrities API operation.

func (*RecognizeCelebritiesResponse) SDKResponseMetdata added in v0.9.0 

func (r *RecognizeCelebritiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RecognizeCelebrities request.

type RegionOfInterest added in v0.20.0 

type RegionOfInterest struct {

	// The box representing a region of interest on screen.
	BoundingBox *BoundingBox `type:"structure"`
	// contains filtered or unexported fields
}

Specifies a location within the frame that Rekognition checks for text. Uses a BoundingBox object to set a region of the screen.

A word is included in the region if the word is more than half in that region. If there is more than one region, the word will be compared with all regions of the screen. Any word more than half in a region is kept in the results.

func (RegionOfInterest) String added in v0.20.0 

func (s RegionOfInterest) String() string

String returns the string representation

type S3Object 

type S3Object struct {

	// Name of the S3 bucket.
	Bucket *string `min:"3" type:"string"`

	// S3 object key name.
	Name *string `min:"1" type:"string"`

	// If the bucket is versioning enabled, you can specify the object version.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides the S3 bucket name and object name.

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

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

func (S3Object) String 

func (s S3Object) String() string

String returns the string representation

func (*S3Object) Validate 

func (s *S3Object) Validate() error

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

type SearchFacesByImageInput 

type SearchFacesByImageInput struct {

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

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

	// The input image as base64-encoded bytes or an S3 object. If you use the AWS
	// CLI to call Amazon Rekognition operations, passing base64-encoded image bytes
	// is not supported.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need
	// to base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// Image is a required field
	Image *Image `type:"structure" required:"true"`

	// Maximum number of faces to return. The operation returns the maximum number
	// of faces with the highest confidence in the match.
	MaxFaces *int64 `min:"1" type:"integer"`

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

func (SearchFacesByImageInput) String 

func (s SearchFacesByImageInput) String() string

String returns the string representation

func (*SearchFacesByImageInput) Validate 

func (s *SearchFacesByImageInput) Validate() error

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

type SearchFacesByImageOutput 

type SearchFacesByImageOutput struct {

	// An array of faces that match the input face, along with the confidence in
	// the match.
	FaceMatches []FaceMatch `type:"list"`

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

	// The bounding box around the face in the input image that Amazon Rekognition
	// used for the search.
	SearchedFaceBoundingBox *BoundingBox `type:"structure"`

	// The level of confidence that the searchedFaceBoundingBox, contains a face.
	SearchedFaceConfidence *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (SearchFacesByImageOutput) String 

func (s SearchFacesByImageOutput) String() string

String returns the string representation

type SearchFacesByImageRequest 

type SearchFacesByImageRequest struct {
	*aws.Request
	Input *SearchFacesByImageInput
	Copy  func(*SearchFacesByImageInput) SearchFacesByImageRequest
}

SearchFacesByImageRequest is the request type for the SearchFacesByImage API operation.

func (SearchFacesByImageRequest) Send 

func (r SearchFacesByImageRequest) Send(ctx context.Context) (*SearchFacesByImageResponse, error)

Send marshals and sends the SearchFacesByImage API request.

type SearchFacesByImageResponse added in v0.9.0 

type SearchFacesByImageResponse struct {
	*SearchFacesByImageOutput
	// contains filtered or unexported fields
}

SearchFacesByImageResponse is the response type for the SearchFacesByImage API operation.

func (*SearchFacesByImageResponse) SDKResponseMetdata added in v0.9.0 

func (r *SearchFacesByImageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchFacesByImage request.

type SearchFacesInput 

type SearchFacesInput struct {

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

	// ID of a face to find matches for in the collection.
	//
	// FaceId is a required field
	FaceId *string `type:"string" required:"true"`

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

	// Maximum number of faces to return. The operation returns the maximum number
	// of faces with the highest confidence in the match.
	MaxFaces *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (SearchFacesInput) String 

func (s SearchFacesInput) String() string

String returns the string representation

func (*SearchFacesInput) Validate 

func (s *SearchFacesInput) Validate() error

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

type SearchFacesOutput 

type SearchFacesOutput struct {

	// An array of faces that matched the input face, along with the confidence
	// in the match.
	FaceMatches []FaceMatch `type:"list"`

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

	// ID of the face that was searched for matches in a collection.
	SearchedFaceId *string `type:"string"`
	// contains filtered or unexported fields
}

func (SearchFacesOutput) String 

func (s SearchFacesOutput) String() string

String returns the string representation

type SearchFacesRequest 

type SearchFacesRequest struct {
	*aws.Request
	Input *SearchFacesInput
	Copy  func(*SearchFacesInput) SearchFacesRequest
}

SearchFacesRequest is the request type for the SearchFaces API operation.

func (SearchFacesRequest) Send 

func (r SearchFacesRequest) Send(ctx context.Context) (*SearchFacesResponse, error)

Send marshals and sends the SearchFaces API request.

type SearchFacesResponse added in v0.9.0 

type SearchFacesResponse struct {
	*SearchFacesOutput
	// contains filtered or unexported fields
}

SearchFacesResponse is the response type for the SearchFaces API operation.

func (*SearchFacesResponse) SDKResponseMetdata added in v0.9.0 

func (r *SearchFacesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchFaces request.

type SegmentDetection added in v0.24.0 

type SegmentDetection struct {

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

	// The duration of the timecode for the detected segment in SMPTE format.
	DurationSMPTE *string `type:"string"`

	// The frame-accurate SMPTE timecode, from the start of a video, for the end
	// of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for
	// drop frame-rates).
	EndTimecodeSMPTE *string `type:"string"`

	// The end time of the detected segment, in milliseconds, from the start of
	// the video.
	EndTimestampMillis *int64 `type:"long"`

	// If the segment is a shot detection, contains information about the shot detection.
	ShotSegment *ShotSegment `type:"structure"`

	// The frame-accurate SMPTE timecode, from the start of a video, for the start
	// of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for
	// drop frame-rates).
	StartTimecodeSMPTE *string `type:"string"`

	// The start time of the detected segment in milliseconds from the start of
	// the video.
	StartTimestampMillis *int64 `type:"long"`

	// If the segment is a technical cue, contains information about the technical
	// cue.
	TechnicalCueSegment *TechnicalCueSegment `type:"structure"`

	// The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
	Type SegmentType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A technical cue or shot detection segment detected in a video. An array of SegmentDetection objects containing all segments detected in a stored video is returned by GetSegmentDetection.

func (SegmentDetection) String added in v0.24.0 

func (s SegmentDetection) String() string

String returns the string representation

type SegmentType added in v0.24.0 

type SegmentType string
const (
	SegmentTypeTechnicalCue SegmentType = "TECHNICAL_CUE"
	SegmentTypeShot         SegmentType = "SHOT"
)

Enum values for SegmentType

func (SegmentType) MarshalValue added in v0.24.0 

func (enum SegmentType) MarshalValue() (string, error)

func (SegmentType) MarshalValueBuf added in v0.24.0 

func (enum SegmentType) MarshalValueBuf(b []byte) ([]byte, error)

type SegmentTypeInfo added in v0.24.0 

type SegmentTypeInfo struct {

	// The version of the model used to detect segments.
	ModelVersion *string `type:"string"`

	// The type of a segment (technical cue or shot detection).
	Type SegmentType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about the type of a segment requested in a call to StartSegmentDetection. An array of SegmentTypeInfo objects is returned by the response from GetSegmentDetection.

func (SegmentTypeInfo) String added in v0.24.0 

func (s SegmentTypeInfo) String() string

String returns the string representation

type ShotSegment added in v0.24.0 

type ShotSegment struct {

	// The confidence that Amazon Rekognition Video has in the accuracy of the detected
	// segment.
	Confidence *float64 `min:"50" type:"float"`

	// An Identifier for a shot detection segment detected in a video
	Index *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a shot detection segment detected in a video. For more information, see SegmentDetection.

func (ShotSegment) String added in v0.24.0 

func (s ShotSegment) String() string

String returns the string representation

type Smile 

type Smile struct {

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

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

Indicates whether or not the face is smiling, and the confidence level in the determination.

func (Smile) String 

func (s Smile) String() string

String returns the string representation

type StartCelebrityRecognitionInput added in v0.2.0 

type StartCelebrityRecognitionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartCelebrityRecognition requests, the same JobId is
	// returned. Use ClientRequestToken to prevent the same job from being accidently
	// started more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish
	// the completion status of the celebrity recognition analysis to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to recognize celebrities. The video must be stored
	// in an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartCelebrityRecognitionInput) String added in v0.2.0 

func (s StartCelebrityRecognitionInput) String() string

String returns the string representation

func (*StartCelebrityRecognitionInput) Validate added in v0.2.0 

func (s *StartCelebrityRecognitionInput) Validate() error

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

type StartCelebrityRecognitionOutput added in v0.2.0 

type StartCelebrityRecognitionOutput struct {

	// The identifier for the celebrity recognition analysis job. Use JobId to identify
	// the job in a subsequent call to GetCelebrityRecognition.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartCelebrityRecognitionOutput) String added in v0.2.0 

func (s StartCelebrityRecognitionOutput) String() string

String returns the string representation

type StartCelebrityRecognitionRequest added in v0.2.0 

type StartCelebrityRecognitionRequest struct {
	*aws.Request
	Input *StartCelebrityRecognitionInput
	Copy  func(*StartCelebrityRecognitionInput) StartCelebrityRecognitionRequest
}

StartCelebrityRecognitionRequest is the request type for the StartCelebrityRecognition API operation.

func (StartCelebrityRecognitionRequest) Send added in v0.2.0 

func (r StartCelebrityRecognitionRequest) Send(ctx context.Context) (*StartCelebrityRecognitionResponse, error)

Send marshals and sends the StartCelebrityRecognition API request.

type StartCelebrityRecognitionResponse added in v0.9.0 

type StartCelebrityRecognitionResponse struct {
	*StartCelebrityRecognitionOutput
	// contains filtered or unexported fields
}

StartCelebrityRecognitionResponse is the response type for the StartCelebrityRecognition API operation.

func (*StartCelebrityRecognitionResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartCelebrityRecognitionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartCelebrityRecognition request.

type StartContentModerationInput added in v0.2.0 

type StartContentModerationInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartContentModeration requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// Specifies the minimum confidence that Amazon Rekognition must have in order
	// to return a moderated content label. Confidence represents how certain Amazon
	// Rekognition is that the moderated content is correctly identified. 0 is the
	// lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't
	// return any moderated content labels with a confidence level lower than this
	// specified value. If you don't specify MinConfidence, GetContentModeration
	// returns labels with confidence values greater than or equal to 50 percent.
	MinConfidence *float64 `type:"float"`

	// The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish
	// the completion status of the unsafe content analysis to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect unsafe content. The video must be stored
	// in an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartContentModerationInput) String added in v0.2.0 

func (s StartContentModerationInput) String() string

String returns the string representation

func (*StartContentModerationInput) Validate added in v0.2.0 

func (s *StartContentModerationInput) Validate() error

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

type StartContentModerationOutput added in v0.2.0 

type StartContentModerationOutput struct {

	// The identifier for the unsafe content analysis job. Use JobId to identify
	// the job in a subsequent call to GetContentModeration.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartContentModerationOutput) String added in v0.2.0 

func (s StartContentModerationOutput) String() string

String returns the string representation

type StartContentModerationRequest added in v0.2.0 

type StartContentModerationRequest struct {
	*aws.Request
	Input *StartContentModerationInput
	Copy  func(*StartContentModerationInput) StartContentModerationRequest
}

StartContentModerationRequest is the request type for the StartContentModeration API operation.

func (StartContentModerationRequest) Send added in v0.2.0 

func (r StartContentModerationRequest) Send(ctx context.Context) (*StartContentModerationResponse, error)

Send marshals and sends the StartContentModeration API request.

type StartContentModerationResponse added in v0.9.0 

type StartContentModerationResponse struct {
	*StartContentModerationOutput
	// contains filtered or unexported fields
}

StartContentModerationResponse is the response type for the StartContentModeration API operation.

func (*StartContentModerationResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartContentModerationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartContentModeration request.

type StartFaceDetectionInput added in v0.2.0 

type StartFaceDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartFaceDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// The face attributes you want returned.
	//
	// DEFAULT - The following subset of facial attributes are returned: BoundingBox,
	// Confidence, Pose, Quality and Landmarks.
	//
	// ALL - All facial attributes are returned.
	FaceAttributes FaceAttributes `type:"string" enum:"true"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video
	// to publish the completion status of the face detection operation.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect faces. The video must be stored in
	// an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartFaceDetectionInput) String added in v0.2.0 

func (s StartFaceDetectionInput) String() string

String returns the string representation

func (*StartFaceDetectionInput) Validate added in v0.2.0 

func (s *StartFaceDetectionInput) Validate() error

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

type StartFaceDetectionOutput added in v0.2.0 

type StartFaceDetectionOutput struct {

	// The identifier for the face detection job. Use JobId to identify the job
	// in a subsequent call to GetFaceDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartFaceDetectionOutput) String added in v0.2.0 

func (s StartFaceDetectionOutput) String() string

String returns the string representation

type StartFaceDetectionRequest added in v0.2.0 

type StartFaceDetectionRequest struct {
	*aws.Request
	Input *StartFaceDetectionInput
	Copy  func(*StartFaceDetectionInput) StartFaceDetectionRequest
}

StartFaceDetectionRequest is the request type for the StartFaceDetection API operation.

func (StartFaceDetectionRequest) Send added in v0.2.0 

func (r StartFaceDetectionRequest) Send(ctx context.Context) (*StartFaceDetectionResponse, error)

Send marshals and sends the StartFaceDetection API request.

type StartFaceDetectionResponse added in v0.9.0 

type StartFaceDetectionResponse struct {
	*StartFaceDetectionOutput
	// contains filtered or unexported fields
}

StartFaceDetectionResponse is the response type for the StartFaceDetection API operation.

func (*StartFaceDetectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartFaceDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartFaceDetection request.

type StartFaceSearchInput added in v0.2.0 

type StartFaceSearchInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartFaceSearch requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// ID of the collection that contains the faces you want to search for.
	//
	// CollectionId is a required field
	CollectionId *string `min:"1" type:"string" required:"true"`

	// The minimum confidence in the person match to return. For example, don't
	// return any matches where confidence in matches is less than 70%. The default
	// value is 80%.
	FaceMatchThreshold *float64 `type:"float"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video
	// to publish the completion status of the search.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video you want to search. The video must be stored in an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartFaceSearchInput) String added in v0.2.0 

func (s StartFaceSearchInput) String() string

String returns the string representation

func (*StartFaceSearchInput) Validate added in v0.2.0 

func (s *StartFaceSearchInput) Validate() error

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

type StartFaceSearchOutput added in v0.2.0 

type StartFaceSearchOutput struct {

	// The identifier for the search job. Use JobId to identify the job in a subsequent
	// call to GetFaceSearch.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartFaceSearchOutput) String added in v0.2.0 

func (s StartFaceSearchOutput) String() string

String returns the string representation

type StartFaceSearchRequest added in v0.2.0 

type StartFaceSearchRequest struct {
	*aws.Request
	Input *StartFaceSearchInput
	Copy  func(*StartFaceSearchInput) StartFaceSearchRequest
}

StartFaceSearchRequest is the request type for the StartFaceSearch API operation.

func (StartFaceSearchRequest) Send added in v0.2.0 

func (r StartFaceSearchRequest) Send(ctx context.Context) (*StartFaceSearchResponse, error)

Send marshals and sends the StartFaceSearch API request.

type StartFaceSearchResponse added in v0.9.0 

type StartFaceSearchResponse struct {
	*StartFaceSearchOutput
	// contains filtered or unexported fields
}

StartFaceSearchResponse is the response type for the StartFaceSearch API operation.

func (*StartFaceSearchResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartFaceSearchResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartFaceSearch request.

type StartLabelDetectionInput added in v0.2.0 

type StartLabelDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartLabelDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// Specifies the minimum confidence that Amazon Rekognition Video must have
	// in order to return a detected label. Confidence represents how certain Amazon
	// Rekognition is that a label is correctly identified.0 is the lowest confidence.
	// 100 is the highest confidence. Amazon Rekognition Video doesn't return any
	// labels with a confidence level lower than this specified value.
	//
	// If you don't specify MinConfidence, the operation returns labels with confidence
	// values greater than or equal to 50 percent.
	MinConfidence *float64 `type:"float"`

	// The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the
	// completion status of the label detection operation to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect labels. The video must be stored in
	// an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartLabelDetectionInput) String added in v0.2.0 

func (s StartLabelDetectionInput) String() string

String returns the string representation

func (*StartLabelDetectionInput) Validate added in v0.2.0 

func (s *StartLabelDetectionInput) Validate() error

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

type StartLabelDetectionOutput added in v0.2.0 

type StartLabelDetectionOutput struct {

	// The identifier for the label detection job. Use JobId to identify the job
	// in a subsequent call to GetLabelDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartLabelDetectionOutput) String added in v0.2.0 

func (s StartLabelDetectionOutput) String() string

String returns the string representation

type StartLabelDetectionRequest added in v0.2.0 

type StartLabelDetectionRequest struct {
	*aws.Request
	Input *StartLabelDetectionInput
	Copy  func(*StartLabelDetectionInput) StartLabelDetectionRequest
}

StartLabelDetectionRequest is the request type for the StartLabelDetection API operation.

func (StartLabelDetectionRequest) Send added in v0.2.0 

func (r StartLabelDetectionRequest) Send(ctx context.Context) (*StartLabelDetectionResponse, error)

Send marshals and sends the StartLabelDetection API request.

type StartLabelDetectionResponse added in v0.9.0 

type StartLabelDetectionResponse struct {
	*StartLabelDetectionOutput
	// contains filtered or unexported fields
}

StartLabelDetectionResponse is the response type for the StartLabelDetection API operation.

func (*StartLabelDetectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartLabelDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartLabelDetection request.

type StartPersonTrackingInput added in v0.2.0 

type StartPersonTrackingInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartPersonTracking requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the
	// completion status of the people detection operation to.
	NotificationChannel *NotificationChannel `type:"structure"`

	// The video in which you want to detect people. The video must be stored in
	// an Amazon S3 bucket.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartPersonTrackingInput) String added in v0.2.0 

func (s StartPersonTrackingInput) String() string

String returns the string representation

func (*StartPersonTrackingInput) Validate added in v0.2.0 

func (s *StartPersonTrackingInput) Validate() error

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

type StartPersonTrackingOutput added in v0.2.0 

type StartPersonTrackingOutput struct {

	// The identifier for the person detection job. Use JobId to identify the job
	// in a subsequent call to GetPersonTracking.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartPersonTrackingOutput) String added in v0.2.0 

func (s StartPersonTrackingOutput) String() string

String returns the string representation

type StartPersonTrackingRequest added in v0.2.0 

type StartPersonTrackingRequest struct {
	*aws.Request
	Input *StartPersonTrackingInput
	Copy  func(*StartPersonTrackingInput) StartPersonTrackingRequest
}

StartPersonTrackingRequest is the request type for the StartPersonTracking API operation.

func (StartPersonTrackingRequest) Send added in v0.2.0 

func (r StartPersonTrackingRequest) Send(ctx context.Context) (*StartPersonTrackingResponse, error)

Send marshals and sends the StartPersonTracking API request.

type StartPersonTrackingResponse added in v0.9.0 

type StartPersonTrackingResponse struct {
	*StartPersonTrackingOutput
	// contains filtered or unexported fields
}

StartPersonTrackingResponse is the response type for the StartPersonTracking API operation.

func (*StartPersonTrackingResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartPersonTrackingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartPersonTracking request.

type StartProjectVersionInput added in v0.18.0 

type StartProjectVersionInput struct {

	// The minimum number of inference units to use. A single inference unit represents
	// 1 hour of processing and can support up to 5 Transaction Pers Second (TPS).
	// Use a higher number to increase the TPS throughput of your model. You are
	// charged for the number of inference units that you use.
	//
	// MinInferenceUnits is a required field
	MinInferenceUnits *int64 `min:"1" type:"integer" required:"true"`

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

func (StartProjectVersionInput) String added in v0.18.0 

func (s StartProjectVersionInput) String() string

String returns the string representation

func (*StartProjectVersionInput) Validate added in v0.18.0 

func (s *StartProjectVersionInput) Validate() error

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

type StartProjectVersionOutput added in v0.18.0 

type StartProjectVersionOutput struct {

	// The current running status of the model.
	Status ProjectVersionStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (StartProjectVersionOutput) String added in v0.18.0 

func (s StartProjectVersionOutput) String() string

String returns the string representation

type StartProjectVersionRequest added in v0.18.0 

type StartProjectVersionRequest struct {
	*aws.Request
	Input *StartProjectVersionInput
	Copy  func(*StartProjectVersionInput) StartProjectVersionRequest
}

StartProjectVersionRequest is the request type for the StartProjectVersion API operation.

func (StartProjectVersionRequest) Send added in v0.18.0 

func (r StartProjectVersionRequest) Send(ctx context.Context) (*StartProjectVersionResponse, error)

Send marshals and sends the StartProjectVersion API request.

type StartProjectVersionResponse added in v0.18.0 

type StartProjectVersionResponse struct {
	*StartProjectVersionOutput
	// contains filtered or unexported fields
}

StartProjectVersionResponse is the response type for the StartProjectVersion API operation.

func (*StartProjectVersionResponse) SDKResponseMetdata added in v0.18.0 

func (r *StartProjectVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartProjectVersion request.

type StartSegmentDetectionFilters added in v0.24.0 

type StartSegmentDetectionFilters struct {

	// Filters that are specific to shot detections.
	ShotFilter *StartShotDetectionFilter `type:"structure"`

	// Filters that are specific to technical cues.
	TechnicalCueFilter *StartTechnicalCueDetectionFilter `type:"structure"`
	// contains filtered or unexported fields
}

Filters applied to the technical cue or shot detection segments. For more information, see StartSegmentDetection.

func (StartSegmentDetectionFilters) String added in v0.24.0 

func (s StartSegmentDetectionFilters) String() string

String returns the string representation

func (*StartSegmentDetectionFilters) Validate added in v0.24.0 

func (s *StartSegmentDetectionFilters) Validate() error

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

type StartSegmentDetectionInput added in v0.24.0 

type StartSegmentDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartSegmentDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidently started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

	// Filters for technical cue or shot detection.
	Filters *StartSegmentDetectionFilters `type:"structure"`

	// An identifier you specify that's returned in the completion notification
	// that's published to your Amazon Simple Notification Service topic. For example,
	// you can use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string `min:"1" type:"string"`

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video
	// to publish the completion status of the segment detection operation.
	NotificationChannel *NotificationChannel `type:"structure"`

	// An array of segment types to detect in the video. Valid values are TECHNICAL_CUE
	// and SHOT.
	//
	// SegmentTypes is a required field
	SegmentTypes []SegmentType `min:"1" type:"list" required:"true"`

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetection use Video to specify a video for analysis.
	// The supported file formats are .mp4, .mov and .avi.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartSegmentDetectionInput) String added in v0.24.0 

func (s StartSegmentDetectionInput) String() string

String returns the string representation

func (*StartSegmentDetectionInput) Validate added in v0.24.0 

func (s *StartSegmentDetectionInput) Validate() error

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

type StartSegmentDetectionOutput added in v0.24.0 

type StartSegmentDetectionOutput struct {

	// Unique identifier for the segment detection job. The JobId is returned from
	// StartSegmentDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartSegmentDetectionOutput) String added in v0.24.0 

func (s StartSegmentDetectionOutput) String() string

String returns the string representation

type StartSegmentDetectionRequest added in v0.24.0 

type StartSegmentDetectionRequest struct {
	*aws.Request
	Input *StartSegmentDetectionInput
	Copy  func(*StartSegmentDetectionInput) StartSegmentDetectionRequest
}

StartSegmentDetectionRequest is the request type for the StartSegmentDetection API operation.

func (StartSegmentDetectionRequest) Send added in v0.24.0 

func (r StartSegmentDetectionRequest) Send(ctx context.Context) (*StartSegmentDetectionResponse, error)

Send marshals and sends the StartSegmentDetection API request.

type StartSegmentDetectionResponse added in v0.24.0 

type StartSegmentDetectionResponse struct {
	*StartSegmentDetectionOutput
	// contains filtered or unexported fields
}

StartSegmentDetectionResponse is the response type for the StartSegmentDetection API operation.

func (*StartSegmentDetectionResponse) SDKResponseMetdata added in v0.24.0 

func (r *StartSegmentDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartSegmentDetection request.

type StartShotDetectionFilter added in v0.24.0 

type StartShotDetectionFilter struct {

	// Specifies the minimum confidence that Amazon Rekognition Video must have
	// in order to return a detected segment. Confidence represents how certain
	// Amazon Rekognition is that a segment is correctly identified. 0 is the lowest
	// confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't
	// return any segments with a confidence level lower than this specified value.
	//
	// If you don't specify MinSegmentConfidence, the GetSegmentDetection returns
	// segments with confidence values greater than or equal to 50 percent.
	MinSegmentConfidence *float64 `min:"50" type:"float"`
	// contains filtered or unexported fields
}

Filters for the shot detection segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.

func (StartShotDetectionFilter) String added in v0.24.0 

func (s StartShotDetectionFilter) String() string

String returns the string representation

func (*StartShotDetectionFilter) Validate added in v0.24.0 

func (s *StartShotDetectionFilter) Validate() error

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

type StartStreamProcessorInput added in v0.2.0 

type StartStreamProcessorInput struct {

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

func (StartStreamProcessorInput) String added in v0.2.0 

func (s StartStreamProcessorInput) String() string

String returns the string representation

func (*StartStreamProcessorInput) Validate added in v0.2.0 

func (s *StartStreamProcessorInput) Validate() error

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

type StartStreamProcessorOutput added in v0.2.0 

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

func (StartStreamProcessorOutput) String added in v0.2.0 

func (s StartStreamProcessorOutput) String() string

String returns the string representation

type StartStreamProcessorRequest added in v0.2.0 

type StartStreamProcessorRequest struct {
	*aws.Request
	Input *StartStreamProcessorInput
	Copy  func(*StartStreamProcessorInput) StartStreamProcessorRequest
}

StartStreamProcessorRequest is the request type for the StartStreamProcessor API operation.

func (StartStreamProcessorRequest) Send added in v0.2.0 

func (r StartStreamProcessorRequest) Send(ctx context.Context) (*StartStreamProcessorResponse, error)

Send marshals and sends the StartStreamProcessor API request.

type StartStreamProcessorResponse added in v0.9.0 

type StartStreamProcessorResponse struct {
	*StartStreamProcessorOutput
	// contains filtered or unexported fields
}

StartStreamProcessorResponse is the response type for the StartStreamProcessor API operation.

func (*StartStreamProcessorResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartStreamProcessorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartStreamProcessor request.

type StartTechnicalCueDetectionFilter added in v0.24.0 

type StartTechnicalCueDetectionFilter struct {

	// Specifies the minimum confidence that Amazon Rekognition Video must have
	// in order to return a detected segment. Confidence represents how certain
	// Amazon Rekognition is that a segment is correctly identified. 0 is the lowest
	// confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't
	// return any segments with a confidence level lower than this specified value.
	//
	// If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments
	// with confidence values greater than or equal to 50 percent.
	MinSegmentConfidence *float64 `min:"50" type:"float"`
	// contains filtered or unexported fields
}

Filters for the technical segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.

func (StartTechnicalCueDetectionFilter) String added in v0.24.0 

func (s StartTechnicalCueDetectionFilter) String() string

String returns the string representation

func (*StartTechnicalCueDetectionFilter) Validate added in v0.24.0 

func (s *StartTechnicalCueDetectionFilter) Validate() error

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

type StartTextDetectionFilters added in v0.20.0 

type StartTextDetectionFilters struct {

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

	// Filters focusing on qualities of the text, such as confidence or size.
	WordFilter *DetectionFilter `type:"structure"`
	// contains filtered or unexported fields
}

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

func (StartTextDetectionFilters) String added in v0.20.0 

func (s StartTextDetectionFilters) String() string

String returns the string representation

type StartTextDetectionInput added in v0.20.0 

type StartTextDetectionInput struct {

	// Idempotent token used to identify the start request. If you use the same
	// token with multiple StartTextDetection requests, the same JobId is returned.
	// Use ClientRequestToken to prevent the same job from being accidentaly started
	// more than once.
	ClientRequestToken *string `min:"1" type:"string"`

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

	// An identifier returned in the completion status published by your Amazon
	// Simple Notification Service topic. For example, you can use JobTag to group
	// related jobs and identify them in the completion notification.
	JobTag *string `min:"1" type:"string"`

	// The Amazon Simple Notification Service topic to which Amazon Rekognition
	// publishes the completion status of a video analysis operation. For more information,
	// see api-video.
	NotificationChannel *NotificationChannel `type:"structure"`

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetection use Video to specify a video for analysis.
	// The supported file formats are .mp4, .mov and .avi.
	//
	// Video is a required field
	Video *Video `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartTextDetectionInput) String added in v0.20.0 

func (s StartTextDetectionInput) String() string

String returns the string representation

func (*StartTextDetectionInput) Validate added in v0.20.0 

func (s *StartTextDetectionInput) Validate() error

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

type StartTextDetectionOutput added in v0.20.0 

type StartTextDetectionOutput struct {

	// Identifier for the text detection job. Use JobId to identify the job in a
	// subsequent call to GetTextDetection.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartTextDetectionOutput) String added in v0.20.0 

func (s StartTextDetectionOutput) String() string

String returns the string representation

type StartTextDetectionRequest added in v0.20.0 

type StartTextDetectionRequest struct {
	*aws.Request
	Input *StartTextDetectionInput
	Copy  func(*StartTextDetectionInput) StartTextDetectionRequest
}

StartTextDetectionRequest is the request type for the StartTextDetection API operation.

func (StartTextDetectionRequest) Send added in v0.20.0 

func (r StartTextDetectionRequest) Send(ctx context.Context) (*StartTextDetectionResponse, error)

Send marshals and sends the StartTextDetection API request.

type StartTextDetectionResponse added in v0.20.0 

type StartTextDetectionResponse struct {
	*StartTextDetectionOutput
	// contains filtered or unexported fields
}

StartTextDetectionResponse is the response type for the StartTextDetection API operation.

func (*StartTextDetectionResponse) SDKResponseMetdata added in v0.20.0 

func (r *StartTextDetectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartTextDetection request.

type StopProjectVersionInput added in v0.18.0 

type StopProjectVersionInput struct {

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

func (StopProjectVersionInput) String added in v0.18.0 

func (s StopProjectVersionInput) String() string

String returns the string representation

func (*StopProjectVersionInput) Validate added in v0.18.0 

func (s *StopProjectVersionInput) Validate() error

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

type StopProjectVersionOutput added in v0.18.0 

type StopProjectVersionOutput struct {

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

func (StopProjectVersionOutput) String added in v0.18.0 

func (s StopProjectVersionOutput) String() string

String returns the string representation

type StopProjectVersionRequest added in v0.18.0 

type StopProjectVersionRequest struct {
	*aws.Request
	Input *StopProjectVersionInput
	Copy  func(*StopProjectVersionInput) StopProjectVersionRequest
}

StopProjectVersionRequest is the request type for the StopProjectVersion API operation.

func (StopProjectVersionRequest) Send added in v0.18.0 

func (r StopProjectVersionRequest) Send(ctx context.Context) (*StopProjectVersionResponse, error)

Send marshals and sends the StopProjectVersion API request.

type StopProjectVersionResponse added in v0.18.0 

type StopProjectVersionResponse struct {
	*StopProjectVersionOutput
	// contains filtered or unexported fields
}

StopProjectVersionResponse is the response type for the StopProjectVersion API operation.

func (*StopProjectVersionResponse) SDKResponseMetdata added in v0.18.0 

func (r *StopProjectVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopProjectVersion request.

type StopStreamProcessorInput added in v0.2.0 

type StopStreamProcessorInput struct {

	// The name of a stream processor created by CreateStreamProcessor.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopStreamProcessorInput) String added in v0.2.0 

func (s StopStreamProcessorInput) String() string

String returns the string representation

func (*StopStreamProcessorInput) Validate added in v0.2.0 

func (s *StopStreamProcessorInput) Validate() error

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

type StopStreamProcessorOutput added in v0.2.0 

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

func (StopStreamProcessorOutput) String added in v0.2.0 

func (s StopStreamProcessorOutput) String() string

String returns the string representation

type StopStreamProcessorRequest added in v0.2.0 

type StopStreamProcessorRequest struct {
	*aws.Request
	Input *StopStreamProcessorInput
	Copy  func(*StopStreamProcessorInput) StopStreamProcessorRequest
}

StopStreamProcessorRequest is the request type for the StopStreamProcessor API operation.

func (StopStreamProcessorRequest) Send added in v0.2.0 

func (r StopStreamProcessorRequest) Send(ctx context.Context) (*StopStreamProcessorResponse, error)

Send marshals and sends the StopStreamProcessor API request.

type StopStreamProcessorResponse added in v0.9.0 

type StopStreamProcessorResponse struct {
	*StopStreamProcessorOutput
	// contains filtered or unexported fields
}

StopStreamProcessorResponse is the response type for the StopStreamProcessor API operation.

func (*StopStreamProcessorResponse) SDKResponseMetdata added in v0.9.0 

func (r *StopStreamProcessorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopStreamProcessor request.

type StreamProcessor added in v0.2.0 

type StreamProcessor struct {

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

	// Current status of the Amazon Rekognition stream processor.
	Status StreamProcessorStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

func (StreamProcessor) String added in v0.2.0 

func (s StreamProcessor) String() string

String returns the string representation

type StreamProcessorInput added in v0.2.0 

type StreamProcessorInput struct {

	// The Kinesis video stream input stream for the source streaming video.
	KinesisVideoStream *KinesisVideoStream `type:"structure"`
	// contains filtered or unexported fields
}

Information about the source streaming video.

func (StreamProcessorInput) String added in v0.2.0 

func (s StreamProcessorInput) String() string

String returns the string representation

type StreamProcessorOutput added in v0.2.0 

type StreamProcessorOutput struct {

	// The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream
	// processor streams the analysis results.
	KinesisDataStream *KinesisDataStream `type:"structure"`
	// contains filtered or unexported fields
}

Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

func (StreamProcessorOutput) String added in v0.2.0 

func (s StreamProcessorOutput) String() string

String returns the string representation

type StreamProcessorSettings added in v0.2.0 

type StreamProcessorSettings struct {

	// Face search settings to use on a streaming video.
	FaceSearch *FaceSearchSettings `type:"structure"`
	// contains filtered or unexported fields
}

Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

func (StreamProcessorSettings) String added in v0.2.0 

func (s StreamProcessorSettings) String() string

String returns the string representation

func (*StreamProcessorSettings) Validate added in v0.2.0 

func (s *StreamProcessorSettings) Validate() error

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

type StreamProcessorStatus added in v0.2.0 

type StreamProcessorStatus string
const (
	StreamProcessorStatusStopped  StreamProcessorStatus = "STOPPED"
	StreamProcessorStatusStarting StreamProcessorStatus = "STARTING"
	StreamProcessorStatusRunning  StreamProcessorStatus = "RUNNING"
	StreamProcessorStatusFailed   StreamProcessorStatus = "FAILED"
	StreamProcessorStatusStopping StreamProcessorStatus = "STOPPING"
)

Enum values for StreamProcessorStatus

func (StreamProcessorStatus) MarshalValue added in v0.3.0 

func (enum StreamProcessorStatus) MarshalValue() (string, error)

func (StreamProcessorStatus) MarshalValueBuf added in v0.3.0 

func (enum StreamProcessorStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Summary added in v0.18.0 

type Summary struct {

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

The S3 bucket that contains the training summary. The training summary includes aggregated evaluation metrics for the entire testing dataset and metrics for each individual label.

You get the training summary S3 bucket location by calling DescribeProjectVersions.

func (Summary) String added in v0.18.0 

func (s Summary) String() string

String returns the string representation

type Sunglasses 

type Sunglasses struct {

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

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

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

func (Sunglasses) String 

func (s Sunglasses) String() string

String returns the string representation

type TechnicalCueSegment added in v0.24.0 

type TechnicalCueSegment struct {

	// The confidence that Amazon Rekognition Video has in the accuracy of the detected
	// segment.
	Confidence *float64 `min:"50" type:"float"`

	// The type of the technical cue.
	Type TechnicalCueType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about a technical cue segment. For more information, see SegmentDetection.

func (TechnicalCueSegment) String added in v0.24.0 

func (s TechnicalCueSegment) String() string

String returns the string representation

type TechnicalCueType added in v0.24.0 

type TechnicalCueType string
const (
	TechnicalCueTypeColorBars   TechnicalCueType = "ColorBars"
	TechnicalCueTypeEndCredits  TechnicalCueType = "EndCredits"
	TechnicalCueTypeBlackFrames TechnicalCueType = "BlackFrames"
)

Enum values for TechnicalCueType

func (TechnicalCueType) MarshalValue added in v0.24.0 

func (enum TechnicalCueType) MarshalValue() (string, error)

func (TechnicalCueType) MarshalValueBuf added in v0.24.0 

func (enum TechnicalCueType) MarshalValueBuf(b []byte) ([]byte, error)

type TestingData added in v0.18.0 

type TestingData struct {

	// The assets used for testing.
	Assets []Asset `type:"list"`

	// If specified, Amazon Rekognition Custom Labels creates a testing dataset
	// with an 80/20 split of the training dataset.
	AutoCreate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition Custom Labels creates a testing dataset using an 80/20 split of the training dataset.

func (TestingData) String added in v0.18.0 

func (s TestingData) String() string

String returns the string representation

func (*TestingData) Validate added in v0.18.0 

func (s *TestingData) Validate() error

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

type TestingDataResult added in v0.18.0 

type TestingDataResult struct {

	// The testing dataset that was supplied for training.
	Input *TestingData `type:"structure"`

	// The subset of the dataset that was actually tested. Some images (assets)
	// might not be tested due to file formatting and other issues.
	Output *TestingData `type:"structure"`
	// contains filtered or unexported fields
}

A Sagemaker Groundtruth format manifest file representing the dataset used for testing.

func (TestingDataResult) String added in v0.18.0 

func (s TestingDataResult) String() string

String returns the string representation

type TextDetection added in v0.2.0 

type TextDetection struct {

	// The confidence that Amazon Rekognition has in the accuracy of the detected
	// text and the accuracy of the geometry points around the detected text.
	Confidence *float64 `type:"float"`

	// The word or line of text recognized by Amazon Rekognition.
	DetectedText *string `type:"string"`

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

	// The identifier for the detected text. The identifier is only unique for a
	// single call to DetectText.
	Id *int64 `type:"integer"`

	// The Parent identifier for the detected text identified by the value of ID.
	// If the type of detected text is LINE, the value of ParentId is Null.
	ParentId *int64 `type:"integer"`

	// The type of text that was detected.
	Type TextTypes `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

func (TextDetection) String added in v0.2.0 

func (s TextDetection) String() string

String returns the string representation

type TextDetectionResult added in v0.20.0 

type TextDetectionResult struct {

	// Details about text detected in a video.
	TextDetection *TextDetection `type:"structure"`

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

Information about text detected in a video. Incudes the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

func (TextDetectionResult) String added in v0.20.0 

func (s TextDetectionResult) String() string

String returns the string representation

type TextTypes added in v0.2.0 

type TextTypes string
const (
	TextTypesLine TextTypes = "LINE"
	TextTypesWord TextTypes = "WORD"
)

Enum values for TextTypes

func (TextTypes) MarshalValue added in v0.3.0 

func (enum TextTypes) MarshalValue() (string, error)

func (TextTypes) MarshalValueBuf added in v0.3.0 

func (enum TextTypes) MarshalValueBuf(b []byte) ([]byte, error)

type TrainingData added in v0.18.0 

type TrainingData struct {

	// A Sagemaker GroundTruth manifest file that contains the training images (assets).
	Assets []Asset `type:"list"`
	// contains filtered or unexported fields
}

The dataset used for training.

func (TrainingData) String added in v0.18.0 

func (s TrainingData) String() string

String returns the string representation

func (*TrainingData) Validate added in v0.18.0 

func (s *TrainingData) Validate() error

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

type TrainingDataResult added in v0.18.0 

type TrainingDataResult struct {

	// The training assets that you supplied for training.
	Input *TrainingData `type:"structure"`

	// The images (assets) that were actually trained by Amazon Rekognition Custom
	// Labels.
	Output *TrainingData `type:"structure"`
	// contains filtered or unexported fields
}

A Sagemaker Groundtruth format manifest file that represents the dataset used for training.

func (TrainingDataResult) String added in v0.18.0 

func (s TrainingDataResult) String() string

String returns the string representation

type UnindexedFace added in v0.5.0 

type UnindexedFace struct {

	// The structure that contains attributes of a face that IndexFacesdetected,
	// but didn't index.
	FaceDetail *FaceDetail `type:"structure"`

	// An array of reasons that specify why a face wasn't indexed.
	//
	//    * EXTREME_POSE - The face is at a pose that can't be detected. For example,
	//    the head is turned too far away from the camera.
	//
	//    * EXCEEDS_MAX_FACES - The number of faces detected is already higher than
	//    that specified by the MaxFaces input parameter for IndexFaces.
	//
	//    * LOW_BRIGHTNESS - The image is too dark.
	//
	//    * LOW_SHARPNESS - The image is too blurry.
	//
	//    * LOW_CONFIDENCE - The face was detected with a low confidence.
	//
	//    * SMALL_BOUNDING_BOX - The bounding box around the face is too small.
	Reasons []Reason `type:"list"`
	// contains filtered or unexported fields
}

A face that IndexFaces detected, but didn't index. Use the Reasons response attribute to determine why a face wasn't indexed.

func (UnindexedFace) String added in v0.5.0 

func (s UnindexedFace) String() string

String returns the string representation

type Video added in v0.2.0 

type Video struct {

	// The Amazon S3 bucket name and file name for the video.
	S3Object *S3Object `type:"structure"`
	// contains filtered or unexported fields
}

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

func (Video) String added in v0.2.0 

func (s Video) String() string

String returns the string representation

func (*Video) Validate added in v0.2.0 

func (s *Video) Validate() error

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

type VideoJobStatus added in v0.2.0 

type VideoJobStatus string
const (
	VideoJobStatusInProgress VideoJobStatus = "IN_PROGRESS"
	VideoJobStatusSucceeded  VideoJobStatus = "SUCCEEDED"
	VideoJobStatusFailed     VideoJobStatus = "FAILED"
)

Enum values for VideoJobStatus

func (VideoJobStatus) MarshalValue added in v0.3.0 

func (enum VideoJobStatus) MarshalValue() (string, error)

func (VideoJobStatus) MarshalValueBuf added in v0.3.0 

func (enum VideoJobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type VideoMetadata added in v0.2.0 

type VideoMetadata struct {

	// Type of compression used in the analyzed video.
	Codec *string `type:"string"`

	// Length of the video in milliseconds.
	DurationMillis *int64 `type:"long"`

	// Format of the analyzed video. Possible values are MP4, MOV and AVI.
	Format *string `type:"string"`

	// Vertical pixel dimension of the video.
	FrameHeight *int64 `type:"long"`

	// Number of frames per second in the video.
	FrameRate *float64 `type:"float"`

	// Horizontal pixel dimension of the video.
	FrameWidth *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

func (VideoMetadata) String added in v0.2.0 

func (s VideoMetadata) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition service client for testing your code.
 Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.