rekognition

package module

v1.45.7 Latest Latest Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 49 Imported by: 48

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aws/aws-sdk-go-v2

Documentation ¶

Overview ¶

Package rekognition provides the API client, operations, and parameter types for Amazon Rekognition.

This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, Amazon Rekognition Stored Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common parameters, and common errors.

Constants ¶

View Source

const ServiceAPIVersion = "2016-06-27"

View Source

const ServiceID = "Rekognition"

Variables ¶

This section is empty.

Functions ¶

func NewDefaultEndpointResolver ¶

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions ¶ added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 ¶ added in v1.30.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName ¶ added in v1.34.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion ¶ added in v1.34.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types ¶

type AssociateFacesInput ¶ added in v1.29.0

type AssociateFacesInput struct {

	// The ID of an existing collection containing the UserID.
	//
	// This member is required.
	CollectionId *string

	// An array of FaceIDs to associate with the UserID.
	//
	// This member is required.
	FaceIds []string

	// The ID for the existing UserID.
	//
	// This member is required.
	UserId *string

	// Idempotent token used to identify the request to AssociateFaces . If you use the
	// same token with multiple AssociateFaces requests, the same response is
	// returned. Use ClientRequestToken to prevent the same request from being
	// processed more than once.
	ClientRequestToken *string

	// An optional value specifying the minimum confidence in the UserID match to
	// return. The default value is 75.
	UserMatchThreshold *float32
	// contains filtered or unexported fields
}

type AssociateFacesOutput ¶ added in v1.29.0

type AssociateFacesOutput struct {

	// An array of AssociatedFace objects containing FaceIDs that have been
	// successfully associated with the UserID. Returned if the AssociateFaces action
	// is successful.
	AssociatedFaces []types.AssociatedFace

	// An array of UnsuccessfulAssociation objects containing FaceIDs that are not
	// successfully associated along with the reasons. Returned if the AssociateFaces
	// action is successful.
	UnsuccessfulFaceAssociations []types.UnsuccessfulFaceAssociation

	// The status of an update made to a UserID. Reflects if the UserID has been
	// updated for every requested change.
	UserStatus types.UserStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters ¶ added in v1.34.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver ¶ added in v1.34.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client ¶

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

Client provides the API client to make operations call for Amazon Rekognition.

func New ¶

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig ¶

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateFaces ¶ added in v1.29.0

func (c *Client) AssociateFaces(ctx context.Context, params *AssociateFacesInput, optFns ...func(*Options)) (*AssociateFacesOutput, error)

Associates one or more faces with an existing UserID. Takes an array of FaceIds . Each FaceId that are present in the FaceIds list is associated with the provided UserID. The maximum number of total FaceIds per UserID is 100.

The UserMatchThreshold parameter specifies the minimum user match confidence required for the face to be associated with a UserID that has at least one FaceID already associated. This ensures that the FaceIds are associated with the right UserID. The value ranges from 0-100 and default value is 75.

If successful, an array of AssociatedFace objects containing the associated FaceIds is returned. If a given face is already associated with the given UserID , it will be ignored and will not be returned in the response. If a given face is already associated to a different UserID , isn't found in the collection, doesn’t meet the UserMatchThreshold , or there are already 100 faces associated with the UserID , it will be returned as part of an array of UnsuccessfulFaceAssociations.

The UserStatus reflects the status of an operation which updates a UserID representation with a list of given faces. The UserStatus can be:

ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.
CREATED - A UserID has been created, but has no FaceID(s) associated with it.
UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking place.

func (*Client) CompareFaces ¶

func (c *Client) CompareFaces(ctx context.Context, params *CompareFacesInput, optFns ...func(*Options)) (*CompareFacesOutput, error)

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

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

CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action.

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

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

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

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

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

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

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

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

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

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

func (*Client) CopyProjectVersion ¶ added in v1.20.0

func (c *Client) CopyProjectVersion(ctx context.Context, params *CopyProjectVersionInput, optFns ...func(*Options)) (*CopyProjectVersionOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service.

To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account.

For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

Copying project versions is supported only for Custom Labels models.

To copy a model, the destination project, source project, and source model version must already exist.

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersionsand check the value of Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED .

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

func (*Client) CreateCollection ¶

func (c *Client) CreateCollection(ctx context.Context, params *CreateCollectionInput, optFns ...func(*Options)) (*CreateCollectionOutput, error)

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

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

When you create a collection, it is associated with the latest version of the face model version.

Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.

func (*Client) CreateDataset ¶ added in v1.10.0

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

To create a training dataset for a project, specify TRAIN for the value of DatasetType . To create the test dataset for a project, specify TEST for the value of DatasetType .

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDatasetto check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE .

To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset creation fails if a terminal error occurs ( Status = CREATE_FAILED ). Currently, you can't access the terminal error information.

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

func (*Client) CreateFaceLivenessSession ¶ added in v1.24.0

func (c *Client) CreateFaceLivenessSession(ctx context.Context, params *CreateFaceLivenessSessionInput, optFns ...func(*Options)) (*CreateFaceLivenessSessionOutput, error)

This API operation initiates a Face Liveness session. It returns a SessionId , which you can use to start streaming Face Liveness video and get the results for a Face Liveness session.

You can use the OutputConfig option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead.

You can use AuditImagesLimit to limit the number of audit images returned when GetFaceLivenessSessionResults is called. This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on the duration of the selfie-video.

func (*Client) CreateProject ¶

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions) that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires permissions to perform the rekognition:CreateProject action.

func (*Client) CreateProjectVersion ¶

func (c *Client) CreateProjectVersion(ctx context.Context, params *CreateProjectVersionInput, optFns ...func(*Options)) (*CreateProjectVersionOutput, error)

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the project version.

The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED . Once training has successfully completed, call DescribeProjectVersionsto get the training results and evaluate the model.

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

The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

func (*Client) CreateStreamProcessor ¶

func (c *Client) CreateStreamProcessor(ctx context.Context, params *CreateStreamProcessorInput, optFns ...func(*Options)) (*CreateStreamProcessorOutput, error)

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

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream ( Input ) and a Kinesis data stream ( Output ) stream for receiving the output. You must use the FaceSearch option in Settings , specifying the collection that contains the faces you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessorto stop processing.
If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream ( Input ), Amazon S3 bucket information ( Output ), and an Amazon SNS topic ARN ( NotificationChannel ). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect by using the ConnectedHome option in settings, and selecting one of the following: PERSON , PET , PACKAGE , ALL You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest . When you run the StartStreamProcessoroperation on a label detection stream processor, you input start and stop information to determine the length of the processing time.

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 StartStreamProcessorwith the Name field.

This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

func (*Client) CreateUser ¶ added in v1.29.0

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

Creates a new User within a collection specified by CollectionId . Takes UserId as a parameter, which is a user provided ID which should be unique within the collection. The provided UserId will alias the system generated UUID to make the UserId more user friendly.

Uses a ClientToken , an idempotency token that ensures a call to CreateUser completes only once. If the value is not supplied, the AWS SDK generates an idempotency token for the requests. This prevents retries after a network error results from making multiple CreateUser calls.

func (*Client) DeleteCollection ¶

func (c *Client) DeleteCollection(ctx context.Context, params *DeleteCollectionInput, optFns ...func(*Options)) (*DeleteCollectionOutput, error)

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Deleting a collection.

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

func (*Client) DeleteDataset ¶ added in v1.10.0

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDatasetto check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS . If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.

You can't delete a dataset while it is creating ( Status = CREATE_IN_PROGRESS ) or if the dataset is updating ( Status = UPDATE_IN_PROGRESS ).

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

func (*Client) DeleteFaces ¶

func (c *Client) DeleteFaces(ctx context.Context, params *DeleteFacesInput, optFns ...func(*Options)) (*DeleteFacesOutput, error)

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.

func (*Client) DeleteProject ¶

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or adapter, see DeleteProjectVersion.

DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with that project.

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

func (*Client) DeleteProjectPolicy ¶ added in v1.20.0

func (c *Client) DeleteProjectPolicy(ctx context.Context, params *DeleteProjectPolicyInput, optFns ...func(*Options)) (*DeleteProjectPolicyOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing project policy.

To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.

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

func (*Client) DeleteProjectVersion ¶

func (c *Client) DeleteProjectVersion(ctx context.Context, params *DeleteProjectVersionInput, optFns ...func(*Options)) (*DeleteProjectVersionOutput, error)

Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.

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

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

func (*Client) DeleteStreamProcessor ¶

func (c *Client) DeleteStreamProcessor(ctx context.Context, params *DeleteStreamProcessorInput, optFns ...func(*Options)) (*DeleteStreamProcessorOutput, error)

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 .

func (*Client) DeleteUser ¶ added in v1.29.0

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Deletes the specified UserID within the collection. Faces that are associated with the UserID are disassociated from the UserID before deleting the specified UserID. If the specified Collection or UserID is already deleted or not found, a ResourceNotFoundException will be thrown. If the action is successful with a 200 response, an empty HTTP body is returned.

func (*Client) DescribeCollection ¶

func (c *Client) DescribeCollection(ctx context.Context, params *DescribeCollectionInput, optFns ...func(*Options)) (*DescribeCollectionOutput, error)

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.

func (*Client) DescribeDataset ¶ added in v1.10.0

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

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

func (*Client) DescribeProjectVersions ¶

func (c *Client) DescribeProjectVersions(ctx context.Context, params *DescribeProjectVersionsInput, optFns ...func(*Options)) (*DescribeProjectVersionsOutput, error)

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

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

func (*Client) DescribeProjects ¶

func (c *Client) DescribeProjects(ctx context.Context, params *DescribeProjectsInput, optFns ...func(*Options)) (*DescribeProjectsOutput, error)

Gets information about your Rekognition projects.

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

func (*Client) DescribeStreamProcessor ¶

func (c *Client) DescribeStreamProcessor(ctx context.Context, params *DescribeStreamProcessorInput, optFns ...func(*Options)) (*DescribeStreamProcessorOutput, error)

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.

func (*Client) DetectCustomLabels ¶

func (c *Client) DetectCustomLabels(ctx context.Context, params *DetectCustomLabelsInput, optFns ...func(*Options)) (*DetectCustomLabelsOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

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 ). Note that for the DetectCustomLabelsLabels operation, Polygons are not returned in the Geometry section of the response.

To filter labels that are returned, specify a value for MinConfidence . DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value.

The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

If you don't specify a value for MinConfidence , DetectCustomLabels returns labels based on the assumed threshold of each label.

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

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

For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

func (*Client) DetectFaces ¶

func (c *Client) DetectFaces(ctx context.Context, params *DetectFacesInput, optFns ...func(*Options)) (*DetectFacesOutput, error)

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), pose, presence of facial occlusion, 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.

func (*Client) DetectLabels ¶

func (c *Client) DetectLabels(ctx context.Context, params *DetectLabelsInput, optFns ...func(*Options)) (*DetectLabelsOutput, error)

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.

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.

Optional Parameters ¶

You can specify one or both of the GENERAL_LABELS and IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including GENERAL_LABELS will ensure the response includes the labels detected in the input image, while including IMAGE_PROPERTIES will ensure the response includes information about the image quality and color.

When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can provide filtering criteria to the Settings parameter. You can filter with sets of individual labels or with label categories. You can specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive filters. For more information on filtering see Detecting Labels in an Image.

When getting labels, 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. The default and upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a feature type.

Response Elements ¶

For each object, scene, and concept the API returns one or more labels. The API returns the following types of information about labels:

Name - The name of the detected label.
Confidence - The level of confidence in the label assigned to a detected object.
Parents - The ancestor labels for a detected label. DetectLabels 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 includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
Aliases - Possible Aliases for the label.
Categories - The label categories that the detected label belongs to.
BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

The API returns the following information regarding the image, as part of the ImageProperties structure:

Quality - Information about the Sharpness, Brightness, and Contrast of the input image, scored between 0 to 100. Image quality is returned for the entire image, as well as the background and the foreground.
Dominant Color - An array of the dominant colors in the image.
Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

The list of returned labels will include at least one label for every detected object, along with information about that label. In the following example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object, as well as the confidence in the label:

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

The list of labels can include multiple labels for the same object. 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.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFacesoperation provides.

This is a stateless API operation that doesn't return any data.

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

func (*Client) DetectModerationLabels ¶

func (c *Client) DetectModerationLabels(ctx context.Context, params *DetectModerationLabelsInput, optFns ...func(*Options)) (*DetectModerationLabelsOutput, error)

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.

You can specify an adapter to use when retrieving label predictions by providing a ProjectVersionArn to the ProjectVersion argument.

func (*Client) DetectProtectiveEquipment ¶ added in v0.29.0

func (c *Client) DetectProtectiveEquipment(ctx context.Context, params *DetectProtectiveEquipmentInput, optFns ...func(*Options)) (*DetectProtectiveEquipmentOutput, error)

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.

Face cover
Hand cover
Head cover

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.

DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox ) for each detected person and each detected item of PPE.

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.

The persons detected as wearing all of the types of PPE that you specify.
The persons detected as not wearing all of the types PPE that you specify.
The persons detected where PPE adornment could not be determined.

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

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

func (*Client) DetectText ¶

func (c *Client) DetectText(ctx context.Context, params *DetectTextInput, optFns ...func(*Options)) (*DetectTextOutput, error)

Detects text in the input image and converts it into machine-readable text.

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

The DetectText operation returns text in an array of TextDetection elements, TextDetections . Each TextDetection element provides information about a single word or line of text that was detected in the image.

A word is one or more script characters that are not separated by spaces. DetectText can detect up to 100 words in an image.

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

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

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

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

func (*Client) DisassociateFaces ¶ added in v1.29.0

func (c *Client) DisassociateFaces(ctx context.Context, params *DisassociateFacesInput, optFns ...func(*Options)) (*DisassociateFacesOutput, error)

Removes the association between a Face supplied in an array of FaceIds and the User. If the User is not present already, then a ResourceNotFound exception is thrown. If successful, an array of faces that are disassociated from the User is returned. If a given face is already disassociated from the given UserID, it will be ignored and not be returned in the response. If a given face is already associated with a different User or not found in the collection it will be returned as part of UnsuccessfulDisassociations . You can remove 1 - 100 face IDs from a user at one time.

func (*Client) DistributeDatasetEntries ¶ added in v1.10.0

func (c *Client) DistributeDatasetEntries(ctx context.Context, params *DistributeDatasetEntriesInput, optFns ...func(*Options)) (*DistributeDatasetEntriesOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image.

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

Distributing a dataset takes a while to complete. To check the status call DescribeDataset . The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE . If the dataset split fails, the value of Status is UPDATE_FAILED .

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

func (*Client) GetCelebrityInfo ¶

func (c *Client) GetCelebrityInfo(ctx context.Context, params *GetCelebrityInfoInput, optFns ...func(*Options)) (*GetCelebrityInfoOutput, error)

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Getting information about a celebrity in the Amazon Rekognition Developer Guide.

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

func (*Client) GetCelebrityRecognition ¶

func (c *Client) GetCelebrityRecognition(ctx context.Context, params *GetCelebrityRecognitionInput, optFns ...func(*Options)) (*GetCelebrityRecognitionOutput, error)

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 StartCelebrityRecognitionwhich 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 CelebrityDetailobject and the time, Timestamp , the celebrity was detected. This CelebrityDetailobject stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

GetCelebrityRecognition only returns the default facial attributes ( BoundingBox , Confidence , Landmarks , Pose , and Quality ). The BoundingBox field only applies to the detected face instance. The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfowith 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 .

func (*Client) GetContentModeration ¶

func (c *Client) GetContentModeration(ctx context.Context, params *GetContentModerationInput, optFns ...func(*Options)) (*GetContentModerationOutput, error)

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModerationwhich returns a job identifier ( JobId ). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration . To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetContentModeration and pass the job identifier ( JobId ) from the initial call to StartContentModeration .

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

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels , of ContentModerationDetection objects.

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration . If there are more results than specified in MaxResults , the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration .

For more information, see moderating content in the Amazon Rekognition Developer Guide.

func (*Client) GetFaceDetection ¶

func (c *Client) GetFaceDetection(ctx context.Context, params *GetFaceDetectionInput, optFns ...func(*Options)) (*GetFaceDetectionOutput, error)

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

Note that for the GetFaceDetection operation, the returned values for FaceOccluded and EyeDirection will always be "null".

func (*Client) GetFaceLivenessSessionResults ¶ added in v1.24.0

func (c *Client) GetFaceLivenessSessionResults(ctx context.Context, params *GetFaceLivenessSessionResultsInput, optFns ...func(*Options)) (*GetFaceLivenessSessionResultsOutput, error)

Retrieves the results of a specific Face Liveness session. It requires the sessionId as input, which was created using CreateFaceLivenessSession . Returns the corresponding Face Liveness confidence score, a reference image that includes a face bounding box, and audit images that also contain face bounding boxes. The Face Liveness confidence score ranges from 0 to 100.

The number of audit images returned by GetFaceLivenessSessionResults is defined by the AuditImagesLimit paramater when calling CreateFaceLivenessSession . Reference images are always returned when possible.

func (*Client) GetFaceSearch ¶

func (c *Client) GetFaceSearch(ctx context.Context, params *GetFaceSearchInput, optFns ...func(*Options)) (*GetFaceSearchOutput, error)

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 StartFaceSearchwhich 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. Each PersonMatch 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.

func (*Client) GetLabelDetection ¶

func (c *Client) GetLabelDetection(ctx context.Context, params *GetLabelDetectionInput, optFns ...func(*Options)) (*GetLabelDetectionOutput, error)

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. If there is no NAME specified, the default sort is by timestamp.

You can select how results are aggregated by using the AggregateBy input parameter. The default aggregation method is TIMESTAMPS . You can also aggregate by SEGMENTS , which aggregates all instances of labels detected in a given segment.

The returned Labels array may include the following attributes:

Name - The name of the detected label.
Confidence - The level of confidence in the label assigned to a detected object.
Parents - The ancestor labels for a detected label. GetLabelDetection 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 includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
Aliases - Possible Aliases for the label.
Categories - The label categories that the detected label belongs to.
BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
Timestamp - Time, in milliseconds from the start of the video, that the label was detected. For aggregation by SEGMENTS , the StartTimestampMillis , EndTimestampMillis , and DurationMillis structures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same as StartTimestampMillis .

Timestamp and Bounding box information are returned for detected Instances, only if aggregation is done by TIMESTAMPS . If aggregating by SEGMENTS , information about detected instances isn’t returned.

The version of the label model used for the detection is also returned.

Note DominantColors isn't returned for Instances , although it is shown as part of the response in the sample seen below.

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 .

If you are retrieving results while using the Amazon Simple Notification Service, note that you will receive an "ERROR" notification if the job encounters an issue.

func (*Client) GetMediaAnalysisJob ¶ added in v1.32.0

func (c *Client) GetMediaAnalysisJob(ctx context.Context, params *GetMediaAnalysisJobInput, optFns ...func(*Options)) (*GetMediaAnalysisJobOutput, error)

Retrieves the results for a given media analysis job. Takes a JobId returned by StartMediaAnalysisJob.

func (*Client) GetPersonTracking ¶

func (c *Client) GetPersonTracking(ctx context.Context, params *GetPersonTrackingInput, optFns ...func(*Options)) (*GetPersonTrackingOutput, error)

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 .

func (*Client) GetSegmentDetection ¶

func (c *Client) GetSegmentDetection(ctx context.Context, params *GetSegmentDetectionInput, optFns ...func(*Options)) (*GetSegmentDetectionOutput, error)

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

func (*Client) GetTextDetection ¶

func (c *Client) GetTextDetection(ctx context.Context, params *GetTextDetectionInput, optFns ...func(*Options)) (*GetTextDetectionOutput, error)

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 StartTextDetectionwhich 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 100 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 .

func (*Client) IndexFaces ¶

func (c *Client) IndexFaces(ctx context.Context, params *IndexFacesInput, optFns ...func(*Options)) (*IndexFacesOutput, error)

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 SearchFacesand 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 ListFacesoperation, 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 UnindexedFaceobjects, 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 or specific facial attributes (e.g., FACE_OCCLUDED ) by using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth), facial occlusion, 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.

func (*Client) ListCollections ¶

func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInput, optFns ...func(*Options)) (*ListCollectionsOutput, error)

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.

func (*Client) ListDatasetEntries ¶ added in v1.10.0

func (c *Client) ListDatasetEntries(ctx context.Context, params *ListDatasetEntriesInput, optFns ...func(*Options)) (*ListDatasetEntriesOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.

JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.

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

func (*Client) ListDatasetLabels ¶ added in v1.10.0

func (c *Client) ListDatasetLabels(ctx context.Context, params *ListDatasetLabelsInput, optFns ...func(*Options)) (*ListDatasetLabelsOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.

func (*Client) ListFaces ¶

func (c *Client) ListFaces(ctx context.Context, params *ListFacesInput, optFns ...func(*Options)) (*ListFacesOutput, error)

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.

func (*Client) ListMediaAnalysisJobs ¶ added in v1.32.0

func (c *Client) ListMediaAnalysisJobs(ctx context.Context, params *ListMediaAnalysisJobsInput, optFns ...func(*Options)) (*ListMediaAnalysisJobsOutput, error)

Returns a list of media analysis jobs. Results are sorted by CreationTimestamp in descending order.

func (*Client) ListProjectPolicies ¶ added in v1.20.0

func (c *Client) ListProjectPolicies(ctx context.Context, params *ListProjectPoliciesInput, optFns ...func(*Options)) (*ListProjectPoliciesOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Gets a list of the project policies attached to a project.

To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.

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

func (*Client) ListStreamProcessors ¶

func (c *Client) ListStreamProcessors(ctx context.Context, params *ListStreamProcessorsInput, optFns ...func(*Options)) (*ListStreamProcessorsOutput, error)

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

func (*Client) ListTagsForResource ¶ added in v1.3.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns a list of tags in an Amazon Rekognition collection, stream processor,

or Custom Labels model.

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

func (*Client) ListUsers ¶ added in v1.29.0

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Returns metadata of the User such as UserID in the specified collection. Anonymous User (to reserve faces without any identity) is not returned as part of this request. The results are sorted by system generated primary key ID. If the response is truncated, NextToken is returned in the response that can be used in the subsequent request to retrieve the next set of identities.

func (*Client) Options ¶ added in v1.35.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutProjectPolicy ¶ added in v1.20.0

func (c *Client) PutProjectPolicy(ctx context.Context, params *PutProjectPolicyInput, optFns ...func(*Options)) (*PutProjectPolicyOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project policy specifies that a trusted AWS account can copy a model version from a trusting AWS account to a project in the trusted AWS account. To copy a model version you use the CopyProjectVersionoperation. Only applies to Custom Labels projects.

For more information about the format of a project policy document, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.

The response from PutProjectPolicy is a revision ID for the project policy. You can attach multiple project policies to a project. You can also update an existing project policy by specifying the policy revision ID of the existing policy.

To remove a project policy from a project, call DeleteProjectPolicy. To get a list of project policies attached to a project, call ListProjectPolicies.

You copy a model version by calling CopyProjectVersion.

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

func (*Client) RecognizeCelebrities ¶

func (c *Client) RecognizeCelebrities(ctx context.Context, params *RecognizeCelebritiesInput, optFns ...func(*Options)) (*RecognizeCelebritiesOutput, error)

Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

RecognizeCelebrities returns the 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image.

For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image.

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities , you will need the ID to identify the celebrity in a call to the GetCelebrityInfooperation.

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.

func (*Client) SearchFaces ¶

func (c *Client) SearchFaces(ctx context.Context, params *SearchFacesInput, optFns ...func(*Options)) (*SearchFacesOutput, error)

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

func (*Client) SearchFacesByImage ¶

func (c *Client) SearchFacesByImage(ctx context.Context, params *SearchFacesByImageInput, optFns ...func(*Options)) (*SearchFacesByImageOutput, error)

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

You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

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

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error.

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

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

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

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

func (*Client) SearchUsers ¶ added in v1.29.0

func (c *Client) SearchUsers(ctx context.Context, params *SearchUsersInput, optFns ...func(*Options)) (*SearchUsersOutput, error)

Searches for UserIDs within a collection based on a FaceId or UserId . This API can be used to find the closest UserID (with a highest similarity) to associate a face. The request must be provided with either FaceId or UserId . The operation returns an array of UserID that match the FaceId or UserId , ordered by similarity score with the highest similarity first.

func (*Client) SearchUsersByImage ¶ added in v1.29.0

func (c *Client) SearchUsersByImage(ctx context.Context, params *SearchUsersByImageInput, optFns ...func(*Options)) (*SearchUsersByImageOutput, error)

Searches for UserIDs using a supplied image. It first detects the largest face in the image, and then searches a specified collection for matching UserIDs.

The operation returns an array of UserIDs that match the face in the supplied image, ordered by similarity score with the highest similarity first. It also returns a bounding box for the face found in the input image.

Information about faces detected in the supplied image, but not used for the search, is returned in an array of UnsearchedFace objects. If no valid face is detected in the image, the response will contain an empty UserMatches list and no SearchedFace object.

func (*Client) StartCelebrityRecognition ¶

func (c *Client) StartCelebrityRecognition(ctx context.Context, params *StartCelebrityRecognitionInput, optFns ...func(*Options)) (*StartCelebrityRecognitionOutput, error)

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

func (*Client) StartContentModeration ¶

func (c *Client) StartContentModeration(ctx context.Context, params *StartContentModerationInput, optFns ...func(*Options)) (*StartContentModerationOutput, error)

Starts asynchronous detection of inappropriate, unwanted, or offensive content

in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

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

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

For more information, see Moderating content in the Amazon Rekognition Developer Guide.

func (*Client) StartFaceDetection ¶

func (c *Client) StartFaceDetection(ctx context.Context, params *StartFaceDetectionInput, optFns ...func(*Options)) (*StartFaceDetectionOutput, error)

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

func (*Client) StartFaceSearch ¶

func (c *Client) StartFaceSearch(ctx context.Context, params *StartFaceSearchInput, optFns ...func(*Options)) (*StartFaceSearchOutput, error)

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 Searching stored videos for faces.

func (*Client) StartLabelDetection ¶

func (c *Client) StartLabelDetection(ctx context.Context, params *StartLabelDetectionInput, optFns ...func(*Options)) (*StartLabelDetectionOutput, error)

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 .

Optional Parameters ¶

StartLabelDetection has the GENERAL_LABELS Feature applied by default. This feature allows you to provide filtering criteria to the Settings parameter. You can filter with sets of individual labels or with label categories. You can specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive filters. For more information on filtering, see Detecting labels in a video.

You can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50.

func (*Client) StartMediaAnalysisJob ¶ added in v1.32.0

func (c *Client) StartMediaAnalysisJob(ctx context.Context, params *StartMediaAnalysisJobInput, optFns ...func(*Options)) (*StartMediaAnalysisJobOutput, error)

Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.

func (*Client) StartPersonTracking ¶

func (c *Client) StartPersonTracking(ctx context.Context, params *StartPersonTrackingInput, optFns ...func(*Options)) (*StartPersonTrackingOutput, error)

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

func (*Client) StartProjectVersion ¶

func (c *Client) StartProjectVersion(ctx context.Context, params *StartProjectVersionInput, optFns ...func(*Options)) (*StartProjectVersionOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

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.

func (*Client) StartSegmentDetection ¶

func (c *Client) StartSegmentDetection(ctx context.Context, params *StartSegmentDetectionInput, optFns ...func(*Options)) (*StartSegmentDetectionOutput, error)

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

func (*Client) StartStreamProcessor ¶

func (c *Client) StartStreamProcessor(ctx context.Context, params *StartStreamProcessorInput, optFns ...func(*Options)) (*StartStreamProcessorOutput, error)

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 .

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

func (*Client) StartTextDetection ¶

func (c *Client) StartTextDetection(ctx context.Context, params *StartTextDetectionInput, optFns ...func(*Options)) (*StartTextDetectionOutput, error)

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

func (*Client) StopProjectVersion ¶

func (c *Client) StopProjectVersion(ctx context.Context, params *StopProjectVersionInput, optFns ...func(*Options)) (*StopProjectVersionOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

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

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

func (*Client) StopStreamProcessor ¶

func (c *Client) StopStreamProcessor(ctx context.Context, params *StopStreamProcessorInput, optFns ...func(*Options)) (*StopStreamProcessorOutput, error)

Stops a running stream processor that was created by CreateStreamProcessor.

func (*Client) TagResource ¶ added in v1.3.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds one or more key-value tags to an Amazon Rekognition collection, stream

processor, or Custom Labels model. For more information, see Tagging AWS Resources.

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

func (*Client) UntagResource ¶ added in v1.3.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from an Amazon Rekognition collection, stream

processor, or Custom Labels model.

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

func (*Client) UpdateDatasetEntries ¶ added in v1.10.0

func (c *Client) UpdateDatasetEntries(ctx context.Context, params *UpdateDatasetEntriesInput, optFns ...func(*Options)) (*UpdateDatasetEntriesOutput, error)

This operation applies only to Amazon Rekognition Custom Labels.

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.

UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDatasetto check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE .

To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset update fails if a terminal error occurs ( Status = UPDATE_FAILED ). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.

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

func (*Client) UpdateStreamProcessor ¶ added in v1.18.0

func (c *Client) UpdateStreamProcessor(ctx context.Context, params *UpdateStreamProcessorInput, optFns ...func(*Options)) (*UpdateStreamProcessorOutput, error)

Allows you to update a stream processor. You can change some settings and

regions of interest and delete certain parameters.

type CompareFacesInput ¶

type CompareFacesInput 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.
	//
	// This member is required.
	SourceImage *types.Image

	// 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.
	//
	// This member is required.
	TargetImage *types.Image

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

	// The minimum level of confidence in the face matches that a match must meet to
	// be included in the FaceMatches array.
	SimilarityThreshold *float32
	// contains filtered or unexported fields
}

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 []types.CompareFacesMatch

	// The face in the source image that was used for comparison.
	SourceImageFace *types.ComparedSourceImageFace

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

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

	// An array of faces in the target image that did not match the source image face.
	UnmatchedFaces []types.ComparedFace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CopyProjectVersionInput ¶ added in v1.20.0

type CopyProjectVersionInput struct {

	// The ARN of the project in the trusted AWS account that you want to copy the
	// model version to.
	//
	// This member is required.
	DestinationProjectArn *string

	// The S3 bucket and folder location where the training output for the source
	// model version is placed.
	//
	// This member is required.
	OutputConfig *types.OutputConfig

	// The ARN of the source project in the trusting AWS account.
	//
	// This member is required.
	SourceProjectArn *string

	// The ARN of the model version in the source project that you want to copy to a
	// destination project.
	//
	// This member is required.
	SourceProjectVersionArn *string

	// A name for the version of the model that's copied to the destination project.
	//
	// This member is required.
	VersionName *string

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

	// The key-value tags to assign to the model version.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CopyProjectVersionOutput ¶ added in v1.20.0

type CopyProjectVersionOutput struct {

	// The ARN of the copied model version in the destination project.
	ProjectVersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCollectionInput ¶

type CreateCollectionInput struct {

	// ID for the collection that you are creating.
	//
	// This member is required.
	CollectionId *string

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

type CreateCollectionOutput ¶

type CreateCollectionOutput struct {

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

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

	// HTTP status code indicating the result of the operation.
	StatusCode *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetInput ¶ added in v1.10.0

type CreateDatasetInput struct {

	//  The type of the dataset. Specify TRAIN to create a training dataset. Specify
	// TEST to create a test dataset.
	//
	// This member is required.
	DatasetType types.DatasetType

	//  The ARN of the Amazon Rekognition Custom Labels project to which you want to
	// asssign the dataset.
	//
	// This member is required.
	ProjectArn *string

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

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

type CreateDatasetOutput ¶ added in v1.10.0

type CreateDatasetOutput struct {

	//  The ARN of the created Amazon Rekognition Custom Labels dataset.
	DatasetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFaceLivenessSessionInput ¶ added in v1.24.0

type CreateFaceLivenessSessionInput struct {

	// Idempotent token is used to recognize the Face Liveness request. If the same
	// token is used with multiple CreateFaceLivenessSession requests, the same
	// session is returned. This token is employed to avoid unintentionally creating
	// the same session multiple times.
	ClientRequestToken *string

	//  The identifier for your AWS Key Management Service key (AWS KMS key). Used to
	// encrypt audit images and reference images.
	KmsKeyId *string

	// A session settings object. It contains settings for the operation to be
	// performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit .
	Settings *types.CreateFaceLivenessSessionRequestSettings
	// contains filtered or unexported fields
}

type CreateFaceLivenessSessionOutput ¶ added in v1.24.0

type CreateFaceLivenessSessionOutput struct {

	// A unique 128-bit UUID identifying a Face Liveness session. A new sessionID must
	// be used for every Face Liveness check. If a given sessionID is used for
	// subsequent Face Liveness checks, the checks will fail. Additionally, a SessionId
	// expires 3 minutes after it's sent, making all Liveness data associated with the
	// session (e.g., sessionID, reference image, audit images, etc.) unavailable.
	//
	// This member is required.
	SessionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProjectInput ¶

type CreateProjectInput struct {

	// The name of the project to create.
	//
	// This member is required.
	ProjectName *string

	// Specifies whether automatic retraining should be attempted for the versions of
	// the project. Automatic retraining is done as a best effort. Required argument
	// for Content Moderation. Applicable only to adapters.
	AutoUpdate types.ProjectAutoUpdate

	// Specifies feature that is being customized. If no value is provided
	// CUSTOM_LABELS is used as a default.
	Feature types.CustomizationFeature

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

type CreateProjectOutput ¶

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProjectVersionInput ¶

type CreateProjectVersionInput struct {

	// The Amazon S3 bucket location to store the results of training. The bucket can
	// be any S3 bucket in your AWS account. You need s3:PutObject permission on the
	// bucket.
	//
	// This member is required.
	OutputConfig *types.OutputConfig

	// The ARN of the Amazon Rekognition project that will manage the project version
	// you want to train.
	//
	// This member is required.
	ProjectArn *string

	// A name for the version of the project version. This value must be unique.
	//
	// This member is required.
	VersionName *string

	// Feature-specific configuration of the training job. If the job configuration
	// does not match the feature type associated with the project, an
	// InvalidParameterException is returned.
	FeatureConfig *types.CustomizationFeatureConfig

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

	//  A set of tags (key-value pairs) that you want to attach to the project
	// version.
	Tags map[string]string

	// Specifies an external manifest that the service uses to test the project
	// version. If you specify TestingData you must also specify TrainingData . The
	// project must not have any associated datasets.
	TestingData *types.TestingData

	// Specifies an external manifest that the services uses to train the project
	// version. If you specify TrainingData you must also specify TestingData . The
	// project must not have any associated datasets.
	TrainingData *types.TrainingData

	// A description applied to the project version being created.
	VersionDescription *string
	// contains filtered or unexported fields
}

type CreateProjectVersionOutput ¶

type CreateProjectVersionOutput struct {

	// The ARN of the model or the project version that was created. Use
	// DescribeProjectVersion to get the current status of the training operation.
	ProjectVersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStreamProcessorInput ¶

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 . This is
	// required for both face search and label detection stream processors.
	//
	// This member is required.
	Input *types.StreamProcessorInput

	// 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. This is required for both face
	// search and label detection stream processors.
	//
	// This member is required.
	Name *string

	// Kinesis data stream stream or Amazon S3 bucket location to which Amazon
	// Rekognition Video puts the analysis results. If you are using the AWS CLI, the
	// parameter name is StreamProcessorOutput . This must be a S3Destination of an Amazon S3
	// bucket that you own for a label detection stream processor or a Kinesis data
	// stream ARN for a face search stream processor.
	//
	// This member is required.
	Output *types.StreamProcessorOutput

	// The Amazon Resource Number (ARN) of the IAM role that allows access to the
	// stream processor. The IAM role provides Rekognition read permissions for a
	// Kinesis stream. It also provides write permissions to an Amazon S3 bucket and
	// Amazon Simple Notification Service topic for a label detection stream processor.
	// This is required for both face search and label detection stream processors.
	//
	// This member is required.
	RoleArn *string

	// Input parameters used in a streaming video analyzed by a stream processor. You
	// can use FaceSearch to recognize faces in a streaming video, or you can use
	// ConnectedHome to detect labels.
	//
	// This member is required.
	Settings *types.StreamProcessorSettings

	//  Shows whether you are sharing data with Rekognition to improve model
	// performance. You can choose this option at the account level or on a per-stream
	// basis. Note that if you opt out at the account level this setting is ignored on
	// individual streams.
	DataSharingPreference *types.StreamProcessorDataSharingPreference

	//  The identifier for your AWS Key Management Service key (AWS KMS key). This is
	// an optional parameter for label detection stream processors and should not be
	// used to create a face search stream processor. You can supply the Amazon
	// Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your
	// KMS key, or an alias ARN. The key is used to encrypt results and data published
	// to your Amazon S3 bucket, which includes image frames and hero images. Your
	// source images are unaffected.
	KmsKeyId *string

	// The Amazon Simple Notification Service topic to which Amazon Rekognition
	// publishes the object detection results and completion status of a video analysis
	// operation.
	//
	// Amazon Rekognition publishes a notification the first time an object of
	// interest or a person is detected in the video stream. For example, if Amazon
	// Rekognition detects a person at second 2, a pet at second 4, and a person again
	// at second 5, Amazon Rekognition sends 2 object class detected notifications, one
	// for a person at second 2 and one for a pet at second 4.
	//
	// Amazon Rekognition also publishes an an end-of-session notification with a
	// summary when the stream processing session is complete.
	NotificationChannel *types.StreamProcessorNotificationChannel

	//  Specifies locations in the frames where Amazon Rekognition checks for objects
	// or people. You can specify up to 10 regions of interest, and each region has
	// either a polygon or a bounding box. This is an optional parameter for label
	// detection stream processors and should not be used to create a face search
	// stream processor.
	RegionsOfInterest []types.RegionOfInterest

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

type CreateStreamProcessorOutput ¶

type CreateStreamProcessorOutput struct {

	// Amazon Resource Number for the newly created stream processor.
	StreamProcessorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateUserInput ¶ added in v1.29.0

type CreateUserInput struct {

	// The ID of an existing collection to which the new UserID needs to be created.
	//
	// This member is required.
	CollectionId *string

	// ID for the UserID to be created. This ID needs to be unique within the
	// collection.
	//
	// This member is required.
	UserId *string

	// Idempotent token used to identify the request to CreateUser . If you use the
	// same token with multiple CreateUser requests, the same response is returned.
	// Use ClientRequestToken to prevent the same request from being processed more
	// than once.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type CreateUserOutput ¶ added in v1.29.0

type CreateUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCollectionInput ¶

type DeleteCollectionInput struct {

	// ID of the collection to delete.
	//
	// This member is required.
	CollectionId *string
	// contains filtered or unexported fields
}

type DeleteCollectionOutput ¶

type DeleteCollectionOutput struct {

	// HTTP status code that indicates the result of the operation.
	StatusCode *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetInput ¶ added in v1.10.0

type DeleteDatasetInput struct {

	//  The ARN of the Amazon Rekognition Custom Labels dataset that you want to
	// delete.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DeleteDatasetOutput ¶ added in v1.10.0

type DeleteDatasetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFacesInput ¶

type DeleteFacesInput struct {

	// Collection from which to remove the specific faces.
	//
	// This member is required.
	CollectionId *string

	// An array of face IDs to delete.
	//
	// This member is required.
	FaceIds []string
	// contains filtered or unexported fields
}

type DeleteFacesOutput ¶

type DeleteFacesOutput struct {

	// An array of strings (face IDs) of the faces that were deleted.
	DeletedFaces []string

	// An array of any faces that weren't deleted.
	UnsuccessfulFaceDeletions []types.UnsuccessfulFaceDeletion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProjectInput ¶

type DeleteProjectInput struct {

	// The Amazon Resource Name (ARN) of the project that you want to delete.
	//
	// This member is required.
	ProjectArn *string
	// contains filtered or unexported fields
}

type DeleteProjectOutput ¶

type DeleteProjectOutput struct {

	// The current status of the delete project operation.
	Status types.ProjectStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProjectPolicyInput ¶ added in v1.20.0

type DeleteProjectPolicyInput struct {

	// The name of the policy that you want to delete.
	//
	// This member is required.
	PolicyName *string

	// The Amazon Resource Name (ARN) of the project that the project policy you want
	// to delete is attached to.
	//
	// This member is required.
	ProjectArn *string

	// The ID of the project policy revision that you want to delete.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type DeleteProjectPolicyOutput ¶ added in v1.20.0

type DeleteProjectPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProjectVersionInput ¶

type DeleteProjectVersionInput struct {

	// The Amazon Resource Name (ARN) of the project version that you want to delete.
	//
	// This member is required.
	ProjectVersionArn *string
	// contains filtered or unexported fields
}

type DeleteProjectVersionOutput ¶

type DeleteProjectVersionOutput struct {

	// The status of the deletion operation.
	Status types.ProjectVersionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteStreamProcessorInput ¶

type DeleteStreamProcessorInput struct {

	// The name of the stream processor you want to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteStreamProcessorOutput ¶

type DeleteStreamProcessorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUserInput ¶ added in v1.29.0

type DeleteUserInput struct {

	// The ID of an existing collection from which the UserID needs to be deleted.
	//
	// This member is required.
	CollectionId *string

	// ID for the UserID to be deleted.
	//
	// This member is required.
	UserId *string

	// Idempotent token used to identify the request to DeleteUser . If you use the
	// same token with multiple DeleteUser requests, the same response is returned.
	// Use ClientRequestToken to prevent the same request from being processed more
	// than once.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type DeleteUserOutput ¶ added in v1.29.0

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCollectionInput ¶

type DescribeCollectionInput struct {

	// The ID of the collection to describe.
	//
	// This member is required.
	CollectionId *string
	// contains filtered or unexported fields
}

type DescribeCollectionOutput ¶

type DescribeCollectionOutput struct {

	// The Amazon Resource Name (ARN) of the collection.
	CollectionARN *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

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

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

	// The number of UserIDs assigned to the specified colleciton.
	UserCount *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetInput ¶ added in v1.10.0

type DescribeDatasetInput struct {

	//  The Amazon Resource Name (ARN) of the dataset that you want to describe.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetOutput ¶ added in v1.10.0

type DescribeDatasetOutput struct {

	//  The description for the dataset.
	DatasetDescription *types.DatasetDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProjectVersionsAPIClient ¶ added in v0.30.0

type DescribeProjectVersionsAPIClient interface {
	DescribeProjectVersions(context.Context, *DescribeProjectVersionsInput, ...func(*Options)) (*DescribeProjectVersionsOutput, error)
}

DescribeProjectVersionsAPIClient is a client that implements the DescribeProjectVersions operation.

type DescribeProjectVersionsInput ¶

type DescribeProjectVersionsInput struct {

	// The Amazon Resource Name (ARN) of the project that contains the model/adapter
	// you want to describe.
	//
	// This member is required.
	ProjectArn *string

	// 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 *int32

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

	// A list of model or project version names that you want to describe. You can add
	// up to 10 model or project version names to the list. If you don't specify a
	// value, all project version descriptions are returned. A version name is part of
	// a project version 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
	// contains filtered or unexported fields
}

type DescribeProjectVersionsOutput ¶

type DescribeProjectVersionsOutput struct {

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

	// A list of project version descriptions. The list is sorted by the creation date
	// and time of the project versions, latest to earliest.
	ProjectVersionDescriptions []types.ProjectVersionDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProjectVersionsPaginator ¶ added in v0.30.0

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

DescribeProjectVersionsPaginator is a paginator for DescribeProjectVersions

func NewDescribeProjectVersionsPaginator ¶ added in v0.30.0

func NewDescribeProjectVersionsPaginator(client DescribeProjectVersionsAPIClient, params *DescribeProjectVersionsInput, optFns ...func(*DescribeProjectVersionsPaginatorOptions)) *DescribeProjectVersionsPaginator

NewDescribeProjectVersionsPaginator returns a new DescribeProjectVersionsPaginator

func (*DescribeProjectVersionsPaginator) HasMorePages ¶ added in v0.30.0

func (p *DescribeProjectVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeProjectVersionsPaginator) NextPage ¶ added in v0.30.0

func (p *DescribeProjectVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeProjectVersionsOutput, error)

NextPage retrieves the next DescribeProjectVersions page.

type DescribeProjectVersionsPaginatorOptions ¶ added in v0.30.0

type DescribeProjectVersionsPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeProjectVersionsPaginatorOptions is the paginator options for DescribeProjectVersions

type DescribeProjectsAPIClient ¶ added in v0.30.0

type DescribeProjectsAPIClient interface {
	DescribeProjects(context.Context, *DescribeProjectsInput, ...func(*Options)) (*DescribeProjectsOutput, error)
}

DescribeProjectsAPIClient is a client that implements the DescribeProjects operation.

type DescribeProjectsInput ¶

type DescribeProjectsInput struct {

	// Specifies the type of customization to filter projects by. If no value is
	// specified, CUSTOM_LABELS is used as a default.
	Features []types.CustomizationFeature

	// 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 *int32

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

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

type DescribeProjectsOutput ¶

type DescribeProjectsOutput struct {

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

	// A list of project descriptions. The list is sorted by the date and time the
	// projects are created.
	ProjectDescriptions []types.ProjectDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProjectsPaginator ¶ added in v0.30.0

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

DescribeProjectsPaginator is a paginator for DescribeProjects

func NewDescribeProjectsPaginator ¶ added in v0.30.0

func NewDescribeProjectsPaginator(client DescribeProjectsAPIClient, params *DescribeProjectsInput, optFns ...func(*DescribeProjectsPaginatorOptions)) *DescribeProjectsPaginator

NewDescribeProjectsPaginator returns a new DescribeProjectsPaginator

func (*DescribeProjectsPaginator) HasMorePages ¶ added in v0.30.0

func (p *DescribeProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeProjectsPaginator) NextPage ¶ added in v0.30.0

func (p *DescribeProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeProjectsOutput, error)

NextPage retrieves the next DescribeProjects page.

type DescribeProjectsPaginatorOptions ¶ added in v0.30.0

type DescribeProjectsPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeProjectsPaginatorOptions is the paginator options for DescribeProjects

type DescribeStreamProcessorInput ¶

type DescribeStreamProcessorInput struct {

	// Name of the stream processor for which you want information.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DescribeStreamProcessorOutput ¶

type DescribeStreamProcessorOutput struct {

	// Date and time the stream processor was created
	CreationTimestamp *time.Time

	//  Shows whether you are sharing data with Rekognition to improve model
	// performance. You can choose this option at the account level or on a per-stream
	// basis. Note that if you opt out at the account level this setting is ignored on
	// individual streams.
	DataSharingPreference *types.StreamProcessorDataSharingPreference

	// Kinesis video stream that provides the source streaming video.
	Input *types.StreamProcessorInput

	//  The identifier for your AWS Key Management Service key (AWS KMS key). This is
	// an optional parameter for label detection stream processors.
	KmsKeyId *string

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

	// Name of the stream processor.
	Name *string

	// The Amazon Simple Notification Service topic to which Amazon Rekognition
	// publishes the object detection results and completion status of a video analysis
	// operation.
	//
	// Amazon Rekognition publishes a notification the first time an object of
	// interest or a person is detected in the video stream. For example, if Amazon
	// Rekognition detects a person at second 2, a pet at second 4, and a person again
	// at second 5, Amazon Rekognition sends 2 object class detected notifications, one
	// for a person at second 2 and one for a pet at second 4.
	//
	// Amazon Rekognition also publishes an an end-of-session notification with a
	// summary when the stream processing session is complete.
	NotificationChannel *types.StreamProcessorNotificationChannel

	// Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
	Output *types.StreamProcessorOutput

	//  Specifies locations in the frames where Amazon Rekognition checks for objects
	// or people. This is an optional parameter for label detection stream processors.
	RegionsOfInterest []types.RegionOfInterest

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

	// Input parameters used in a streaming video analyzed by a stream processor. You
	// can use FaceSearch to recognize faces in a streaming video, or you can use
	// ConnectedHome to detect labels.
	Settings *types.StreamProcessorSettings

	// Current status of the stream processor.
	Status types.StreamProcessorStatus

	// Detailed status message about the stream processor.
	StatusMessage *string

	// ARN of the stream processor.
	StreamProcessorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectCustomLabelsInput ¶

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 How Amazon Rekognition works
	// with IAM in the Amazon Rekognition Developer Guide.
	//
	// This member is required.
	Image *types.Image

	// The ARN of the model version that you want to use. Only models associated with
	// Custom Labels projects accepted by the operation. If a provided ARN refers to a
	// model version associated with a project for a different feature type, then an
	// InvalidParameterException is returned.
	//
	// This member is required.
	ProjectVersionArn *string

	// 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 *int32

	// Specifies the minimum confidence level for the labels to return.
	// DetectCustomLabels doesn't return any labels with a confidence value that's
	// lower than this specified value. If you specify a value of 0, DetectCustomLabels
	// returns all labels, regardless of the assumed threshold applied to each label.
	// If you don't specify a value for MinConfidence , DetectCustomLabels returns
	// labels based on the assumed threshold of each label.
	MinConfidence *float32
	// contains filtered or unexported fields
}

type DetectCustomLabelsOutput ¶

type DetectCustomLabelsOutput struct {

	// An array of custom labels detected in the input image.
	CustomLabels []types.CustomLabel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectFacesInput ¶

type DetectFacesInput 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.
	//
	// This member is required.
	Image *types.Image

	// An array of facial attributes you want to be returned. A DEFAULT subset of
	// facial attributes - BoundingBox , Confidence , Pose , Quality , and Landmarks -
	// will always be returned. You can request for specific facial attributes (in
	// addition to the default list) - by using [ "DEFAULT", "FACE_OCCLUDED" ] or just [
	// "FACE_OCCLUDED" ]. You can request for all facial attributes by using [ "ALL"] .
	// Requesting more attributes may increase response time.
	//
	// If you provide both, ["ALL", "DEFAULT"] , the service uses a logical "AND"
	// operator to determine which attributes to return (in this case, all attributes).
	//
	// Note that while the FaceOccluded and EyeDirection attributes are supported when
	// using DetectFaces , they aren't supported when analyzing videos with
	// StartFaceDetection and GetFaceDetection .
	Attributes []types.Attribute
	// contains filtered or unexported fields
}

type DetectFacesOutput ¶

type DetectFacesOutput struct {

	// Details of each face found in the image.
	FaceDetails []types.FaceDetail

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	Image *types.Image

	// A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the
	// label detection feature, while specifying IMAGE_PROPERTIES returns information
	// regarding image color and quality. If no option is specified GENERAL_LABELS is
	// used by default.
	Features []types.DetectLabelsFeatureName

	// Maximum number of labels you want the service to return in the response. The
	// service returns the specified number of highest confidence labels. Only valid
	// when GENERAL_LABELS is specified as a feature type in the Feature input
	// parameter.
	MaxLabels *int32

	// 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. Only valid when
	// GENERAL_LABELS is specified as a feature type in the Feature input parameter.
	MinConfidence *float32

	// A list of the filters to be applied to returned detected labels and image
	// properties. Specified filters can be inclusive, exclusive, or a combination of
	// both. Filters can be used for individual labels or label categories. The exact
	// label names or label categories must be supplied. For a full list of labels and
	// label categories, see [Detecting labels].
	//
	// [Detecting labels]: https://docs.aws.amazon.com/rekognition/latest/dg/labels.html
	Settings *types.DetectLabelsSettings
	// contains filtered or unexported fields
}

type DetectLabelsOutput ¶

type DetectLabelsOutput struct {

	// Information about the properties of the input image, such as brightness,
	// sharpness, contrast, and dominant colors.
	ImageProperties *types.DetectLabelsImageProperties

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

	// An array of labels for the real-world objects detected.
	Labels []types.Label

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectModerationLabelsInput ¶

type DetectModerationLabelsInput struct {

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

	// Sets up the configuration for human evaluation, including the FlowDefinition
	// the image will be sent to.
	HumanLoopConfig *types.HumanLoopConfig

	// 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 *float32

	// Identifier for the custom adapter. Expects the ProjectVersionArn as a value.
	// Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.
	ProjectVersion *string
	// contains filtered or unexported fields
}

type DetectModerationLabelsOutput ¶

type DetectModerationLabelsOutput struct {

	// A list of predicted results for the type of content an image contains. For
	// example, the image content might be from animation, sports, or a video game.
	ContentTypes []types.ContentType

	// Shows the results of the human in the loop evaluation.
	HumanLoopActivationOutput *types.HumanLoopActivationOutput

	// Array of detected Moderation labels. For video operations, this includes the
	// time, in milliseconds from the start of the video, they were detected.
	ModerationLabels []types.ModerationLabel

	// Version number of the base moderation detection model that was used to detect
	// unsafe content.
	ModerationModelVersion *string

	// Identifier of the custom adapter that was used during inference. If during
	// inference the adapter was EXPIRED, then the parameter will not be returned,
	// indicating that a base moderation detection project version was used.
	ProjectVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectProtectiveEquipmentInput ¶ added in v0.29.0

type DetectProtectiveEquipmentInput struct {

	// The image in which you want to detect PPE on detected persons. The image can be
	// passed as image bytes or you can reference an image stored in an Amazon S3
	// bucket.
	//
	// This member is required.
	Image *types.Image

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

type DetectProtectiveEquipmentOutput ¶ added in v0.29.0

type DetectProtectiveEquipmentOutput struct {

	// An array of persons detected in the image (including persons not wearing PPE).
	Persons []types.ProtectiveEquipmentPerson

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

	// Summary information for the types of PPE specified in the
	// SummarizationAttributes input parameter.
	Summary *types.ProtectiveEquipmentSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectTextInput ¶

type DetectTextInput struct {

	// The input image as base64-encoded bytes or an Amazon S3 object. If you use the
	// AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
	//
	// If you are using an AWS SDK to call Amazon Rekognition, you might not need to
	// base64-encode image bytes passed using the Bytes field. For more information,
	// see Images in the Amazon Rekognition developer guide.
	//
	// This member is required.
	Image *types.Image

	// Optional parameters that let you set the criteria that the text must meet to be
	// included in your response.
	Filters *types.DetectTextFilters
	// contains filtered or unexported fields
}

type DetectTextOutput ¶

type DetectTextOutput struct {

	// An array of text that was detected in the input image.
	TextDetections []types.TextDetection

	// The model version used to detect text.
	TextModelVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateFacesInput ¶ added in v1.29.0

type DisassociateFacesInput struct {

	// The ID of an existing collection containing the UserID.
	//
	// This member is required.
	CollectionId *string

	// An array of face IDs to disassociate from the UserID.
	//
	// This member is required.
	FaceIds []string

	// ID for the existing UserID.
	//
	// This member is required.
	UserId *string

	// Idempotent token used to identify the request to DisassociateFaces . If you use
	// the same token with multiple DisassociateFaces requests, the same response is
	// returned. Use ClientRequestToken to prevent the same request from being
	// processed more than once.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type DisassociateFacesOutput ¶ added in v1.29.0

type DisassociateFacesOutput struct {

	// An array of DissociatedFace objects containing FaceIds that are successfully
	// disassociated with the UserID is returned. Returned if the DisassociatedFaces
	// action is successful.
	DisassociatedFaces []types.DisassociatedFace

	// An array of UnsuccessfulDisassociation objects containing FaceIds that are not
	// successfully associated, along with the reasons for the failure to associate.
	// Returned if the DisassociateFaces action is successful.
	UnsuccessfulFaceDisassociations []types.UnsuccessfulFaceDisassociation

	// The status of an update made to a User. Reflects if the User has been updated
	// for every requested change.
	UserStatus types.UserStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DistributeDatasetEntriesInput ¶ added in v1.10.0

type DistributeDatasetEntriesInput struct {

	// The ARNS for the training dataset and test dataset that you want to use. The
	// datasets must belong to the same project. The test dataset must be empty.
	//
	// This member is required.
	Datasets []types.DistributeDataset
	// contains filtered or unexported fields
}

type DistributeDatasetEntriesOutput ¶ added in v1.10.0

type DistributeDatasetEntriesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters ¶ added in v1.30.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired ¶ added in v1.30.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults ¶ added in v1.30.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver ¶

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL ¶ added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc ¶

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint ¶

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions ¶ added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 ¶ added in v1.30.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 ¶ added in v1.30.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

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.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetCelebrityInfoOutput ¶

type GetCelebrityInfoOutput struct {

	// Retrieves the known gender for the celebrity.
	KnownGender *types.KnownGender

	// The name of the celebrity.
	Name *string

	// An array of URLs pointing to additional celebrity information.
	Urls []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCelebrityRecognitionAPIClient ¶ added in v0.30.0

type GetCelebrityRecognitionAPIClient interface {
	GetCelebrityRecognition(context.Context, *GetCelebrityRecognitionInput, ...func(*Options)) (*GetCelebrityRecognitionOutput, error)
}

GetCelebrityRecognitionAPIClient is a client that implements the GetCelebrityRecognition operation.

type GetCelebrityRecognitionInput ¶

type GetCelebrityRecognitionInput struct {

	// Job identifier for the required celebrity recognition analysis. You can get the
	// job identifer from a call to StartCelebrityRecognition .
	//
	// This member is required.
	JobId *string

	// 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 *int32

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

	// 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 types.CelebrityRecognitionSortBy
	// contains filtered or unexported fields
}

type GetCelebrityRecognitionOutput ¶

type GetCelebrityRecognitionOutput struct {

	// Array of celebrities recognized in the video.
	Celebrities []types.CelebrityRecognition

	// Job identifier for the celebrity recognition operation for which you want to
	// obtain results. The job identifer is returned by an initial call to
	// StartCelebrityRecognition.
	JobId *string

	// The current status of the celebrity recognition job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartCelebrityRecognition and
	// returned in the job completion notification sent to your Amazon Simple
	// Notification Service topic.
	JobTag *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 celebrities.
	NextToken *string

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// 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 *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCelebrityRecognitionPaginator ¶ added in v0.30.0

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

GetCelebrityRecognitionPaginator is a paginator for GetCelebrityRecognition

func NewGetCelebrityRecognitionPaginator ¶ added in v0.30.0

func NewGetCelebrityRecognitionPaginator(client GetCelebrityRecognitionAPIClient, params *GetCelebrityRecognitionInput, optFns ...func(*GetCelebrityRecognitionPaginatorOptions)) *GetCelebrityRecognitionPaginator

NewGetCelebrityRecognitionPaginator returns a new GetCelebrityRecognitionPaginator

func (*GetCelebrityRecognitionPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetCelebrityRecognitionPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCelebrityRecognitionPaginator) NextPage ¶ added in v0.30.0

func (p *GetCelebrityRecognitionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetCelebrityRecognitionOutput, error)

NextPage retrieves the next GetCelebrityRecognition page.

type GetCelebrityRecognitionPaginatorOptions ¶ added in v0.30.0

type GetCelebrityRecognitionPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetCelebrityRecognitionPaginatorOptions is the paginator options for GetCelebrityRecognition

type GetContentModerationAPIClient ¶ added in v0.30.0

type GetContentModerationAPIClient interface {
	GetContentModeration(context.Context, *GetContentModerationInput, ...func(*Options)) (*GetContentModerationOutput, error)
}

GetContentModerationAPIClient is a client that implements the GetContentModeration operation.

type GetContentModerationInput ¶

type GetContentModerationInput struct {

	// The identifier for the inappropriate, unwanted, or offensive content moderation
	// job. Use JobId to identify the job in a subsequent call to GetContentModeration .
	//
	// This member is required.
	JobId *string

	// Defines how to aggregate results of the StartContentModeration request. Default
	// aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels
	// over time.
	AggregateBy types.ContentModerationAggregateBy

	// 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 *int32

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

	// 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 types.ContentModerationSortBy
	// contains filtered or unexported fields
}

type GetContentModerationOutput ¶

type GetContentModerationOutput struct {

	// Information about the paramters used when getting a response. Includes
	// information on aggregation and sorting methods.
	GetRequestMetadata *types.GetContentModerationRequestMetadata

	// Job identifier for the content moderation operation for which you want to
	// obtain results. The job identifer is returned by an initial call to
	// StartContentModeration.
	JobId *string

	// The current status of the content moderation analysis job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartContentModeration and returned
	// in the job completion notification sent to your Amazon Simple Notification
	// Service topic.
	JobTag *string

	// The detected inappropriate, unwanted, or offensive content moderation labels
	// and the time(s) they were detected.
	ModerationLabels []types.ContentModerationDetection

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

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

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// Information about a video that Amazon Rekognition analyzed. Videometadata is
	// returned in every page of paginated responses from GetContentModeration .
	VideoMetadata *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetContentModerationPaginator ¶ added in v0.30.0

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

GetContentModerationPaginator is a paginator for GetContentModeration

func NewGetContentModerationPaginator ¶ added in v0.30.0

func NewGetContentModerationPaginator(client GetContentModerationAPIClient, params *GetContentModerationInput, optFns ...func(*GetContentModerationPaginatorOptions)) *GetContentModerationPaginator

NewGetContentModerationPaginator returns a new GetContentModerationPaginator

func (*GetContentModerationPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetContentModerationPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetContentModerationPaginator) NextPage ¶ added in v0.30.0

func (p *GetContentModerationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetContentModerationOutput, error)

NextPage retrieves the next GetContentModeration page.

type GetContentModerationPaginatorOptions ¶ added in v0.30.0

type GetContentModerationPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetContentModerationPaginatorOptions is the paginator options for GetContentModeration

type GetFaceDetectionAPIClient ¶ added in v0.30.0

type GetFaceDetectionAPIClient interface {
	GetFaceDetection(context.Context, *GetFaceDetectionInput, ...func(*Options)) (*GetFaceDetectionOutput, error)
}

GetFaceDetectionAPIClient is a client that implements the GetFaceDetection operation.

type GetFaceDetectionInput ¶

type GetFaceDetectionInput struct {

	// Unique identifier for the face detection job. The JobId is returned from
	// StartFaceDetection .
	//
	// This member is required.
	JobId *string

	// 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 *int32

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

type GetFaceDetectionOutput ¶

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 []types.FaceDetection

	// Job identifier for the face detection operation for which you want to obtain
	// results. The job identifer is returned by an initial call to StartFaceDetection.
	JobId *string

	// The current status of the face detection job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartFaceDetection and returned in
	// the job completion notification sent to your Amazon Simple Notification Service
	// topic.
	JobTag *string

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

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// 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 *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFaceDetectionPaginator ¶ added in v0.30.0

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

GetFaceDetectionPaginator is a paginator for GetFaceDetection

func NewGetFaceDetectionPaginator ¶ added in v0.30.0

func NewGetFaceDetectionPaginator(client GetFaceDetectionAPIClient, params *GetFaceDetectionInput, optFns ...func(*GetFaceDetectionPaginatorOptions)) *GetFaceDetectionPaginator

NewGetFaceDetectionPaginator returns a new GetFaceDetectionPaginator

func (*GetFaceDetectionPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetFaceDetectionPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetFaceDetectionPaginator) NextPage ¶ added in v0.30.0

func (p *GetFaceDetectionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFaceDetectionOutput, error)

NextPage retrieves the next GetFaceDetection page.

type GetFaceDetectionPaginatorOptions ¶ added in v0.30.0

type GetFaceDetectionPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetFaceDetectionPaginatorOptions is the paginator options for GetFaceDetection

type GetFaceLivenessSessionResultsInput ¶ added in v1.24.0

type GetFaceLivenessSessionResultsInput struct {

	// A unique 128-bit UUID. This is used to uniquely identify the session and also
	// acts as an idempotency token for all operations associated with the session.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetFaceLivenessSessionResultsOutput ¶ added in v1.24.0

type GetFaceLivenessSessionResultsOutput struct {

	// The sessionId for which this request was called.
	//
	// This member is required.
	SessionId *string

	// Represents a status corresponding to the state of the session. Possible
	// statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.
	//
	// This member is required.
	Status types.LivenessSessionStatus

	// A set of images from the Face Liveness video that can be used for audit
	// purposes. It includes a bounding box of the face and the Base64-encoded bytes
	// that return an image. If the CreateFaceLivenessSession request included an
	// OutputConfig argument, the image will be uploaded to an S3Object specified in
	// the output configuration. If no Amazon S3 bucket is defined, raw bytes are sent
	// instead.
	AuditImages []types.AuditImage

	// Probabalistic confidence score for if the person in the given video was live,
	// represented as a float value between 0 to 100.
	Confidence *float32

	// A high-quality image from the Face Liveness video that can be used for face
	// comparison or search. It includes a bounding box of the face and the
	// Base64-encoded bytes that return an image. If the CreateFaceLivenessSession
	// request included an OutputConfig argument, the image will be uploaded to an
	// S3Object specified in the output configuration. In case the reference image is
	// not returned, it's recommended to retry the Liveness check.
	ReferenceImage *types.AuditImage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFaceSearchAPIClient ¶ added in v0.30.0

type GetFaceSearchAPIClient interface {
	GetFaceSearch(context.Context, *GetFaceSearchInput, ...func(*Options)) (*GetFaceSearchOutput, error)
}

GetFaceSearchAPIClient is a client that implements the GetFaceSearch operation.

type GetFaceSearchInput ¶

type GetFaceSearchInput struct {

	// The job identifer for the search request. You get the job identifier from an
	// initial call to StartFaceSearch .
	//
	// This member is required.
	JobId *string

	// 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 *int32

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

	// 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 types.FaceSearchSortBy
	// contains filtered or unexported fields
}

type GetFaceSearchOutput ¶

type GetFaceSearchOutput struct {

	// Job identifier for the face search operation for which you want to obtain
	// results. The job identifer is returned by an initial call to StartFaceSearch.
	JobId *string

	// The current status of the face search job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartFaceSearch and returned in the
	// job completion notification sent to your Amazon Simple Notification Service
	// topic.
	JobTag *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 search
	// results.
	NextToken *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 []types.PersonMatch

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// Information about a video that Amazon Rekognition analyzed. Videometadata is
	// returned in every page of paginated responses from a Amazon Rekognition Video
	// operation.
	VideoMetadata *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFaceSearchPaginator ¶ added in v0.30.0

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

GetFaceSearchPaginator is a paginator for GetFaceSearch

func NewGetFaceSearchPaginator ¶ added in v0.30.0

func NewGetFaceSearchPaginator(client GetFaceSearchAPIClient, params *GetFaceSearchInput, optFns ...func(*GetFaceSearchPaginatorOptions)) *GetFaceSearchPaginator

NewGetFaceSearchPaginator returns a new GetFaceSearchPaginator

func (*GetFaceSearchPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetFaceSearchPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetFaceSearchPaginator) NextPage ¶ added in v0.30.0

func (p *GetFaceSearchPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFaceSearchOutput, error)

NextPage retrieves the next GetFaceSearch page.

type GetFaceSearchPaginatorOptions ¶ added in v0.30.0

type GetFaceSearchPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetFaceSearchPaginatorOptions is the paginator options for GetFaceSearch

type GetLabelDetectionAPIClient ¶ added in v0.30.0

type GetLabelDetectionAPIClient interface {
	GetLabelDetection(context.Context, *GetLabelDetectionInput, ...func(*Options)) (*GetLabelDetectionOutput, error)
}

GetLabelDetectionAPIClient is a client that implements the GetLabelDetection operation.

type GetLabelDetectionInput ¶

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 .
	//
	// This member is required.
	JobId *string

	// Defines how to aggregate the returned results. Results can be aggregated by
	// timestamps or segments.
	AggregateBy types.LabelDetectionAggregateBy

	// 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 *int32

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

	// 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 types.LabelDetectionSortBy
	// contains filtered or unexported fields
}

type GetLabelDetectionOutput ¶

type GetLabelDetectionOutput struct {

	// Information about the paramters used when getting a response. Includes
	// information on aggregation and sorting methods.
	GetRequestMetadata *types.GetLabelDetectionRequestMetadata

	// Job identifier for the label detection operation for which you want to obtain
	// results. The job identifer is returned by an initial call to
	// StartLabelDetection.
	JobId *string

	// The current status of the label detection job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartLabelDetection and returned in
	// the job completion notification sent to your Amazon Simple Notification Service
	// topic.
	JobTag *string

	// Version number of the label detection model that was used to detect labels.
	LabelModelVersion *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 []types.LabelDetection

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

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// 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 *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLabelDetectionPaginator ¶ added in v0.30.0

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

GetLabelDetectionPaginator is a paginator for GetLabelDetection

func NewGetLabelDetectionPaginator ¶ added in v0.30.0

func NewGetLabelDetectionPaginator(client GetLabelDetectionAPIClient, params *GetLabelDetectionInput, optFns ...func(*GetLabelDetectionPaginatorOptions)) *GetLabelDetectionPaginator

NewGetLabelDetectionPaginator returns a new GetLabelDetectionPaginator

func (*GetLabelDetectionPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetLabelDetectionPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetLabelDetectionPaginator) NextPage ¶ added in v0.30.0

func (p *GetLabelDetectionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetLabelDetectionOutput, error)

NextPage retrieves the next GetLabelDetection page.

type GetLabelDetectionPaginatorOptions ¶ added in v0.30.0

type GetLabelDetectionPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetLabelDetectionPaginatorOptions is the paginator options for GetLabelDetection

type GetMediaAnalysisJobInput ¶ added in v1.32.0

type GetMediaAnalysisJobInput struct {

	// Unique identifier for the media analysis job for which you want to retrieve
	// results.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type GetMediaAnalysisJobOutput ¶ added in v1.32.0

type GetMediaAnalysisJobOutput struct {

	// The Unix date and time when the job was started.
	//
	// This member is required.
	CreationTimestamp *time.Time

	// Reference to the input manifest that was provided in the job creation request.
	//
	// This member is required.
	Input *types.MediaAnalysisInput

	// The identifier for the media analysis job.
	//
	// This member is required.
	JobId *string

	// Operation configurations that were provided during job creation.
	//
	// This member is required.
	OperationsConfig *types.MediaAnalysisOperationsConfig

	// Output configuration that was provided in the creation request.
	//
	// This member is required.
	OutputConfig *types.MediaAnalysisOutputConfig

	// The current status of the media analysis job.
	//
	// This member is required.
	Status types.MediaAnalysisJobStatus

	// The Unix date and time when the job finished.
	CompletionTimestamp *time.Time

	// Details about the error that resulted in failure of the job.
	FailureDetails *types.MediaAnalysisJobFailureDetails

	// The name of the media analysis job.
	JobName *string

	// KMS Key that was provided in the creation request.
	KmsKeyId *string

	// The summary manifest provides statistics on input manifest and errors
	// identified in the input manifest.
	ManifestSummary *types.MediaAnalysisManifestSummary

	// Output manifest that contains prediction results.
	Results *types.MediaAnalysisResults

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPersonTrackingAPIClient ¶ added in v0.30.0

type GetPersonTrackingAPIClient interface {
	GetPersonTracking(context.Context, *GetPersonTrackingInput, ...func(*Options)) (*GetPersonTrackingOutput, error)
}

GetPersonTrackingAPIClient is a client that implements the GetPersonTracking operation.

type GetPersonTrackingInput ¶

type GetPersonTrackingInput struct {

	// The identifier for a job that tracks persons in a video. You get the JobId from
	// a call to StartPersonTracking .
	//
	// This member is required.
	JobId *string

	// 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 *int32

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

	// 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 types.PersonTrackingSortBy
	// contains filtered or unexported fields
}

type GetPersonTrackingOutput ¶

type GetPersonTrackingOutput struct {

	// Job identifier for the person tracking operation for which you want to obtain
	// results. The job identifer is returned by an initial call to
	// StartPersonTracking.
	JobId *string

	// The current status of the person tracking job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartCelebrityRecognition and
	// returned in the job completion notification sent to your Amazon Simple
	// Notification Service topic.
	JobTag *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 persons.
	NextToken *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 []types.PersonDetection

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// 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 *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPersonTrackingPaginator ¶ added in v0.30.0

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

GetPersonTrackingPaginator is a paginator for GetPersonTracking

func NewGetPersonTrackingPaginator ¶ added in v0.30.0

func NewGetPersonTrackingPaginator(client GetPersonTrackingAPIClient, params *GetPersonTrackingInput, optFns ...func(*GetPersonTrackingPaginatorOptions)) *GetPersonTrackingPaginator

NewGetPersonTrackingPaginator returns a new GetPersonTrackingPaginator

func (*GetPersonTrackingPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetPersonTrackingPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetPersonTrackingPaginator) NextPage ¶ added in v0.30.0

func (p *GetPersonTrackingPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetPersonTrackingOutput, error)

NextPage retrieves the next GetPersonTracking page.

type GetPersonTrackingPaginatorOptions ¶ added in v0.30.0

type GetPersonTrackingPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetPersonTrackingPaginatorOptions is the paginator options for GetPersonTracking

type GetSegmentDetectionAPIClient ¶ added in v0.30.0

type GetSegmentDetectionAPIClient interface {
	GetSegmentDetection(context.Context, *GetSegmentDetectionInput, ...func(*Options)) (*GetSegmentDetectionOutput, error)
}

GetSegmentDetectionAPIClient is a client that implements the GetSegmentDetection operation.

type GetSegmentDetectionInput ¶

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 .
	//
	// This member is required.
	JobId *string

	// Maximum number of results to return per paginated call. The largest value you
	// can specify is 1000.
	MaxResults *int32

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

type GetSegmentDetectionOutput ¶

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 []types.AudioMetadata

	// Job identifier for the segment detection operation for which you want to obtain
	// results. The job identifer is returned by an initial call to
	// StartSegmentDetection.
	JobId *string

	// Current status of the segment detection job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartSegmentDetection and returned in
	// the job completion notification sent to your Amazon Simple Notification Service
	// topic.
	JobTag *string

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

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

	// An array containing the segment types requested in the call to
	// StartSegmentDetection .
	SelectedSegmentTypes []types.SegmentTypeInfo

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *string

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// 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 []types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSegmentDetectionPaginator ¶ added in v0.30.0

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

GetSegmentDetectionPaginator is a paginator for GetSegmentDetection

func NewGetSegmentDetectionPaginator ¶ added in v0.30.0

func NewGetSegmentDetectionPaginator(client GetSegmentDetectionAPIClient, params *GetSegmentDetectionInput, optFns ...func(*GetSegmentDetectionPaginatorOptions)) *GetSegmentDetectionPaginator

NewGetSegmentDetectionPaginator returns a new GetSegmentDetectionPaginator

func (*GetSegmentDetectionPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetSegmentDetectionPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetSegmentDetectionPaginator) NextPage ¶ added in v0.30.0

func (p *GetSegmentDetectionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetSegmentDetectionOutput, error)

NextPage retrieves the next GetSegmentDetection page.

type GetSegmentDetectionPaginatorOptions ¶ added in v0.30.0

type GetSegmentDetectionPaginatorOptions struct {
	// Maximum number of results to return per paginated call. The largest value you
	// can specify is 1000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetSegmentDetectionPaginatorOptions is the paginator options for GetSegmentDetection

type GetTextDetectionAPIClient ¶ added in v0.30.0

type GetTextDetectionAPIClient interface {
	GetTextDetection(context.Context, *GetTextDetectionInput, ...func(*Options)) (*GetTextDetectionOutput, error)
}

GetTextDetectionAPIClient is a client that implements the GetTextDetection operation.

type GetTextDetectionInput ¶

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 .
	//
	// This member is required.
	JobId *string

	// Maximum number of results to return per paginated call. The largest value you
	// can specify is 1000.
	MaxResults *int32

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

type GetTextDetectionOutput ¶

type GetTextDetectionOutput struct {

	// Job identifier for the text detection operation for which you want to obtain
	// results. The job identifer is returned by an initial call to StartTextDetection.
	JobId *string

	// Current status of the text detection job.
	JobStatus types.VideoJobStatus

	// A job identifier specified in the call to StartTextDetection and returned in
	// the job completion notification sent to your Amazon Simple Notification Service
	// topic.
	JobTag *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 text.
	NextToken *string

	// If the job fails, StatusMessage provides a descriptive error message.
	StatusMessage *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 []types.TextDetectionResult

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

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	Video *types.Video

	// Information about a video that Amazon Rekognition analyzed. Videometadata is
	// returned in every page of paginated responses from a Amazon Rekognition video
	// operation.
	VideoMetadata *types.VideoMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTextDetectionPaginator ¶ added in v0.30.0

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

GetTextDetectionPaginator is a paginator for GetTextDetection

func NewGetTextDetectionPaginator ¶ added in v0.30.0

func NewGetTextDetectionPaginator(client GetTextDetectionAPIClient, params *GetTextDetectionInput, optFns ...func(*GetTextDetectionPaginatorOptions)) *GetTextDetectionPaginator

NewGetTextDetectionPaginator returns a new GetTextDetectionPaginator

func (*GetTextDetectionPaginator) HasMorePages ¶ added in v0.30.0

func (p *GetTextDetectionPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetTextDetectionPaginator) NextPage ¶ added in v0.30.0

func (p *GetTextDetectionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTextDetectionOutput, error)

NextPage retrieves the next GetTextDetection page.

type GetTextDetectionPaginatorOptions ¶ added in v0.30.0

type GetTextDetectionPaginatorOptions struct {
	// Maximum number of results to return per paginated call. The largest value you
	// can specify is 1000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetTextDetectionPaginatorOptions is the paginator options for GetTextDetection

type HTTPClient ¶

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 ¶

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider ¶ added in v1.29.0

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

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.
	//
	// This member is required.
	CollectionId *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.
	//
	// This member is required.
	Image *types.Image

	// An array of facial attributes you want to be returned. A DEFAULT subset of
	// facial attributes - BoundingBox , Confidence , Pose , Quality , and Landmarks -
	// will always be returned. You can request for specific facial attributes (in
	// addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just
	// ["FACE_OCCLUDED"] . You can request for all facial attributes by using ["ALL"] .
	// Requesting more attributes may increase response time.
	//
	// 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 []types.Attribute

	// The ID you want to assign to all the faces detected in the image.
	ExternalImageId *string

	// 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 *int32

	// 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 types.QualityFilter
	// contains filtered or unexported fields
}

type IndexFacesOutput ¶

type IndexFacesOutput struct {

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

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

	// An array of faces that were detected in the image but weren't indexed. They
	// weren't indexed because the quality filter identified them as low quality, or
	// the MaxFaces request parameter filtered them out. To use the quality filter,
	// you specify the QualityFilter request parameter.
	UnindexedFaces []types.UnindexedFace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCollectionsAPIClient ¶ added in v0.30.0

type ListCollectionsAPIClient interface {
	ListCollections(context.Context, *ListCollectionsInput, ...func(*Options)) (*ListCollectionsOutput, error)
}

ListCollectionsAPIClient is a client that implements the ListCollections operation.

type ListCollectionsInput ¶

type ListCollectionsInput struct {

	// Maximum number of collection IDs to return.
	MaxResults *int32

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

type ListCollectionsOutput ¶

type ListCollectionsOutput struct {

	// An array of collection IDs.
	CollectionIds []string

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCollectionsPaginator ¶ added in v0.30.0

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

ListCollectionsPaginator is a paginator for ListCollections

func NewListCollectionsPaginator ¶ added in v0.30.0

func NewListCollectionsPaginator(client ListCollectionsAPIClient, params *ListCollectionsInput, optFns ...func(*ListCollectionsPaginatorOptions)) *ListCollectionsPaginator

NewListCollectionsPaginator returns a new ListCollectionsPaginator

func (*ListCollectionsPaginator) HasMorePages ¶ added in v0.30.0

func (p *ListCollectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCollectionsPaginator) NextPage ¶ added in v0.30.0

func (p *ListCollectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCollectionsOutput, error)

NextPage retrieves the next ListCollections page.

type ListCollectionsPaginatorOptions ¶ added in v0.30.0

type ListCollectionsPaginatorOptions struct {
	// Maximum number of collection IDs to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCollectionsPaginatorOptions is the paginator options for ListCollections

type ListDatasetEntriesAPIClient ¶ added in v1.10.0

type ListDatasetEntriesAPIClient interface {
	ListDatasetEntries(context.Context, *ListDatasetEntriesInput, ...func(*Options)) (*ListDatasetEntriesOutput, error)
}

ListDatasetEntriesAPIClient is a client that implements the ListDatasetEntries operation.

type ListDatasetEntriesInput ¶ added in v1.10.0

type ListDatasetEntriesInput struct {

	//  The Amazon Resource Name (ARN) for the dataset that you want to use.
	//
	// This member is required.
	DatasetArn *string

	// Specifies a label filter for the response. The response includes an entry only
	// if one or more of the labels in ContainsLabels exist in the entry.
	ContainsLabels []string

	// Specifies an error filter for the response. Specify True to only include
	// entries that have errors.
	HasErrors *bool

	//  Specify true to get only the JSON Lines where the image is labeled. Specify
	// false to get only the JSON Lines where the image isn't labeled. If you don't
	// specify Labeled , ListDatasetEntries returns JSON Lines for labeled and
	// unlabeled images.
	Labeled *bool

	// 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 *int32

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

	// If specified, ListDatasetEntries only returns JSON Lines where the value of
	// SourceRefContains is part of the source-ref field. The source-ref field
	// contains the Amazon S3 location of the image. You can use SouceRefContains for
	// tasks such as getting the JSON Line for a single image, or gettting JSON Lines
	// for all images within a specific folder.
	SourceRefContains *string
	// contains filtered or unexported fields
}

type ListDatasetEntriesOutput ¶ added in v1.10.0

type ListDatasetEntriesOutput struct {

	//  A list of entries (images) in the dataset.
	DatasetEntries []string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetEntriesPaginator ¶ added in v1.10.0

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

ListDatasetEntriesPaginator is a paginator for ListDatasetEntries

func NewListDatasetEntriesPaginator ¶ added in v1.10.0

func NewListDatasetEntriesPaginator(client ListDatasetEntriesAPIClient, params *ListDatasetEntriesInput, optFns ...func(*ListDatasetEntriesPaginatorOptions)) *ListDatasetEntriesPaginator

NewListDatasetEntriesPaginator returns a new ListDatasetEntriesPaginator

func (*ListDatasetEntriesPaginator) HasMorePages ¶ added in v1.10.0

func (p *ListDatasetEntriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetEntriesPaginator) NextPage ¶ added in v1.10.0

func (p *ListDatasetEntriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetEntriesOutput, error)

NextPage retrieves the next ListDatasetEntries page.

type ListDatasetEntriesPaginatorOptions ¶ added in v1.10.0

type ListDatasetEntriesPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetEntriesPaginatorOptions is the paginator options for ListDatasetEntries

type ListDatasetLabelsAPIClient ¶ added in v1.10.0

type ListDatasetLabelsAPIClient interface {
	ListDatasetLabels(context.Context, *ListDatasetLabelsInput, ...func(*Options)) (*ListDatasetLabelsOutput, error)
}

ListDatasetLabelsAPIClient is a client that implements the ListDatasetLabels operation.

type ListDatasetLabelsInput ¶ added in v1.10.0

type ListDatasetLabelsInput struct {

	//  The Amazon Resource Name (ARN) of the dataset that you want to use.
	//
	// This member is required.
	DatasetArn *string

	// 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 *int32

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

type ListDatasetLabelsOutput ¶ added in v1.10.0

type ListDatasetLabelsOutput struct {

	//  A list of the labels in the dataset.
	DatasetLabelDescriptions []types.DatasetLabelDescription

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetLabelsPaginator ¶ added in v1.10.0

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

ListDatasetLabelsPaginator is a paginator for ListDatasetLabels

func NewListDatasetLabelsPaginator ¶ added in v1.10.0

func NewListDatasetLabelsPaginator(client ListDatasetLabelsAPIClient, params *ListDatasetLabelsInput, optFns ...func(*ListDatasetLabelsPaginatorOptions)) *ListDatasetLabelsPaginator

NewListDatasetLabelsPaginator returns a new ListDatasetLabelsPaginator

func (*ListDatasetLabelsPaginator) HasMorePages ¶ added in v1.10.0

func (p *ListDatasetLabelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetLabelsPaginator) NextPage ¶ added in v1.10.0

func (p *ListDatasetLabelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetLabelsOutput, error)

NextPage retrieves the next ListDatasetLabels page.

type ListDatasetLabelsPaginatorOptions ¶ added in v1.10.0

type ListDatasetLabelsPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetLabelsPaginatorOptions is the paginator options for ListDatasetLabels

type ListFacesAPIClient ¶ added in v0.30.0

type ListFacesAPIClient interface {
	ListFaces(context.Context, *ListFacesInput, ...func(*Options)) (*ListFacesOutput, error)
}

ListFacesAPIClient is a client that implements the ListFaces operation.

type ListFacesInput ¶

type ListFacesInput struct {

	// ID of the collection from which to list the faces.
	//
	// This member is required.
	CollectionId *string

	// An array of face IDs to filter results with when listing faces in a collection.
	FaceIds []string

	// Maximum number of faces to return.
	MaxResults *int32

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

	// An array of user IDs to filter results with when listing faces in a collection.
	UserId *string
	// contains filtered or unexported fields
}

type ListFacesOutput ¶

type ListFacesOutput struct {

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

	// An array of Face objects.
	Faces []types.Face

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFacesPaginator ¶ added in v0.30.0

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

ListFacesPaginator is a paginator for ListFaces

func NewListFacesPaginator ¶ added in v0.30.0

func NewListFacesPaginator(client ListFacesAPIClient, params *ListFacesInput, optFns ...func(*ListFacesPaginatorOptions)) *ListFacesPaginator

NewListFacesPaginator returns a new ListFacesPaginator

func (*ListFacesPaginator) HasMorePages ¶ added in v0.30.0

func (p *ListFacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFacesPaginator) NextPage ¶ added in v0.30.0

func (p *ListFacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFacesOutput, error)

NextPage retrieves the next ListFaces page.

type ListFacesPaginatorOptions ¶ added in v0.30.0

type ListFacesPaginatorOptions struct {
	// Maximum number of faces to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFacesPaginatorOptions is the paginator options for ListFaces

type ListMediaAnalysisJobsAPIClient ¶ added in v1.32.0

type ListMediaAnalysisJobsAPIClient interface {
	ListMediaAnalysisJobs(context.Context, *ListMediaAnalysisJobsInput, ...func(*Options)) (*ListMediaAnalysisJobsOutput, error)
}

ListMediaAnalysisJobsAPIClient is a client that implements the ListMediaAnalysisJobs operation.

type ListMediaAnalysisJobsInput ¶ added in v1.32.0

type ListMediaAnalysisJobsInput struct {

	// The maximum number of results to return per paginated call. The largest value
	// user can specify is 100. If user specifies a value greater than 100, an
	// InvalidParameterException error occurs. The default value is 100.
	MaxResults *int32

	// Pagination token, if the previous response was incomplete.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMediaAnalysisJobsOutput ¶ added in v1.32.0

type ListMediaAnalysisJobsOutput struct {

	// Contains a list of all media analysis jobs.
	//
	// This member is required.
	MediaAnalysisJobs []types.MediaAnalysisJobDescription

	// Pagination token, if the previous response was incomplete.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMediaAnalysisJobsPaginator ¶ added in v1.32.0

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

ListMediaAnalysisJobsPaginator is a paginator for ListMediaAnalysisJobs

func NewListMediaAnalysisJobsPaginator ¶ added in v1.32.0

func NewListMediaAnalysisJobsPaginator(client ListMediaAnalysisJobsAPIClient, params *ListMediaAnalysisJobsInput, optFns ...func(*ListMediaAnalysisJobsPaginatorOptions)) *ListMediaAnalysisJobsPaginator

NewListMediaAnalysisJobsPaginator returns a new ListMediaAnalysisJobsPaginator

func (*ListMediaAnalysisJobsPaginator) HasMorePages ¶ added in v1.32.0

func (p *ListMediaAnalysisJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMediaAnalysisJobsPaginator) NextPage ¶ added in v1.32.0

func (p *ListMediaAnalysisJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMediaAnalysisJobsOutput, error)

NextPage retrieves the next ListMediaAnalysisJobs page.

type ListMediaAnalysisJobsPaginatorOptions ¶ added in v1.32.0

type ListMediaAnalysisJobsPaginatorOptions struct {
	// The maximum number of results to return per paginated call. The largest value
	// user can specify is 100. If user specifies a value greater than 100, an
	// InvalidParameterException error occurs. The default value is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMediaAnalysisJobsPaginatorOptions is the paginator options for ListMediaAnalysisJobs

type ListProjectPoliciesAPIClient ¶ added in v1.20.0

type ListProjectPoliciesAPIClient interface {
	ListProjectPolicies(context.Context, *ListProjectPoliciesInput, ...func(*Options)) (*ListProjectPoliciesOutput, error)
}

ListProjectPoliciesAPIClient is a client that implements the ListProjectPolicies operation.

type ListProjectPoliciesInput ¶ added in v1.20.0

type ListProjectPoliciesInput struct {

	// The ARN of the project for which you want to list the project policies.
	//
	// This member is required.
	ProjectArn *string

	// The maximum number of results to return per paginated call. The largest value
	// you can specify is 5. If you specify a value greater than 5, a
	// ValidationException error occurs. The default value is 5.
	MaxResults *int32

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

type ListProjectPoliciesOutput ¶ added in v1.20.0

type ListProjectPoliciesOutput struct {

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

	// A list of project policies attached to the project.
	ProjectPolicies []types.ProjectPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProjectPoliciesPaginator ¶ added in v1.20.0

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

ListProjectPoliciesPaginator is a paginator for ListProjectPolicies

func NewListProjectPoliciesPaginator ¶ added in v1.20.0

func NewListProjectPoliciesPaginator(client ListProjectPoliciesAPIClient, params *ListProjectPoliciesInput, optFns ...func(*ListProjectPoliciesPaginatorOptions)) *ListProjectPoliciesPaginator

NewListProjectPoliciesPaginator returns a new ListProjectPoliciesPaginator

func (*ListProjectPoliciesPaginator) HasMorePages ¶ added in v1.20.0

func (p *ListProjectPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectPoliciesPaginator) NextPage ¶ added in v1.20.0

func (p *ListProjectPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectPoliciesOutput, error)

NextPage retrieves the next ListProjectPolicies page.

type ListProjectPoliciesPaginatorOptions ¶ added in v1.20.0

type ListProjectPoliciesPaginatorOptions struct {
	// The maximum number of results to return per paginated call. The largest value
	// you can specify is 5. If you specify a value greater than 5, a
	// ValidationException error occurs. The default value is 5.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProjectPoliciesPaginatorOptions is the paginator options for ListProjectPolicies

type ListStreamProcessorsAPIClient ¶ added in v0.30.0

type ListStreamProcessorsAPIClient interface {
	ListStreamProcessors(context.Context, *ListStreamProcessorsInput, ...func(*Options)) (*ListStreamProcessorsOutput, error)
}

ListStreamProcessorsAPIClient is a client that implements the ListStreamProcessors operation.

type ListStreamProcessorsInput ¶

type ListStreamProcessorsInput struct {

	// Maximum number of stream processors you want Amazon Rekognition Video to return
	// in the response. The default is 1000.
	MaxResults *int32

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

type ListStreamProcessorsOutput ¶

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

	// List of stream processors that you have created.
	StreamProcessors []types.StreamProcessor

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStreamProcessorsPaginator ¶ added in v0.30.0

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

ListStreamProcessorsPaginator is a paginator for ListStreamProcessors

func NewListStreamProcessorsPaginator ¶ added in v0.30.0

func NewListStreamProcessorsPaginator(client ListStreamProcessorsAPIClient, params *ListStreamProcessorsInput, optFns ...func(*ListStreamProcessorsPaginatorOptions)) *ListStreamProcessorsPaginator

NewListStreamProcessorsPaginator returns a new ListStreamProcessorsPaginator

func (*ListStreamProcessorsPaginator) HasMorePages ¶ added in v0.30.0

func (p *ListStreamProcessorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamProcessorsPaginator) NextPage ¶ added in v0.30.0

func (p *ListStreamProcessorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamProcessorsOutput, error)

NextPage retrieves the next ListStreamProcessors page.

type ListStreamProcessorsPaginatorOptions ¶ added in v0.30.0

type ListStreamProcessorsPaginatorOptions struct {
	// Maximum number of stream processors you want Amazon Rekognition Video to return
	// in the response. The default is 1000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStreamProcessorsPaginatorOptions is the paginator options for ListStreamProcessors

type ListTagsForResourceInput ¶ added in v1.3.0

type ListTagsForResourceInput struct {

	//  Amazon Resource Name (ARN) of the model, collection, or stream processor that
	// contains the tags that you want a list of.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput ¶ added in v1.3.0

type ListTagsForResourceOutput struct {

	//  A list of key-value tags assigned to the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsersAPIClient ¶ added in v1.29.0

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

type ListUsersInput ¶ added in v1.29.0

type ListUsersInput struct {

	// The ID of an existing collection.
	//
	// This member is required.
	CollectionId *string

	// Maximum number of UsersID to return.
	MaxResults *int32

	// Pagingation token to receive the next set of UsersID.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUsersOutput ¶ added in v1.29.0

type ListUsersOutput struct {

	// A pagination token to be used with the subsequent request if the response is
	// truncated.
	NextToken *string

	// List of UsersID associated with the specified collection.
	Users []types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsersPaginator ¶ added in v1.29.0

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

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator ¶ added in v1.29.0

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages ¶ added in v1.29.0

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage ¶ added in v1.29.0

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions ¶ added in v1.29.0

type ListUsersPaginatorOptions struct {
	// Maximum number of UsersID to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUsersPaginatorOptions is the paginator options for ListUsers

type Options ¶

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy ¶

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver ¶ added in v1.34.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ProjectVersionRunningWaiter ¶ added in v0.31.0

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

ProjectVersionRunningWaiter defines the waiters for ProjectVersionRunning

func NewProjectVersionRunningWaiter ¶ added in v0.31.0

func NewProjectVersionRunningWaiter(client DescribeProjectVersionsAPIClient, optFns ...func(*ProjectVersionRunningWaiterOptions)) *ProjectVersionRunningWaiter

NewProjectVersionRunningWaiter constructs a ProjectVersionRunningWaiter.

func (*ProjectVersionRunningWaiter) Wait ¶ added in v0.31.0

func (w *ProjectVersionRunningWaiter) Wait(ctx context.Context, params *DescribeProjectVersionsInput, maxWaitDur time.Duration, optFns ...func(*ProjectVersionRunningWaiterOptions)) error

Wait calls the waiter function for ProjectVersionRunning waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ProjectVersionRunningWaiter) WaitForOutput ¶ added in v1.11.0

func (w *ProjectVersionRunningWaiter) WaitForOutput(ctx context.Context, params *DescribeProjectVersionsInput, maxWaitDur time.Duration, optFns ...func(*ProjectVersionRunningWaiterOptions)) (*DescribeProjectVersionsOutput, error)

WaitForOutput calls the waiter function for ProjectVersionRunning waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ProjectVersionRunningWaiterOptions ¶ added in v0.31.0

type ProjectVersionRunningWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ProjectVersionRunningWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ProjectVersionRunningWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeProjectVersionsInput, *DescribeProjectVersionsOutput, error) (bool, error)
}

ProjectVersionRunningWaiterOptions are waiter options for ProjectVersionRunningWaiter

type ProjectVersionTrainingCompletedWaiter ¶ added in v0.31.0

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

ProjectVersionTrainingCompletedWaiter defines the waiters for ProjectVersionTrainingCompleted

func NewProjectVersionTrainingCompletedWaiter ¶ added in v0.31.0

func NewProjectVersionTrainingCompletedWaiter(client DescribeProjectVersionsAPIClient, optFns ...func(*ProjectVersionTrainingCompletedWaiterOptions)) *ProjectVersionTrainingCompletedWaiter

NewProjectVersionTrainingCompletedWaiter constructs a ProjectVersionTrainingCompletedWaiter.

func (*ProjectVersionTrainingCompletedWaiter) Wait ¶ added in v0.31.0

func (w *ProjectVersionTrainingCompletedWaiter) Wait(ctx context.Context, params *DescribeProjectVersionsInput, maxWaitDur time.Duration, optFns ...func(*ProjectVersionTrainingCompletedWaiterOptions)) error

Wait calls the waiter function for ProjectVersionTrainingCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ProjectVersionTrainingCompletedWaiter) WaitForOutput ¶ added in v1.11.0

func (w *ProjectVersionTrainingCompletedWaiter) WaitForOutput(ctx context.Context, params *DescribeProjectVersionsInput, maxWaitDur time.Duration, optFns ...func(*ProjectVersionTrainingCompletedWaiterOptions)) (*DescribeProjectVersionsOutput, error)

WaitForOutput calls the waiter function for ProjectVersionTrainingCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ProjectVersionTrainingCompletedWaiterOptions ¶ added in v0.31.0

type ProjectVersionTrainingCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ProjectVersionTrainingCompletedWaiter will use default minimum delay of 120
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ProjectVersionTrainingCompletedWaiter will use default max delay of
	// 120 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeProjectVersionsInput, *DescribeProjectVersionsOutput, error) (bool, error)
}

ProjectVersionTrainingCompletedWaiterOptions are waiter options for ProjectVersionTrainingCompletedWaiter

type PutProjectPolicyInput ¶ added in v1.20.0

type PutProjectPolicyInput struct {

	// A resource policy to add to the model. The policy is a JSON structure that
	// contains one or more statements that define the policy. The policy must follow
	// the IAM syntax. For more information about the contents of a JSON policy
	// document, see [IAM JSON policy reference].
	//
	// [IAM JSON policy reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
	//
	// This member is required.
	PolicyDocument *string

	// A name for the policy.
	//
	// This member is required.
	PolicyName *string

	// The Amazon Resource Name (ARN) of the project that the project policy is
	// attached to.
	//
	// This member is required.
	ProjectArn *string

	// The revision ID for the Project Policy. Each time you modify a policy, Amazon
	// Rekognition Custom Labels generates and assigns a new PolicyRevisionId and then
	// deletes the previous version of the policy.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type PutProjectPolicyOutput ¶ added in v1.20.0

type PutProjectPolicyOutput struct {

	// The ID of the project policy.
	PolicyRevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	Image *types.Image
	// contains filtered or unexported fields
}

type RecognizeCelebritiesOutput ¶

type RecognizeCelebritiesOutput struct {

	// Details about each celebrity found in the image. Amazon Rekognition can detect
	// a maximum of 64 celebrities in an image. Each celebrity object includes the
	// following attributes: Face , Confidence , Emotions , Landmarks , Pose , Quality
	// , Smile , Id , KnownGender , MatchConfidence , Name , Urls .
	CelebrityFaces []types.Celebrity

	// Support for estimating image orientation using the the OrientationCorrection
	// field has ceased as of August 2021. Any returned values for this field included
	// in an API response will always be NULL.
	//
	// The orientation of the input image (counterclockwise direction). If your
	// application displays the image, you can use this value to correct the
	// orientation. The bounding box coordinates returned in CelebrityFaces and
	// UnrecognizedFaces represent face locations before the image orientation is
	// corrected.
	//
	// If the input image is in .jpeg format, it might contain exchangeable image
	// (Exif) metadata that includes the image's orientation. If so, and the Exif
	// metadata for the input image populates the orientation field, the value of
	// OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces
	// bounding box coordinates represent face locations after Exif metadata is used to
	// correct the image orientation. Images in .png format don't contain Exif
	// metadata.
	OrientationCorrection types.OrientationCorrection

	// Details about each unrecognized face in the image.
	UnrecognizedFaces []types.ComparedFace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint ¶

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize ¶

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID ¶

func (*ResolveEndpoint) ID() string

type SearchFacesByImageInput ¶

type SearchFacesByImageInput struct {

	// ID of the collection to search.
	//
	// This member is required.
	CollectionId *string

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

	// (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 *float32

	// Maximum number of faces to return. The operation returns the maximum number of
	// faces with the highest confidence in the match.
	MaxFaces *int32

	// 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 types.QualityFilter
	// contains filtered or unexported fields
}

type SearchFacesByImageOutput ¶

type SearchFacesByImageOutput struct {

	// An array of faces that match the input face, along with the confidence in the
	// match.
	FaceMatches []types.FaceMatch

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

	// The bounding box around the face in the input image that Amazon Rekognition
	// used for the search.
	SearchedFaceBoundingBox *types.BoundingBox

	// The level of confidence that the searchedFaceBoundingBox , contains a face.
	SearchedFaceConfidence *float32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchFacesInput ¶

type SearchFacesInput struct {

	// ID of the collection the face belongs to.
	//
	// This member is required.
	CollectionId *string

	// ID of a face to find matches for in the collection.
	//
	// This member is required.
	FaceId *string

	// 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 *float32

	// Maximum number of faces to return. The operation returns the maximum number of
	// faces with the highest confidence in the match.
	MaxFaces *int32
	// contains filtered or unexported fields
}

type SearchFacesOutput ¶

type SearchFacesOutput struct {

	// An array of faces that matched the input face, along with the confidence in the
	// match.
	FaceMatches []types.FaceMatch

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

	// ID of the face that was searched for matches in a collection.
	SearchedFaceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchUsersByImageInput ¶ added in v1.29.0

type SearchUsersByImageInput struct {

	// The ID of an existing collection containing the UserID.
	//
	// This member is required.
	CollectionId *string

	// 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 How Amazon Rekognition works
	// with IAM in the Amazon Rekognition Developer Guide.
	//
	// This member is required.
	Image *types.Image

	// Maximum number of UserIDs to return.
	MaxUsers *int32

	// 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. The
	// default value is NONE.
	QualityFilter types.QualityFilter

	// Specifies the minimum confidence in the UserID match to return. Default value
	// is 80.
	UserMatchThreshold *float32
	// contains filtered or unexported fields
}

type SearchUsersByImageOutput ¶ added in v1.29.0

type SearchUsersByImageOutput struct {

	// Version number of the face detection model associated with the input collection
	// CollectionId.
	FaceModelVersion *string

	// A list of FaceDetail objects containing the BoundingBox for the largest face in
	// image, as well as the confidence in the bounding box, that was searched for
	// matches. If no valid face is detected in the image the response will contain no
	// SearchedFace object.
	SearchedFace *types.SearchedFaceDetails

	// List of UnsearchedFace objects. Contains the face details infered from the
	// specified image but not used for search. Contains reasons that describe why a
	// face wasn't used for Search.
	UnsearchedFaces []types.UnsearchedFace

	// An array of UserID objects that matched the input face, along with the
	// confidence in the match. The returned structure will be empty if there are no
	// matches. Returned if the SearchUsersByImageResponse action is successful.
	UserMatches []types.UserMatch

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchUsersInput ¶ added in v1.29.0

type SearchUsersInput struct {

	// The ID of an existing collection containing the UserID, used with a UserId or
	// FaceId. If a FaceId is provided, UserId isn’t required to be present in the
	// Collection.
	//
	// This member is required.
	CollectionId *string

	// ID for the existing face.
	FaceId *string

	// Maximum number of identities to return.
	MaxUsers *int32

	// ID for the existing User.
	UserId *string

	// Optional value that specifies the minimum confidence in the matched UserID to
	// return. Default value of 80.
	UserMatchThreshold *float32
	// contains filtered or unexported fields
}

type SearchUsersOutput ¶ added in v1.29.0

type SearchUsersOutput struct {

	// Version number of the face detection model associated with the input
	// CollectionId.
	FaceModelVersion *string

	// Contains the ID of a face that was used to search for matches in a collection.
	SearchedFace *types.SearchedFace

	// Contains the ID of the UserID that was used to search for matches in a
	// collection.
	SearchedUser *types.SearchedUser

	// An array of UserMatch objects that matched the input face along with the
	// confidence in the match. Array will be empty if there are no matches.
	UserMatches []types.UserMatch

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartCelebrityRecognitionInput ¶

type StartCelebrityRecognitionInput struct {

	// The video in which you want to recognize celebrities. The video must be stored
	// in an Amazon S3 bucket.
	//
	// This member is required.
	Video *types.Video

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

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

	// The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the
	// completion status of the celebrity recognition analysis to. The Amazon SNS topic
	// must have a topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy.
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartCelebrityRecognitionOutput ¶

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartContentModerationInput ¶

type StartContentModerationInput struct {

	// The video in which you want to detect inappropriate, unwanted, or offensive
	// content. The video must be stored in an Amazon S3 bucket.
	//
	// This member is required.
	Video *types.Video

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

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

	// 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 *float32

	// The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the
	// completion status of the content analysis to. The Amazon SNS topic must have a
	// topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy to access the topic.
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartContentModerationOutput ¶

type StartContentModerationOutput struct {

	// The identifier for the content analysis job. Use JobId to identify the job in a
	// subsequent call to GetContentModeration .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartFaceDetectionInput ¶

type StartFaceDetectionInput struct {

	// The video in which you want to detect faces. The video must be stored in an
	// Amazon S3 bucket.
	//
	// This member is required.
	Video *types.Video

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

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

	// An identifier you specify that's returned in the completion notification that's
	// published to your Amazon Simple Notification Service topic. For example, you can
	// use JobTag to group related jobs and identify them in the completion
	// notification.
	JobTag *string

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to
	// publish the completion status of the face detection operation. The Amazon SNS
	// topic must have a topic name that begins with AmazonRekognition if you are using
	// the AmazonRekognitionServiceRole permissions policy.
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartFaceDetectionOutput ¶

type StartFaceDetectionOutput struct {

	// The identifier for the face detection job. Use JobId to identify the job in a
	// subsequent call to GetFaceDetection .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartFaceSearchInput ¶

type StartFaceSearchInput struct {

	// ID of the collection that contains the faces you want to search for.
	//
	// This member is required.
	CollectionId *string

	// The video you want to search. The video must be stored in an Amazon S3 bucket.
	//
	// This member is required.
	Video *types.Video

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

	// 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 *float32

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

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to
	// publish the completion status of the search. The Amazon SNS topic must have a
	// topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy to access the topic.
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartFaceSearchOutput ¶

type StartFaceSearchOutput struct {

	// The identifier for the search job. Use JobId to identify the job in a
	// subsequent call to GetFaceSearch .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartLabelDetectionInput ¶

type StartLabelDetectionInput struct {

	// The video in which you want to detect labels. The video must be stored in an
	// Amazon S3 bucket.
	//
	// This member is required.
	Video *types.Video

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

	// The features to return after video analysis. You can specify that
	// GENERAL_LABELS are returned.
	Features []types.LabelDetectionFeatureName

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

	// 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 and bounding
	// boxes (if detected) with confidence values greater than or equal to 50 percent.
	MinConfidence *float32

	// The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the
	// completion status of the label detection operation to. The Amazon SNS topic must
	// have a topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy.
	NotificationChannel *types.NotificationChannel

	// The settings for a StartLabelDetection request.Contains the specified
	// parameters for the label detection request of an asynchronous label analysis
	// operation. Settings can include filters for GENERAL_LABELS.
	Settings *types.LabelDetectionSettings
	// contains filtered or unexported fields
}

type StartLabelDetectionOutput ¶

type StartLabelDetectionOutput struct {

	// The identifier for the label detection job. Use JobId to identify the job in a
	// subsequent call to GetLabelDetection .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartMediaAnalysisJobInput ¶ added in v1.32.0

type StartMediaAnalysisJobInput struct {

	// Input data to be analyzed by the job.
	//
	// This member is required.
	Input *types.MediaAnalysisInput

	// Configuration options for the media analysis job to be created.
	//
	// This member is required.
	OperationsConfig *types.MediaAnalysisOperationsConfig

	// The Amazon S3 bucket location to store the results.
	//
	// This member is required.
	OutputConfig *types.MediaAnalysisOutputConfig

	// Idempotency token used to prevent the accidental creation of duplicate
	// versions. If you use the same token with multiple StartMediaAnalysisJobRequest
	// requests, the same response is returned. Use ClientRequestToken to prevent the
	// same request from being processed more than once.
	ClientRequestToken *string

	// The name of the job. Does not have to be unique.
	JobName *string

	// The identifier of customer managed AWS KMS key (name or ARN). The key is used
	// to encrypt images copied into the service. The key is also used to encrypt
	// results and manifest files written to the output Amazon S3 bucket.
	KmsKeyId *string
	// contains filtered or unexported fields
}

type StartMediaAnalysisJobOutput ¶ added in v1.32.0

type StartMediaAnalysisJobOutput struct {

	// Identifier for the created job.
	//
	// This member is required.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartPersonTrackingInput ¶

type StartPersonTrackingInput struct {

	// The video in which you want to detect people. The video must be stored in an
	// Amazon S3 bucket.
	//
	// This member is required.
	Video *types.Video

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

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

	// The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the
	// completion status of the people detection operation to. The Amazon SNS topic
	// must have a topic name that begins with AmazonRekognition if you are using the
	// AmazonRekognitionServiceRole permissions policy.
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartPersonTrackingOutput ¶

type StartPersonTrackingOutput struct {

	// The identifier for the person detection job. Use JobId to identify the job in a
	// subsequent call to GetPersonTracking .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartProjectVersionInput ¶

type StartProjectVersionInput struct {

	// The minimum number of inference units to use. A single inference unit
	// represents 1 hour of processing.
	//
	// Use a higher number to increase the TPS throughput of your model. You are
	// charged for the number of inference units that you use.
	//
	// This member is required.
	MinInferenceUnits *int32

	// The Amazon Resource Name(ARN) of the model version that you want to start.
	//
	// This member is required.
	ProjectVersionArn *string

	// The maximum number of inference units to use for auto-scaling the model. If you
	// don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the
	// model.
	MaxInferenceUnits *int32
	// contains filtered or unexported fields
}

type StartProjectVersionOutput ¶

type StartProjectVersionOutput struct {

	// The current running status of the model.
	Status types.ProjectVersionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSegmentDetectionInput ¶

type StartSegmentDetectionInput struct {

	// An array of segment types to detect in the video. Valid values are
	// TECHNICAL_CUE and SHOT.
	//
	// This member is required.
	SegmentTypes []types.SegmentType

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	//
	// This member is required.
	Video *types.Video

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

	// Filters for technical cue or shot detection.
	Filters *types.StartSegmentDetectionFilters

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

	// The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to
	// publish the completion status of the segment detection operation. Note that the
	// Amazon SNS topic must have a topic name that begins with AmazonRekognition if
	// you are using the AmazonRekognitionServiceRole permissions policy to access the
	// topic.
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartSegmentDetectionOutput ¶

type StartSegmentDetectionOutput struct {

	// Unique identifier for the segment detection job. The JobId is returned from
	// StartSegmentDetection .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartStreamProcessorInput ¶

type StartStreamProcessorInput struct {

	// The name of the stream processor to start processing.
	//
	// This member is required.
	Name *string

	//  Specifies the starting point in the Kinesis stream to start processing. You
	// can use the producer timestamp or the fragment number. If you use the producer
	// timestamp, you must put the time in milliseconds. For more information about
	// fragment numbers, see [Fragment].
	//
	// This is a required parameter for label detection stream processors and should
	// not be used to start a face search stream processor.
	//
	// [Fragment]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html
	StartSelector *types.StreamProcessingStartSelector

	//  Specifies when to stop processing the stream. You can specify a maximum amount
	// of time to process the video.
	//
	// This is a required parameter for label detection stream processors and should
	// not be used to start a face search stream processor.
	StopSelector *types.StreamProcessingStopSelector
	// contains filtered or unexported fields
}

type StartStreamProcessorOutput ¶

type StartStreamProcessorOutput struct {

	//  A unique identifier for the stream processing session.
	SessionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTextDetectionInput ¶

type StartTextDetectionInput struct {

	// Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
	// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported
	// file formats are .mp4, .mov and .avi.
	//
	// This member is required.
	Video *types.Video

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

	// Optional parameters that let you set criteria the text must meet to be included
	// in your response.
	Filters *types.StartTextDetectionFilters

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

	// The Amazon Simple Notification Service topic to which Amazon Rekognition
	// publishes the completion status of a video analysis operation. For more
	// information, see [Calling Amazon Rekognition Video operations]. Note that the Amazon SNS topic must have a topic name that
	// begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole
	// permissions policy to access the topic. For more information, see [Giving access to multiple Amazon SNS topics].
	//
	// [Calling Amazon Rekognition Video operations]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html
	// [Giving access to multiple Amazon SNS topics]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics
	NotificationChannel *types.NotificationChannel
	// contains filtered or unexported fields
}

type StartTextDetectionOutput ¶

type StartTextDetectionOutput struct {

	// Identifier for the text detection job. Use JobId to identify the job in a
	// subsequent call to GetTextDetection .
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopProjectVersionInput ¶

type StopProjectVersionInput struct {

	// The Amazon Resource Name (ARN) of the model version that you want to stop.
	//
	// This operation requires permissions to perform the
	// rekognition:StopProjectVersion action.
	//
	// This member is required.
	ProjectVersionArn *string
	// contains filtered or unexported fields
}

type StopProjectVersionOutput ¶

type StopProjectVersionOutput struct {

	// The current status of the stop operation.
	Status types.ProjectVersionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopStreamProcessorInput ¶

type StopStreamProcessorInput struct {

	// The name of a stream processor created by CreateStreamProcessor.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type StopStreamProcessorOutput ¶

type StopStreamProcessorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput ¶ added in v1.3.0

type TagResourceInput struct {

	//  Amazon Resource Name (ARN) of the model, collection, or stream processor that
	// you want to assign the tags to.
	//
	// This member is required.
	ResourceArn *string

	//  The key-value tags to assign to the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput ¶ added in v1.3.0

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput ¶ added in v1.3.0

type UntagResourceInput struct {

	//  Amazon Resource Name (ARN) of the model, collection, or stream processor that
	// you want to remove the tags from.
	//
	// This member is required.
	ResourceArn *string

	//  A list of the tags that you want to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput ¶ added in v1.3.0

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDatasetEntriesInput ¶ added in v1.10.0

type UpdateDatasetEntriesInput struct {

	//  The changes that you want to make to the dataset.
	//
	// This member is required.
	Changes *types.DatasetChanges

	//  The Amazon Resource Name (ARN) of the dataset that you want to update.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type UpdateDatasetEntriesOutput ¶ added in v1.10.0

type UpdateDatasetEntriesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateStreamProcessorInput ¶ added in v1.18.0

type UpdateStreamProcessorInput struct {

	//  Name of the stream processor that you want to update.
	//
	// This member is required.
	Name *string

	//  Shows whether you are sharing data with Rekognition to improve model
	// performance. You can choose this option at the account level or on a per-stream
	// basis. Note that if you opt out at the account level this setting is ignored on
	// individual streams.
	DataSharingPreferenceForUpdate *types.StreamProcessorDataSharingPreference

	//  A list of parameters you want to delete from the stream processor.
	ParametersToDelete []types.StreamProcessorParameterToDelete

	//  Specifies locations in the frames where Amazon Rekognition checks for objects
	// or people. This is an optional parameter for label detection stream processors.
	RegionsOfInterestForUpdate []types.RegionOfInterest

	//  The stream processor settings that you want to update. Label detection
	// settings can be updated to detect different labels with a different minimum
	// confidence.
	SettingsForUpdate *types.StreamProcessorSettingsForUpdate
	// contains filtered or unexported fields
}

type UpdateStreamProcessorOutput ¶ added in v1.18.0

type UpdateStreamProcessorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
endpoints
types

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Overview ¶

Amazon Rekognition Image ¶

Amazon Rekognition Custom Labels ¶

Amazon Rekognition Video Stored Video ¶

Amazon Rekognition Video Streaming Video ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func NewDefaultEndpointResolver ¶

func WithAPIOptions ¶ added in v1.0.0

func WithEndpointResolver deprecated

func WithEndpointResolverV2 ¶ added in v1.30.0

func WithSigV4SigningName ¶ added in v1.34.2

func WithSigV4SigningRegion ¶ added in v1.34.2

Types ¶

type AssociateFacesInput ¶ added in v1.29.0

type AssociateFacesOutput ¶ added in v1.29.0

type AuthResolverParameters ¶ added in v1.34.2

type AuthSchemeResolver ¶ added in v1.34.2

type Client ¶

func New ¶

func NewFromConfig ¶

func (*Client) AssociateFaces ¶ added in v1.29.0

func (*Client) CompareFaces ¶

func (*Client) CopyProjectVersion ¶ added in v1.20.0

func (*Client) CreateCollection ¶

func (*Client) CreateDataset ¶ added in v1.10.0

func (*Client) CreateFaceLivenessSession ¶ added in v1.24.0

func (*Client) CreateProject ¶

func (*Client) CreateProjectVersion ¶

func (*Client) CreateStreamProcessor ¶

func (*Client) CreateUser ¶ added in v1.29.0

func (*Client) DeleteCollection ¶

func (*Client) DeleteDataset ¶ added in v1.10.0

func (*Client) DeleteFaces ¶

func (*Client) DeleteProject ¶

func (*Client) DeleteProjectPolicy ¶ added in v1.20.0

func (*Client) DeleteProjectVersion ¶

func (*Client) DeleteStreamProcessor ¶

func (*Client) DeleteUser ¶ added in v1.29.0

func (*Client) DescribeCollection ¶

func (*Client) DescribeDataset ¶ added in v1.10.0

func (*Client) DescribeProjectVersions ¶

func (*Client) DescribeProjects ¶

func (*Client) DescribeStreamProcessor ¶

func (*Client) DetectCustomLabels ¶

func (*Client) DetectFaces ¶

func (*Client) DetectLabels ¶

Optional Parameters ¶

Response Elements ¶

func (*Client) DetectModerationLabels ¶

func (*Client) DetectProtectiveEquipment ¶ added in v0.29.0

func (*Client) DetectText ¶

func (*Client) DisassociateFaces ¶ added in v1.29.0

func (*Client) DistributeDatasetEntries ¶ added in v1.10.0

func (*Client) GetCelebrityInfo ¶

func (*Client) GetCelebrityRecognition ¶

func (*Client) GetContentModeration ¶

func (*Client) GetFaceDetection ¶

func (*Client) GetFaceLivenessSessionResults ¶ added in v1.24.0

func (*Client) GetFaceSearch ¶

func (*Client) GetLabelDetection ¶

func (*Client) GetMediaAnalysisJob ¶ added in v1.32.0

func (*Client) GetPersonTracking ¶

func (*Client) GetSegmentDetection ¶

func (*Client) GetTextDetection ¶

func (*Client) IndexFaces ¶

func (*Client) ListCollections ¶

func (*Client) ListDatasetEntries ¶ added in v1.10.0

func (*Client) ListDatasetLabels ¶ added in v1.10.0

func (*Client) ListFaces ¶

func (*Client) ListMediaAnalysisJobs ¶ added in v1.32.0

func (*Client) ListProjectPolicies ¶ added in v1.20.0

func (*Client) ListStreamProcessors ¶

func (*Client) ListTagsForResource ¶ added in v1.3.0

func (*Client) ListUsers ¶ added in v1.29.0

func (*Client) Options ¶ added in v1.35.0

func (*Client) PutProjectPolicy ¶ added in v1.20.0