com.amazonaws.services.rekognition

Interface AmazonRekognition

All Known Subinterfaces:

AmazonRekognitionAsync

All Known Implementing Classes:

AbstractAmazonRekognition, AbstractAmazonRekognitionAsync, AmazonRekognitionAsyncClient, AmazonRekognitionClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonRekognition

Interface for accessing Amazon Rekognition.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonRekognition instead.

This is the Amazon Rekognition API reference.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CompareFacesResult	compareFaces(CompareFacesRequest compareFacesRequest) Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
CreateCollectionResult	createCollection(CreateCollectionRequest createCollectionRequest) Creates a collection in an AWS Region.
CreateProjectResult	createProject(CreateProjectRequest createProjectRequest) Creates a new Amazon Rekognition Custom Labels project.
CreateProjectVersionResult	createProjectVersion(CreateProjectVersionRequest createProjectVersionRequest) Creates a new version of a model and begins training.
CreateStreamProcessorResult	createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest) Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
DeleteCollectionResult	deleteCollection(DeleteCollectionRequest deleteCollectionRequest) Deletes the specified collection.
DeleteFacesResult	deleteFaces(DeleteFacesRequest deleteFacesRequest) Deletes faces from a collection.
DeleteProjectResult	deleteProject(DeleteProjectRequest deleteProjectRequest) Deletes an Amazon Rekognition Custom Labels project.
DeleteProjectVersionResult	deleteProjectVersion(DeleteProjectVersionRequest deleteProjectVersionRequest) Deletes an Amazon Rekognition Custom Labels model.
DeleteStreamProcessorResult	deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest) Deletes the stream processor identified by Name.
DescribeCollectionResult	describeCollection(DescribeCollectionRequest describeCollectionRequest) Describes the specified collection.
DescribeProjectsResult	describeProjects(DescribeProjectsRequest describeProjectsRequest) Lists and gets information about your Amazon Rekognition Custom Labels projects.
DescribeProjectVersionsResult	describeProjectVersions(DescribeProjectVersionsRequest describeProjectVersionsRequest) Lists and describes the models in an Amazon Rekognition Custom Labels project.
DescribeStreamProcessorResult	describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest) Provides information about a stream processor created by CreateStreamProcessor.
DetectCustomLabelsResult	detectCustomLabels(DetectCustomLabelsRequest detectCustomLabelsRequest) Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
DetectFacesResult	detectFaces(DetectFacesRequest detectFacesRequest) Detects faces within an image that is provided as input.
DetectLabelsResult	detectLabels(DetectLabelsRequest detectLabelsRequest) Detects instances of real-world entities within an image (JPEG or PNG) provided as input.
DetectModerationLabelsResult	detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest) Detects unsafe content in a specified JPEG or PNG format image.
DetectProtectiveEquipmentResult	detectProtectiveEquipment(DetectProtectiveEquipmentRequest detectProtectiveEquipmentRequest) Detects Personal Protective Equipment (PPE) worn by people detected in an image.
DetectTextResult	detectText(DetectTextRequest detectTextRequest) Detects text in the input image and converts it into machine-readable text.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCelebrityInfoResult	getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest) Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID.
GetCelebrityRecognitionResult	getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest) Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.
GetContentModerationResult	getContentModeration(GetContentModerationRequest getContentModerationRequest) Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.
GetFaceDetectionResult	getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest) Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
GetFaceSearchResult	getFaceSearch(GetFaceSearchRequest getFaceSearchRequest) Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch.
GetLabelDetectionResult	getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest) Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
GetPersonTrackingResult	getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest) Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
GetSegmentDetectionResult	getSegmentDetection(GetSegmentDetectionRequest getSegmentDetectionRequest) Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
GetTextDetectionResult	getTextDetection(GetTextDetectionRequest getTextDetectionRequest) Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
IndexFacesResult	indexFaces(IndexFacesRequest indexFacesRequest) Detects faces in the input image and adds them to the specified collection.
ListCollectionsResult	listCollections(ListCollectionsRequest listCollectionsRequest) Returns list of collection IDs in your account.
ListFacesResult	listFaces(ListFacesRequest listFacesRequest) Returns metadata for faces in the specified collection.
ListStreamProcessorsResult	listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest) Gets a list of stream processors that you have created with CreateStreamProcessor.
RecognizeCelebritiesResult	recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest) Returns an array of celebrities recognized in the input image.
SearchFacesResult	searchFaces(SearchFacesRequest searchFacesRequest) For a given input face ID, searches for matching faces in the collection the face belongs to.
SearchFacesByImageResult	searchFacesByImage(SearchFacesByImageRequest searchFacesByImageRequest) For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCelebrityRecognitionResult	startCelebrityRecognition(StartCelebrityRecognitionRequest startCelebrityRecognitionRequest) Starts asynchronous recognition of celebrities in a stored video.
StartContentModerationResult	startContentModeration(StartContentModerationRequest startContentModerationRequest) Starts asynchronous detection of unsafe content in a stored video.
StartFaceDetectionResult	startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest) Starts asynchronous detection of faces in a stored video.
StartFaceSearchResult	startFaceSearch(StartFaceSearchRequest startFaceSearchRequest) Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
StartLabelDetectionResult	startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest) Starts asynchronous detection of labels in a stored video.
StartPersonTrackingResult	startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest) Starts the asynchronous tracking of a person's path in a stored video.
StartProjectVersionResult	startProjectVersion(StartProjectVersionRequest startProjectVersionRequest) Starts the running of the version of a model.
StartSegmentDetectionResult	startSegmentDetection(StartSegmentDetectionRequest startSegmentDetectionRequest) Starts asynchronous detection of segment detection in a stored video.
StartStreamProcessorResult	startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest) Starts processing a stream processor.
StartTextDetectionResult	startTextDetection(StartTextDetectionRequest startTextDetectionRequest) Starts asynchronous detection of text in a stored video.
StopProjectVersionResult	stopProjectVersion(StopProjectVersionRequest stopProjectVersionRequest) Stops a running model.
StopStreamProcessorResult	stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest) Stops a running stream processor that was created by CreateStreamProcessor.
AmazonRekognitionWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("rekognition.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "rekognition.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "rekognition.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "rekognition.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "rekognition.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

compareFaces

CompareFacesResult compareFaces(CompareFacesRequest compareFacesRequest)

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

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

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

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

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

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

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

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.

Parameters:

compareFacesRequest -

Returns:

Result of the CompareFaces operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

Samples:

• To compare two images

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

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  CompareFacesRequest request = new CompareFacesRequest()
          .withSourceImage(new Image().withS3Object(new S3Object().withBucket("mybucket").withName("mysourceimage")))
          .withTargetImage(new Image().withS3Object(new S3Object().withBucket("mybucket").withName("mytargetimage"))).withSimilarityThreshold(90f);
  CompareFacesResult response = client.compareFaces(request);

createCollection

CreateCollectionResult createCollection(CreateCollectionRequest createCollectionRequest)

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

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

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

Collection names are case-sensitive.

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

Parameters:

createCollectionRequest -

Returns:

Result of the CreateCollection operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceAlreadyExistsException - A collection with the specified ID already exists.

Samples:

• To create a collection

  This operation creates a Rekognition collection for storing image data.
  

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  CreateCollectionRequest request = new CreateCollectionRequest().withCollectionId("myphotos");
  CreateCollectionResult response = client.createCollection(request);

createProject

CreateProjectResult createProject(CreateProjectRequest createProjectRequest)

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

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

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

Throws:

ResourceInUseException - The specified resource is already being used.

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

createProjectVersion

CreateProjectVersionResult createProjectVersion(CreateProjectVersionRequest createProjectVersionRequest)

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

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

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

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

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

Parameters:

createProjectVersionRequest -

Returns:

Result of the CreateProjectVersion operation returned by the service.

Throws:

ResourceInUseException - The specified resource is already being used.

ResourceNotFoundException - The collection specified in the request cannot be found.

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

createStreamProcessor

CreateStreamProcessorResult createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest)

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

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

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

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

Parameters:

createStreamProcessorRequest -

Returns:

Result of the CreateStreamProcessor operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

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

ResourceInUseException - The specified resource is already being used.

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

deleteCollection

DeleteCollectionResult deleteCollection(DeleteCollectionRequest deleteCollectionRequest)

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

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

Parameters:

deleteCollectionRequest -

Returns:

Result of the DeleteCollection operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

Samples:

• To delete a collection

  This operation deletes a Rekognition collection.
  

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  DeleteCollectionRequest request = new DeleteCollectionRequest().withCollectionId("myphotos");
  DeleteCollectionResult response = client.deleteCollection(request);

deleteFaces

DeleteFacesResult deleteFaces(DeleteFacesRequest deleteFacesRequest)

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.

Parameters:

deleteFacesRequest -

Returns:

Result of the DeleteFaces operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

Samples:

• To delete a face

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

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  DeleteFacesRequest request = new DeleteFacesRequest().withCollectionId("myphotos").withFaceIds("ff43d742-0c13-5d16-a3e8-03d3f58e980b");
  DeleteFacesResult response = client.deleteFaces(request);

deleteProject

DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)

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

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

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

ResourceInUseException - The specified resource is already being used.

ResourceNotFoundException - The collection specified in the request cannot be found.

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

deleteProjectVersion

DeleteProjectVersionResult deleteProjectVersion(DeleteProjectVersionRequest deleteProjectVersionRequest)

Deletes an Amazon Rekognition Custom Labels model.

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

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

Parameters:

deleteProjectVersionRequest -

Returns:

Result of the DeleteProjectVersion operation returned by the service.

Throws:

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceInUseException - The specified resource is already being used.

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

deleteStreamProcessor

DeleteStreamProcessorResult deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest)

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.

Parameters:

deleteStreamProcessorRequest -

Returns:

Result of the DeleteStreamProcessor operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceInUseException - The specified resource is already being used.

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

describeCollection

DescribeCollectionResult describeCollection(DescribeCollectionRequest describeCollectionRequest)

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.

Parameters:

describeCollectionRequest -

Returns:

Result of the DescribeCollection operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

describeProjectVersions

DescribeProjectVersionsResult describeProjectVersions(DescribeProjectVersionsRequest describeProjectVersionsRequest)

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

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

Parameters:

describeProjectVersionsRequest -

Returns:

Result of the DescribeProjectVersions operation returned by the service.

Throws:

ResourceNotFoundException - The collection specified in the request cannot be found.

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

describeProjects

DescribeProjectsResult describeProjects(DescribeProjectsRequest describeProjectsRequest)

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

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

Parameters:

describeProjectsRequest -

Returns:

Result of the DescribeProjects operation returned by the service.

Throws:

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

describeStreamProcessor

DescribeStreamProcessorResult describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest)

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.

Parameters:

describeStreamProcessorRequest -

Returns:

Result of the DescribeStreamProcessor operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

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

detectCustomLabels

DetectCustomLabelsResult detectCustomLabels(DetectCustomLabelsRequest detectCustomLabelsRequest)

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

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

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

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

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

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

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

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

Parameters:

detectCustomLabelsRequest -

Returns:

Result of the DetectCustomLabels operation returned by the service.

Throws:

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceNotReadyException - The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

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

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

detectFaces

DetectFacesResult detectFaces(DetectFacesRequest detectFacesRequest)

Detects faces within an image that is provided as input.

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

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

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

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

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

Parameters:

detectFacesRequest -

Returns:

Result of the DetectFaces operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

Samples:

• To detect faces in an image

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

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  DetectFacesRequest request = new DetectFacesRequest().withImage(new Image().withS3Object(new S3Object().withBucket("mybucket").withName("myphoto")));
  DetectFacesResult response = client.detectFaces(request);

detectLabels

DetectLabelsResult detectLabels(DetectLabelsRequest detectLabelsRequest)

Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.

For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

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

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned.

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

DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

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

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

Parameters:

detectLabelsRequest -

Returns:

Result of the DetectLabels operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

Samples:

• To detect labels

  This operation detects labels in the supplied image
  

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  DetectLabelsRequest request = new DetectLabelsRequest().withImage(new Image().withS3Object(new S3Object().withBucket("mybucket").withName("myphoto")))
          .withMaxLabels(123).withMinConfidence(70f);
  DetectLabelsResult response = client.detectLabels(request);

detectModerationLabels

DetectModerationLabelsResult detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest)

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.

Parameters:

detectModerationLabelsRequest -

Returns:

Result of the DetectModerationLabels operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

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

detectProtectiveEquipment

DetectProtectiveEquipmentResult detectProtectiveEquipment(DetectProtectiveEquipmentRequest detectProtectiveEquipmentRequest)

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.

Parameters:

detectProtectiveEquipmentRequest -

Returns:

Result of the DetectProtectiveEquipment operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

detectText

DetectTextResult detectText(DetectTextRequest detectTextRequest)

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

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

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

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

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

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

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

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

Parameters:

detectTextRequest -

Returns:

Result of the DetectText operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

getCelebrityInfo

GetCelebrityInfoResult getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest)

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

For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

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

Parameters:

getCelebrityInfoRequest -

Returns:

Result of the GetCelebrityInfo operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

getCelebrityRecognition

GetCelebrityRecognitionResult getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier ( JobId) from the initial call to StartCelebrityDetection.

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array ( Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected.

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

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

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

No information is returned for faces not recognized as celebrities.

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

Parameters:

getCelebrityRecognitionRequest -

Returns:

Result of the GetCelebrityRecognition operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getContentModeration

GetContentModerationResult getContentModeration(GetContentModerationRequest getContentModerationRequest)

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

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

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

GetContentModeration returns detected unsafe content labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.

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

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

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

Parameters:

getContentModerationRequest -

Returns:

Result of the GetContentModeration operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getFaceDetection

GetFaceDetectionResult getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest)

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

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

GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

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

Parameters:

getFaceDetectionRequest -

Returns:

Result of the GetFaceDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getFaceSearch

GetFaceSearchResult getFaceSearch(GetFaceSearchRequest getFaceSearchRequest)

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier ( JobId) from the initial call to StartFaceSearch.

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

The search results are retured in an array, Persons, of PersonMatch objects. 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.

Parameters:

getFaceSearchRequest -

Returns:

Result of the GetFaceSearch operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getLabelDetection

GetLabelDetectionResult getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest)

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

The label detection operation is started by a call to StartLabelDetection which returns a job identifier ( JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter.

The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.

The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.

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

Parameters:

getLabelDetectionRequest -

Returns:

Result of the GetLabelDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getPersonTracking

GetPersonTrackingResult getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest)

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.

Parameters:

getPersonTrackingRequest -

Returns:

Result of the GetPersonTracking operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getSegmentDetection

GetSegmentDetectionResult getSegmentDetection(GetSegmentDetectionRequest getSegmentDetectionRequest)

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

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

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

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

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

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

Parameters:

getSegmentDetectionRequest -

Returns:

Result of the GetSegmentDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

getTextDetection

GetTextDetectionResult getTextDetection(GetTextDetectionRequest getTextDetectionRequest)

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

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

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

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

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

Parameters:

getTextDetectionRequest -

Returns:

Result of the GetTextDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

indexFaces

IndexFacesResult indexFaces(IndexFacesRequest indexFacesRequest)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• The face is too blurry.

• The image is too dark.

• The face has an extreme pose.

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

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

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

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

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

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

If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

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

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

Parameters:

indexFacesRequest -

Returns:

Result of the IndexFaces operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

InvalidImageFormatException - The provided image format is not supported.

ServiceQuotaExceededException -

The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

Samples:

• To add a face to a collection

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

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  IndexFacesRequest request = new IndexFacesRequest().withCollectionId("myphotos")
          .withImage(new Image().withS3Object(new S3Object().withBucket("mybucket").withName("myphoto"))).withExternalImageId("myphotoid")
          .withDetectionAttributes(new ArrayList());
  IndexFacesResult response = client.indexFaces(request);

listCollections

ListCollectionsResult listCollections(ListCollectionsRequest listCollectionsRequest)

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.

Parameters:

listCollectionsRequest -

Returns:

Result of the ListCollections operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

ResourceNotFoundException - The collection specified in the request cannot be found.

Samples:

• To list the collections

  This operation returns a list of Rekognition collections.
  

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  ListCollectionsRequest request = new ListCollectionsRequest();
  ListCollectionsResult response = client.listCollections(request);

listFaces

ListFacesResult listFaces(ListFacesRequest listFacesRequest)

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.

Parameters:

listFacesRequest -

Returns:

Result of the ListFaces operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

ResourceNotFoundException - The collection specified in the request cannot be found.

Samples:

• To list the faces in a collection

  This operation lists the faces in a Rekognition collection.
  

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  ListFacesRequest request = new ListFacesRequest().withCollectionId("myphotos").withMaxResults(20);
  ListFacesResult response = client.listFaces(request);

listStreamProcessors

ListStreamProcessorsResult listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest)

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

Parameters:

listStreamProcessorsRequest -

Returns:

Result of the ListStreamProcessors operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidPaginationTokenException - Pagination token in the request is not valid.

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

recognizeCelebrities

RecognizeCelebritiesResult recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest)

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

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

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

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

For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

Parameters:

recognizeCelebritiesRequest -

Returns:

Result of the RecognizeCelebrities operation returned by the service.

Throws:

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

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

InvalidImageFormatException - The provided image format is not supported.

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

InvalidImageFormatException - The provided image format is not supported.

searchFaces

SearchFacesResult searchFaces(SearchFacesRequest searchFacesRequest)

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

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

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

Parameters:

searchFacesRequest -

Returns:

Result of the SearchFaces operation returned by the service.

Throws:

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

Samples:

• To delete a face

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

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  SearchFacesRequest request = new SearchFacesRequest().withCollectionId("myphotos").withFaceId("70008e50-75e4-55d0-8e80-363fb73b3a14").withMaxFaces(10)
          .withFaceMatchThreshold(90f);
  SearchFacesResult response = client.searchFaces(request);

searchFacesByImage

SearchFacesByImageResult searchFacesByImage(SearchFacesByImageRequest searchFacesByImageRequest)

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.

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

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

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

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

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

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

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

Parameters:

searchFacesByImageRequest -

Returns:

Result of the SearchFacesByImage operation returned by the service.

Throws:

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

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

InvalidImageFormatException - The provided image format is not supported.

Samples:

• To search for faces matching a supplied image

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

  AmazonRekognition client = AmazonRekognitionClientBuilder.standard().build();
  SearchFacesByImageRequest request = new SearchFacesByImageRequest().withCollectionId("myphotos")
          .withImage(new Image().withS3Object(new S3Object().withBucket("mybucket").withName("myphoto"))).withMaxFaces(5).withFaceMatchThreshold(95f);
  SearchFacesByImageResult response = client.searchFacesByImage(request);

startCelebrityRecognition

StartCelebrityRecognitionResult startCelebrityRecognition(StartCelebrityRecognitionRequest startCelebrityRecognitionRequest)

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier ( JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

Parameters:

startCelebrityRecognitionRequest -

Returns:

Result of the StartCelebrityRecognition operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startContentModeration

StartContentModerationResult startContentModeration(StartContentModerationRequest startContentModerationRequest)

Starts asynchronous detection of unsafe content in a stored video.

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

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

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

Parameters:

startContentModerationRequest -

Returns:

Result of the StartContentModeration operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startFaceDetection

StartFaceDetectionResult startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest)

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier ( JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

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

Parameters:

startFaceDetectionRequest -

Returns:

Result of the StartFaceDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startFaceSearch

StartFaceSearchResult startFaceSearch(StartFaceSearchRequest startFaceSearchRequest)

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier ( JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

Parameters:

startFaceSearchRequest -

Returns:

Result of the StartFaceSearch operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startLabelDetection

StartLabelDetectionResult startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest)

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.

Parameters:

startLabelDetectionRequest -

Returns:

Result of the StartLabelDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startPersonTracking

StartPersonTrackingResult startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest)

Starts the asynchronous tracking of a person's path in a stored video.

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

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

Parameters:

startPersonTrackingRequest -

Returns:

Result of the StartPersonTracking operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startProjectVersion

StartProjectVersionResult startProjectVersion(StartProjectVersionRequest startProjectVersionRequest)

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.

Parameters:

startProjectVersionRequest -

Returns:

Result of the StartProjectVersion operation returned by the service.

Throws:

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceInUseException - The specified resource is already being used.

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

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

startSegmentDetection

StartSegmentDetectionResult startSegmentDetection(StartSegmentDetectionRequest startSegmentDetectionRequest)

Starts asynchronous detection of segment detection in a stored video.

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

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

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

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

Parameters:

startSegmentDetectionRequest -

Returns:

Result of the StartSegmentDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

startStreamProcessor

StartStreamProcessorResult startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest)

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.

Parameters:

startStreamProcessorRequest -

Returns:

Result of the StartStreamProcessor operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceInUseException - The specified resource is already being used.

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

startTextDetection

StartTextDetectionResult startTextDetection(StartTextDetectionRequest startTextDetectionRequest)

Starts asynchronous detection of text in a stored video.

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

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

Parameters:

startTextDetectionRequest -

Returns:

Result of the StartTextDetection operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

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

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

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

VideoTooLargeException - The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

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

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

stopProjectVersion

StopProjectVersionResult stopProjectVersion(StopProjectVersionRequest stopProjectVersionRequest)

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

Parameters:

stopProjectVersionRequest -

Returns:

Result of the StopProjectVersion operation returned by the service.

Throws:

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceInUseException - The specified resource is already being used.

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

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

stopStreamProcessor

StopStreamProcessorResult stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest)

Stops a running stream processor that was created by CreateStreamProcessor.

Parameters:

stopStreamProcessorRequest -

Returns:

Result of the StopStreamProcessor operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

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

ThrottlingException - Amazon Rekognition is temporarily unable to process the request. Try your call again.

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

ResourceNotFoundException - The collection specified in the request cannot be found.

ResourceInUseException - The specified resource is already being used.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AmazonRekognitionWaiters waiters()