Interface RekognitionClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface RekognitionClient
extends AwsClient

Service client for accessing Amazon Rekognition. This can be created using the static builder() method.

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

Amazon Rekognition Image

• AssociateFaces

• CompareFaces

• CreateCollection

• CreateUser

• DeleteCollection

• DeleteFaces

• DeleteUser

• DescribeCollection

• DetectFaces

• DetectLabels

• DetectModerationLabels

• DetectProtectiveEquipment

• DetectText

• DisassociateFaces

• GetCelebrityInfo

• IndexFaces

• ListCollections

• ListFaces

• ListUsers

• RecognizeCelebrities

• SearchFaces

• SearchFacesByImage

• SearchUsers

• SearchUsersByImage

Amazon Rekognition Bulk Image Analysis

• GetMediaAnalysisJob

• ListMediaAnalysisJob

• StartMediaAnalysisJob

Amazon Rekognition Custom Labels

• CopyProjectVersion

• CreateDataset

• CreateProject

• CreateProjectVersion

• DeleteDataset

• DeleteProject

• DeleteProjectPolicy

• DeleteProjectVersion

• DescribeDataset

• DescribeProjects

• DescribeProjectVersions

• DetectCustomLabels

• DistributeDatasetEntries

• ListDatasetEntries

• ListDatasetLabels

• ListProjectPolicies

• PutProjectPolicy

• StartProjectVersion

• StopProjectVersion

• UpdateDatasetEntries

Amazon Rekognition Stored Video

• GetCelebrityRecognition

• GetContentModeration

• GetFaceDetection

• GetFaceSearch

• GetLabelDetection

• GetPersonTracking

• GetSegmentDetection

• GetTextDetection

• StartCelebrityRecognition

• StartContentModeration

• StartFaceDetection

• StartFaceSearch

• StartLabelDetection

• StartPersonTracking

• StartSegmentDetection

• StartTextDetection

Amazon Rekognition Face Liveness

• CreateFaceLivenessSession

• GetFaceLivenessSessionResults

• StartFaceLivenessSession

Amazon Rekognition Streaming Video

• CreateStreamProcessor

• DeleteStreamProcessor

• DescribeStreamProcessor

• ListStreamProcessors

• StartStreamProcessor

• StopStreamProcessor

• UpdateStreamProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateFacesResponse	associateFaces(Consumer<AssociateFacesRequest.Builder> associateFacesRequest)	Associates one or more faces with an existing UserID.
default AssociateFacesResponse	associateFaces(AssociateFacesRequest associateFacesRequest)	Associates one or more faces with an existing UserID.
static RekognitionClientBuilder	builder()	Create a builder that can be used to configure and create a RekognitionClient.
default CompareFacesResponse	compareFaces(Consumer<CompareFacesRequest.Builder> compareFacesRequest)	Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
default CompareFacesResponse	compareFaces(CompareFacesRequest compareFacesRequest)	Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
default CopyProjectVersionResponse	copyProjectVersion(Consumer<CopyProjectVersionRequest.Builder> copyProjectVersionRequest)
default CopyProjectVersionResponse	copyProjectVersion(CopyProjectVersionRequest copyProjectVersionRequest)
static RekognitionClient	create()	Create a RekognitionClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateCollectionResponse	createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)	Creates a collection in an AWS Region.
default CreateCollectionResponse	createCollection(CreateCollectionRequest createCollectionRequest)	Creates a collection in an AWS Region.
default CreateDatasetResponse	createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
default CreateDatasetResponse	createDataset(CreateDatasetRequest createDatasetRequest)
default CreateFaceLivenessSessionResponse	createFaceLivenessSession(Consumer<CreateFaceLivenessSessionRequest.Builder> createFaceLivenessSessionRequest)	This API operation initiates a Face Liveness session.
default CreateFaceLivenessSessionResponse	createFaceLivenessSession(CreateFaceLivenessSessionRequest createFaceLivenessSessionRequest)	This API operation initiates a Face Liveness session.
default CreateProjectResponse	createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)	Creates a new Amazon Rekognition project.
default CreateProjectResponse	createProject(CreateProjectRequest createProjectRequest)	Creates a new Amazon Rekognition project.
default CreateProjectVersionResponse	createProjectVersion(Consumer<CreateProjectVersionRequest.Builder> createProjectVersionRequest)	Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training.
default CreateProjectVersionResponse	createProjectVersion(CreateProjectVersionRequest createProjectVersionRequest)	Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training.
default CreateStreamProcessorResponse	createStreamProcessor(Consumer<CreateStreamProcessorRequest.Builder> createStreamProcessorRequest)
default CreateStreamProcessorResponse	createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest)
default CreateUserResponse	createUser(Consumer<CreateUserRequest.Builder> createUserRequest)	Creates a new User within a collection specified by CollectionId.
default CreateUserResponse	createUser(CreateUserRequest createUserRequest)	Creates a new User within a collection specified by CollectionId.
default DeleteCollectionResponse	deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)	Deletes the specified collection.
default DeleteCollectionResponse	deleteCollection(DeleteCollectionRequest deleteCollectionRequest)	Deletes the specified collection.
default DeleteDatasetResponse	deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
default DeleteDatasetResponse	deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
default DeleteFacesResponse	deleteFaces(Consumer<DeleteFacesRequest.Builder> deleteFacesRequest)	Deletes faces from a collection.
default DeleteFacesResponse	deleteFaces(DeleteFacesRequest deleteFacesRequest)	Deletes faces from a collection.
default DeleteProjectResponse	deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)	Deletes a Amazon Rekognition project.
default DeleteProjectResponse	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes a Amazon Rekognition project.
default DeleteProjectPolicyResponse	deleteProjectPolicy(Consumer<DeleteProjectPolicyRequest.Builder> deleteProjectPolicyRequest)
default DeleteProjectPolicyResponse	deleteProjectPolicy(DeleteProjectPolicyRequest deleteProjectPolicyRequest)
default DeleteProjectVersionResponse	deleteProjectVersion(Consumer<DeleteProjectVersionRequest.Builder> deleteProjectVersionRequest)	Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.
default DeleteProjectVersionResponse	deleteProjectVersion(DeleteProjectVersionRequest deleteProjectVersionRequest)	Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.
default DeleteStreamProcessorResponse	deleteStreamProcessor(Consumer<DeleteStreamProcessorRequest.Builder> deleteStreamProcessorRequest)
default DeleteStreamProcessorResponse	deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest)
default DeleteUserResponse	deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)	Deletes the specified UserID within the collection.
default DeleteUserResponse	deleteUser(DeleteUserRequest deleteUserRequest)	Deletes the specified UserID within the collection.
default DescribeCollectionResponse	describeCollection(Consumer<DescribeCollectionRequest.Builder> describeCollectionRequest)	Describes the specified collection.
default DescribeCollectionResponse	describeCollection(DescribeCollectionRequest describeCollectionRequest)	Describes the specified collection.
default DescribeDatasetResponse	describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
default DescribeDatasetResponse	describeDataset(DescribeDatasetRequest describeDatasetRequest)
default DescribeProjectsResponse	describeProjects(Consumer<DescribeProjectsRequest.Builder> describeProjectsRequest)	Gets information about your Rekognition projects.
default DescribeProjectsResponse	describeProjects(DescribeProjectsRequest describeProjectsRequest)	Gets information about your Rekognition projects.
default DescribeProjectsIterable	describeProjectsPaginator(Consumer<DescribeProjectsRequest.Builder> describeProjectsRequest)	This is a variant of describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest) operation.
default DescribeProjectsIterable	describeProjectsPaginator(DescribeProjectsRequest describeProjectsRequest)	This is a variant of describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest) operation.
default DescribeProjectVersionsResponse	describeProjectVersions(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)	Lists and describes the versions of an Amazon Rekognition project.
default DescribeProjectVersionsResponse	describeProjectVersions(DescribeProjectVersionsRequest describeProjectVersionsRequest)	Lists and describes the versions of an Amazon Rekognition project.
default DescribeProjectVersionsIterable	describeProjectVersionsPaginator(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)	This is a variant of describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) operation.
default DescribeProjectVersionsIterable	describeProjectVersionsPaginator(DescribeProjectVersionsRequest describeProjectVersionsRequest)	This is a variant of describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) operation.
default DescribeStreamProcessorResponse	describeStreamProcessor(Consumer<DescribeStreamProcessorRequest.Builder> describeStreamProcessorRequest)
default DescribeStreamProcessorResponse	describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest)
default DetectCustomLabelsResponse	detectCustomLabels(Consumer<DetectCustomLabelsRequest.Builder> detectCustomLabelsRequest)
default DetectCustomLabelsResponse	detectCustomLabels(DetectCustomLabelsRequest detectCustomLabelsRequest)
default DetectFacesResponse	detectFaces(Consumer<DetectFacesRequest.Builder> detectFacesRequest)	Detects faces within an image that is provided as input.
default DetectFacesResponse	detectFaces(DetectFacesRequest detectFacesRequest)	Detects faces within an image that is provided as input.
default DetectLabelsResponse	detectLabels(Consumer<DetectLabelsRequest.Builder> detectLabelsRequest)	Detects instances of real-world entities within an image (JPEG or PNG) provided as input.
default DetectLabelsResponse	detectLabels(DetectLabelsRequest detectLabelsRequest)	Detects instances of real-world entities within an image (JPEG or PNG) provided as input.
default DetectModerationLabelsResponse	detectModerationLabels(Consumer<DetectModerationLabelsRequest.Builder> detectModerationLabelsRequest)	Detects unsafe content in a specified JPEG or PNG format image.
default DetectModerationLabelsResponse	detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest)	Detects unsafe content in a specified JPEG or PNG format image.
default DetectProtectiveEquipmentResponse	detectProtectiveEquipment(Consumer<DetectProtectiveEquipmentRequest.Builder> detectProtectiveEquipmentRequest)	Detects Personal Protective Equipment (PPE) worn by people detected in an image.
default DetectProtectiveEquipmentResponse	detectProtectiveEquipment(DetectProtectiveEquipmentRequest detectProtectiveEquipmentRequest)	Detects Personal Protective Equipment (PPE) worn by people detected in an image.
default DetectTextResponse	detectText(Consumer<DetectTextRequest.Builder> detectTextRequest)	Detects text in the input image and converts it into machine-readable text.
default DetectTextResponse	detectText(DetectTextRequest detectTextRequest)	Detects text in the input image and converts it into machine-readable text.
default DisassociateFacesResponse	disassociateFaces(Consumer<DisassociateFacesRequest.Builder> disassociateFacesRequest)	Removes the association between a Face supplied in an array of FaceIds and the User.
default DisassociateFacesResponse	disassociateFaces(DisassociateFacesRequest disassociateFacesRequest)	Removes the association between a Face supplied in an array of FaceIds and the User.
default DistributeDatasetEntriesResponse	distributeDatasetEntries(Consumer<DistributeDatasetEntriesRequest.Builder> distributeDatasetEntriesRequest)
default DistributeDatasetEntriesResponse	distributeDatasetEntries(DistributeDatasetEntriesRequest distributeDatasetEntriesRequest)
default GetCelebrityInfoResponse	getCelebrityInfo(Consumer<GetCelebrityInfoRequest.Builder> getCelebrityInfoRequest)	Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
default GetCelebrityInfoResponse	getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest)	Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
default GetCelebrityRecognitionResponse	getCelebrityRecognition(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest)	Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.
default GetCelebrityRecognitionResponse	getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)	Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.
default GetCelebrityRecognitionIterable	getCelebrityRecognitionPaginator(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest)	This is a variant of getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest) operation.
default GetCelebrityRecognitionIterable	getCelebrityRecognitionPaginator(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)	This is a variant of getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest) operation.
default GetContentModerationResponse	getContentModeration(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest)	Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.
default GetContentModerationResponse	getContentModeration(GetContentModerationRequest getContentModerationRequest)	Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.
default GetContentModerationIterable	getContentModerationPaginator(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest)	This is a variant of getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest) operation.
default GetContentModerationIterable	getContentModerationPaginator(GetContentModerationRequest getContentModerationRequest)	This is a variant of getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest) operation.
default GetFaceDetectionResponse	getFaceDetection(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest)	Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
default GetFaceDetectionResponse	getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest)	Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
default GetFaceDetectionIterable	getFaceDetectionPaginator(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest)	This is a variant of getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest) operation.
default GetFaceDetectionIterable	getFaceDetectionPaginator(GetFaceDetectionRequest getFaceDetectionRequest)	This is a variant of getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest) operation.
default GetFaceLivenessSessionResultsResponse	getFaceLivenessSessionResults(Consumer<GetFaceLivenessSessionResultsRequest.Builder> getFaceLivenessSessionResultsRequest)	Retrieves the results of a specific Face Liveness session.
default GetFaceLivenessSessionResultsResponse	getFaceLivenessSessionResults(GetFaceLivenessSessionResultsRequest getFaceLivenessSessionResultsRequest)	Retrieves the results of a specific Face Liveness session.
default GetFaceSearchResponse	getFaceSearch(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest)	Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch.
default GetFaceSearchResponse	getFaceSearch(GetFaceSearchRequest getFaceSearchRequest)	Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch.
default GetFaceSearchIterable	getFaceSearchPaginator(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest)	This is a variant of getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest) operation.
default GetFaceSearchIterable	getFaceSearchPaginator(GetFaceSearchRequest getFaceSearchRequest)	This is a variant of getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest) operation.
default GetLabelDetectionResponse	getLabelDetection(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest)	Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
default GetLabelDetectionResponse	getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest)	Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
default GetLabelDetectionIterable	getLabelDetectionPaginator(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest)	This is a variant of getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest) operation.
default GetLabelDetectionIterable	getLabelDetectionPaginator(GetLabelDetectionRequest getLabelDetectionRequest)	This is a variant of getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest) operation.
default GetMediaAnalysisJobResponse	getMediaAnalysisJob(Consumer<GetMediaAnalysisJobRequest.Builder> getMediaAnalysisJobRequest)
default GetMediaAnalysisJobResponse	getMediaAnalysisJob(GetMediaAnalysisJobRequest getMediaAnalysisJobRequest)
default GetPersonTrackingResponse	getPersonTracking(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest)
default GetPersonTrackingResponse	getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest)
default GetPersonTrackingIterable	getPersonTrackingPaginator(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest)	This is a variant of getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest) operation.
default GetPersonTrackingIterable	getPersonTrackingPaginator(GetPersonTrackingRequest getPersonTrackingRequest)	This is a variant of getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest) operation.
default GetSegmentDetectionResponse	getSegmentDetection(Consumer<GetSegmentDetectionRequest.Builder> getSegmentDetectionRequest)	Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
default GetSegmentDetectionResponse	getSegmentDetection(GetSegmentDetectionRequest getSegmentDetectionRequest)	Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
default GetSegmentDetectionIterable	getSegmentDetectionPaginator(Consumer<GetSegmentDetectionRequest.Builder> getSegmentDetectionRequest)	This is a variant of getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest) operation.
default GetSegmentDetectionIterable	getSegmentDetectionPaginator(GetSegmentDetectionRequest getSegmentDetectionRequest)	This is a variant of getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest) operation.
default GetTextDetectionResponse	getTextDetection(Consumer<GetTextDetectionRequest.Builder> getTextDetectionRequest)	Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
default GetTextDetectionResponse	getTextDetection(GetTextDetectionRequest getTextDetectionRequest)	Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
default GetTextDetectionIterable	getTextDetectionPaginator(Consumer<GetTextDetectionRequest.Builder> getTextDetectionRequest)	This is a variant of getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest) operation.
default GetTextDetectionIterable	getTextDetectionPaginator(GetTextDetectionRequest getTextDetectionRequest)	This is a variant of getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest) operation.
default IndexFacesResponse	indexFaces(Consumer<IndexFacesRequest.Builder> indexFacesRequest)	Detects faces in the input image and adds them to the specified collection.
default IndexFacesResponse	indexFaces(IndexFacesRequest indexFacesRequest)	Detects faces in the input image and adds them to the specified collection.
default ListCollectionsResponse	listCollections()	Returns list of collection IDs in your account.
default ListCollectionsResponse	listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)	Returns list of collection IDs in your account.
default ListCollectionsResponse	listCollections(ListCollectionsRequest listCollectionsRequest)	Returns list of collection IDs in your account.
default ListCollectionsIterable	listCollectionsPaginator()	This is a variant of listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation.
default ListCollectionsIterable	listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)	This is a variant of listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation.
default ListCollectionsIterable	listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)	This is a variant of listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation.
default ListDatasetEntriesResponse	listDatasetEntries(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)
default ListDatasetEntriesResponse	listDatasetEntries(ListDatasetEntriesRequest listDatasetEntriesRequest)
default ListDatasetEntriesIterable	listDatasetEntriesPaginator(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)	This is a variant of listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest) operation.
default ListDatasetEntriesIterable	listDatasetEntriesPaginator(ListDatasetEntriesRequest listDatasetEntriesRequest)	This is a variant of listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest) operation.
default ListDatasetLabelsResponse	listDatasetLabels(Consumer<ListDatasetLabelsRequest.Builder> listDatasetLabelsRequest)
default ListDatasetLabelsResponse	listDatasetLabels(ListDatasetLabelsRequest listDatasetLabelsRequest)
default ListDatasetLabelsIterable	listDatasetLabelsPaginator(Consumer<ListDatasetLabelsRequest.Builder> listDatasetLabelsRequest)	This is a variant of listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest) operation.
default ListDatasetLabelsIterable	listDatasetLabelsPaginator(ListDatasetLabelsRequest listDatasetLabelsRequest)	This is a variant of listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest) operation.
default ListFacesResponse	listFaces(Consumer<ListFacesRequest.Builder> listFacesRequest)	Returns metadata for faces in the specified collection.
default ListFacesResponse	listFaces(ListFacesRequest listFacesRequest)	Returns metadata for faces in the specified collection.
default ListFacesIterable	listFacesPaginator(Consumer<ListFacesRequest.Builder> listFacesRequest)	This is a variant of listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest) operation.
default ListFacesIterable	listFacesPaginator(ListFacesRequest listFacesRequest)	This is a variant of listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest) operation.
default ListMediaAnalysisJobsResponse	listMediaAnalysisJobs(Consumer<ListMediaAnalysisJobsRequest.Builder> listMediaAnalysisJobsRequest)
default ListMediaAnalysisJobsResponse	listMediaAnalysisJobs(ListMediaAnalysisJobsRequest listMediaAnalysisJobsRequest)
default ListMediaAnalysisJobsIterable	listMediaAnalysisJobsPaginator(Consumer<ListMediaAnalysisJobsRequest.Builder> listMediaAnalysisJobsRequest)	This is a variant of listMediaAnalysisJobs(software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsRequest) operation.
default ListMediaAnalysisJobsIterable	listMediaAnalysisJobsPaginator(ListMediaAnalysisJobsRequest listMediaAnalysisJobsRequest)	This is a variant of listMediaAnalysisJobs(software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsRequest) operation.
default ListProjectPoliciesResponse	listProjectPolicies(Consumer<ListProjectPoliciesRequest.Builder> listProjectPoliciesRequest)
default ListProjectPoliciesResponse	listProjectPolicies(ListProjectPoliciesRequest listProjectPoliciesRequest)
default ListProjectPoliciesIterable	listProjectPoliciesPaginator(Consumer<ListProjectPoliciesRequest.Builder> listProjectPoliciesRequest)	This is a variant of listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest) operation.
default ListProjectPoliciesIterable	listProjectPoliciesPaginator(ListProjectPoliciesRequest listProjectPoliciesRequest)	This is a variant of listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest) operation.
default ListStreamProcessorsResponse	listStreamProcessors()
default ListStreamProcessorsResponse	listStreamProcessors(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest)
default ListStreamProcessorsResponse	listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest)
default ListStreamProcessorsIterable	listStreamProcessorsPaginator()	This is a variant of listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation.
default ListStreamProcessorsIterable	listStreamProcessorsPaginator(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest)	This is a variant of listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation.
default ListStreamProcessorsIterable	listStreamProcessorsPaginator(ListStreamProcessorsRequest listStreamProcessorsRequest)	This is a variant of listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)	Returns metadata of the User such as UserID in the specified collection.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest)	Returns metadata of the User such as UserID in the specified collection.
default ListUsersIterable	listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)	This is a variant of listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest) operation.
default ListUsersIterable	listUsersPaginator(ListUsersRequest listUsersRequest)	This is a variant of listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest) operation.
default PutProjectPolicyResponse	putProjectPolicy(Consumer<PutProjectPolicyRequest.Builder> putProjectPolicyRequest)
default PutProjectPolicyResponse	putProjectPolicy(PutProjectPolicyRequest putProjectPolicyRequest)
default RecognizeCelebritiesResponse	recognizeCelebrities(Consumer<RecognizeCelebritiesRequest.Builder> recognizeCelebritiesRequest)	Returns an array of celebrities recognized in the input image.
default RecognizeCelebritiesResponse	recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest)	Returns an array of celebrities recognized in the input image.
default SearchFacesResponse	searchFaces(Consumer<SearchFacesRequest.Builder> searchFacesRequest)	For a given input face ID, searches for matching faces in the collection the face belongs to.
default SearchFacesResponse	searchFaces(SearchFacesRequest searchFacesRequest)	For a given input face ID, searches for matching faces in the collection the face belongs to.
default SearchFacesByImageResponse	searchFacesByImage(Consumer<SearchFacesByImageRequest.Builder> searchFacesByImageRequest)	For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces.
default SearchFacesByImageResponse	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.
default SearchUsersResponse	searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)	Searches for UserIDs within a collection based on a FaceId or UserId.
default SearchUsersResponse	searchUsers(SearchUsersRequest searchUsersRequest)	Searches for UserIDs within a collection based on a FaceId or UserId.
default SearchUsersByImageResponse	searchUsersByImage(Consumer<SearchUsersByImageRequest.Builder> searchUsersByImageRequest)	Searches for UserIDs using a supplied image.
default SearchUsersByImageResponse	searchUsersByImage(SearchUsersByImageRequest searchUsersByImageRequest)	Searches for UserIDs using a supplied image.
default RekognitionServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartCelebrityRecognitionResponse	startCelebrityRecognition(Consumer<StartCelebrityRecognitionRequest.Builder> startCelebrityRecognitionRequest)	Starts asynchronous recognition of celebrities in a stored video.
default StartCelebrityRecognitionResponse	startCelebrityRecognition(StartCelebrityRecognitionRequest startCelebrityRecognitionRequest)	Starts asynchronous recognition of celebrities in a stored video.
default StartContentModerationResponse	startContentModeration(Consumer<StartContentModerationRequest.Builder> startContentModerationRequest)	Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video.
default StartContentModerationResponse	startContentModeration(StartContentModerationRequest startContentModerationRequest)	Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video.
default StartFaceDetectionResponse	startFaceDetection(Consumer<StartFaceDetectionRequest.Builder> startFaceDetectionRequest)	Starts asynchronous detection of faces in a stored video.
default StartFaceDetectionResponse	startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest)	Starts asynchronous detection of faces in a stored video.
default StartFaceSearchResponse	startFaceSearch(Consumer<StartFaceSearchRequest.Builder> startFaceSearchRequest)	Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
default StartFaceSearchResponse	startFaceSearch(StartFaceSearchRequest startFaceSearchRequest)	Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
default StartLabelDetectionResponse	startLabelDetection(Consumer<StartLabelDetectionRequest.Builder> startLabelDetectionRequest)	Starts asynchronous detection of labels in a stored video.
default StartLabelDetectionResponse	startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest)	Starts asynchronous detection of labels in a stored video.
default StartMediaAnalysisJobResponse	startMediaAnalysisJob(Consumer<StartMediaAnalysisJobRequest.Builder> startMediaAnalysisJobRequest)
default StartMediaAnalysisJobResponse	startMediaAnalysisJob(StartMediaAnalysisJobRequest startMediaAnalysisJobRequest)
default StartPersonTrackingResponse	startPersonTracking(Consumer<StartPersonTrackingRequest.Builder> startPersonTrackingRequest)
default StartPersonTrackingResponse	startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest)
default StartProjectVersionResponse	startProjectVersion(Consumer<StartProjectVersionRequest.Builder> startProjectVersionRequest)
default StartProjectVersionResponse	startProjectVersion(StartProjectVersionRequest startProjectVersionRequest)
default StartSegmentDetectionResponse	startSegmentDetection(Consumer<StartSegmentDetectionRequest.Builder> startSegmentDetectionRequest)	Starts asynchronous detection of segment detection in a stored video.
default StartSegmentDetectionResponse	startSegmentDetection(StartSegmentDetectionRequest startSegmentDetectionRequest)	Starts asynchronous detection of segment detection in a stored video.
default StartStreamProcessorResponse	startStreamProcessor(Consumer<StartStreamProcessorRequest.Builder> startStreamProcessorRequest)
default StartStreamProcessorResponse	startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest)
default StartTextDetectionResponse	startTextDetection(Consumer<StartTextDetectionRequest.Builder> startTextDetectionRequest)	Starts asynchronous detection of text in a stored video.
default StartTextDetectionResponse	startTextDetection(StartTextDetectionRequest startTextDetectionRequest)	Starts asynchronous detection of text in a stored video.
default StopProjectVersionResponse	stopProjectVersion(Consumer<StopProjectVersionRequest.Builder> stopProjectVersionRequest)
default StopProjectVersionResponse	stopProjectVersion(StopProjectVersionRequest stopProjectVersionRequest)
default StopStreamProcessorResponse	stopStreamProcessor(Consumer<StopStreamProcessorRequest.Builder> stopStreamProcessorRequest)
default StopStreamProcessorResponse	stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest)
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
default UpdateDatasetEntriesResponse	updateDatasetEntries(Consumer<UpdateDatasetEntriesRequest.Builder> updateDatasetEntriesRequest)
default UpdateDatasetEntriesResponse	updateDatasetEntries(UpdateDatasetEntriesRequest updateDatasetEntriesRequest)
default UpdateStreamProcessorResponse	updateStreamProcessor(Consumer<UpdateStreamProcessorRequest.Builder> updateStreamProcessorRequest)
default UpdateStreamProcessorResponse	updateStreamProcessor(UpdateStreamProcessorRequest updateStreamProcessorRequest)
default RekognitionWaiter	waiter()	Create an instance of RekognitionWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

associateFaces

default AssociateFacesResponse associateFaces(AssociateFacesRequest associateFacesRequest)
                                       throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
ResourceNotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each FaceId that are present in the FaceIds list is associated with the provided UserID. The number of FaceIds that can be used as input in a single request is limited to 100.

Note that the total number of faces that can be associated with a single UserID is also limited to 100. Once a UserID has 100 faces associated with it, no additional faces can be added. If more API calls are made after the limit is reached, a ServiceQuotaExceededException will result.

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

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

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

• ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.

• CREATED - A UserID has been created, but has no FaceID(s) associated with it.

• UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking place.

Parameters:

associateFacesRequest -

Returns:

Result of the AssociateFaces operation returned by the service.

associateFaces

default AssociateFacesResponse associateFaces(Consumer<AssociateFacesRequest.Builder> associateFacesRequest)
                                       throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
ResourceNotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each FaceId that are present in the FaceIds list is associated with the provided UserID. The number of FaceIds that can be used as input in a single request is limited to 100.

Note that the total number of faces that can be associated with a single UserID is also limited to 100. Once a UserID has 100 faces associated with it, no additional faces can be added. If more API calls are made after the limit is reached, a ServiceQuotaExceededException will result.

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

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

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

• ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.

• CREATED - A UserID has been created, but has no FaceID(s) associated with it.

• UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking place.

This is a convenience which creates an instance of the AssociateFacesRequest.Builder avoiding the need to create one manually via AssociateFacesRequest.builder()

Parameters:

associateFacesRequest - A Consumer that will call methods on AssociateFacesRequest.Builder to create a request.

Returns:

Result of the AssociateFaces operation returned by the service.

compareFaces

default CompareFacesResponse compareFaces(CompareFacesRequest compareFacesRequest)
                                   throws InvalidParameterException,
InvalidS3ObjectException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:

compareFacesRequest -

Returns:

Result of the CompareFaces operation returned by the service.

See Also:

• Code Example

compareFaces

default CompareFacesResponse compareFaces(Consumer<CompareFacesRequest.Builder> compareFacesRequest)
                                   throws InvalidParameterException,
InvalidS3ObjectException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

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

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

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

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

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

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

This is a convenience which creates an instance of the CompareFacesRequest.Builder avoiding the need to create one manually via CompareFacesRequest.builder()

Parameters:

compareFacesRequest - A Consumer that will call methods on CompareFacesRequest.Builder to create a request.

Returns:

Result of the CompareFaces operation returned by the service.

See Also:

• Code Example

copyProjectVersion

default CopyProjectVersionResponse copyProjectVersion(CopyProjectVersionRequest copyProjectVersionRequest)
                                               throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
ProvisionedThroughputExceededException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

Copying project versions is supported only for Custom Labels models.

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

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

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

Parameters:

copyProjectVersionRequest -

Returns:

Result of the CopyProjectVersion operation returned by the service.

copyProjectVersion

default CopyProjectVersionResponse copyProjectVersion(Consumer<CopyProjectVersionRequest.Builder> copyProjectVersionRequest)
                                               throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
ProvisionedThroughputExceededException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

Copying project versions is supported only for Custom Labels models.

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

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

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

This is a convenience which creates an instance of the CopyProjectVersionRequest.Builder avoiding the need to create one manually via CopyProjectVersionRequest.builder()

Parameters:

copyProjectVersionRequest - A Consumer that will call methods on CopyProjectVersionRequest.Builder to create a request.

Returns:

Result of the CopyProjectVersion operation returned by the service.

createCollection

default CreateCollectionResponse createCollection(CreateCollectionRequest createCollectionRequest)
                                           throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceAlreadyExistsException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

Collection names are case-sensitive.

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

Parameters:

createCollectionRequest -

Returns:

Result of the CreateCollection operation returned by the service.

See Also:

• Code Example

createCollection

default CreateCollectionResponse createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)
                                           throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceAlreadyExistsException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

Collection names are case-sensitive.

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

This is a convenience which creates an instance of the CreateCollectionRequest.Builder avoiding the need to create one manually via CreateCollectionRequest.builder()

Parameters:

createCollectionRequest - A Consumer that will call methods on CreateCollectionRequest.Builder to create a request.

Returns:

Result of the CreateCollection operation returned by the service.

See Also:

• Code Example

createDataset

default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest)
                                     throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
LimitExceededException,
InvalidS3ObjectException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

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

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

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

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

createDataset

default CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
                                     throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
LimitExceededException,
InvalidS3ObjectException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

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

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

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

This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to create one manually via CreateDatasetRequest.builder()

Parameters:

createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.

Returns:

Result of the CreateDataset operation returned by the service.

createFaceLivenessSession

default CreateFaceLivenessSessionResponse createFaceLivenessSession(CreateFaceLivenessSessionRequest createFaceLivenessSessionRequest)
                                                             throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

You can use the ChallengePreferences option in the Settings parameter to choose between the 'FaceMovementAndLightChallenge' or FaceMovementChallenge' settings. See the Shared Responsibility page for details on guidance for which setting to choose between these two settings depending on your use case and preferences. This parameter is optional and if no parameter is provided, then the 'FaceMovementAndLightChallenge' settings is applied by default.

Parameters:

createFaceLivenessSessionRequest -

Returns:

Result of the CreateFaceLivenessSession operation returned by the service.

createFaceLivenessSession

default CreateFaceLivenessSessionResponse createFaceLivenessSession(Consumer<CreateFaceLivenessSessionRequest.Builder> createFaceLivenessSessionRequest)
                                                             throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

You can use the ChallengePreferences option in the Settings parameter to choose between the 'FaceMovementAndLightChallenge' or FaceMovementChallenge' settings. See the Shared Responsibility page for details on guidance for which setting to choose between these two settings depending on your use case and preferences. This parameter is optional and if no parameter is provided, then the 'FaceMovementAndLightChallenge' settings is applied by default.

This is a convenience which creates an instance of the CreateFaceLivenessSessionRequest.Builder avoiding the need to create one manually via CreateFaceLivenessSessionRequest.builder()

Parameters:

createFaceLivenessSessionRequest - A Consumer that will call methods on CreateFaceLivenessSessionRequest.Builder to create a request.

Returns:

Result of the CreateFaceLivenessSession operation returned by the service.

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws ResourceInUseException,
LimitExceededException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

createProject

default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
                                     throws ResourceInUseException,
LimitExceededException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.

Returns:

Result of the CreateProject operation returned by the service.

createProjectVersion

default CreateProjectVersionResponse createProjectVersion(CreateProjectVersionRequest createProjectVersionRequest)
                                                   throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

Parameters:

createProjectVersionRequest -

Returns:

Result of the CreateProjectVersion operation returned by the service.

createProjectVersion

default CreateProjectVersionResponse createProjectVersion(Consumer<CreateProjectVersionRequest.Builder> createProjectVersionRequest)
                                                   throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

This is a convenience which creates an instance of the CreateProjectVersionRequest.Builder avoiding the need to create one manually via CreateProjectVersionRequest.builder()

Parameters:

createProjectVersionRequest - A Consumer that will call methods on CreateProjectVersionRequest.Builder to create a request.

Returns:

Result of the CreateProjectVersion operation returned by the service.

createStreamProcessor

default CreateStreamProcessorResponse createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
LimitExceededException,
ResourceInUseException,
ProvisionedThroughputExceededException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

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

• If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream ( Input) and a Kinesis data stream (Output) stream for receiving the output. You must use the FaceSearch option in Settings, specifying the collection that contains the faces you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing.

• If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream ( Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN ( NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect by using the ConnectedHome option in settings, and selecting one of the following: PERSON, PET, PACKAGE, ALL You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.

Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

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

Parameters:

createStreamProcessorRequest -

Returns:

Result of the CreateStreamProcessor operation returned by the service.

createStreamProcessor

default CreateStreamProcessorResponse createStreamProcessor(Consumer<CreateStreamProcessorRequest.Builder> createStreamProcessorRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
LimitExceededException,
ResourceInUseException,
ProvisionedThroughputExceededException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

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

• If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream ( Input) and a Kinesis data stream (Output) stream for receiving the output. You must use the FaceSearch option in Settings, specifying the collection that contains the faces you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing.

• If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream ( Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN ( NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect by using the ConnectedHome option in settings, and selecting one of the following: PERSON, PET, PACKAGE, ALL You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.

Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

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

This is a convenience which creates an instance of the CreateStreamProcessorRequest.Builder avoiding the need to create one manually via CreateStreamProcessorRequest.builder()

Parameters:

createStreamProcessorRequest - A Consumer that will call methods on CreateStreamProcessorRequest.Builder to create a request.

Returns:

Result of the CreateStreamProcessor operation returned by the service.

createUser

default CreateUserResponse createUser(CreateUserRequest createUserRequest)
                               throws InvalidParameterException,
ConflictException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

createUser

default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
                               throws InvalidParameterException,
ConflictException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()

Parameters:

createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.

Returns:

Result of the CreateUser operation returned by the service.

deleteCollection

default DeleteCollectionResponse deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
                                           throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

Parameters:

deleteCollectionRequest -

Returns:

Result of the DeleteCollection operation returned by the service.

See Also:

• Code Example

deleteCollection

default DeleteCollectionResponse deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)
                                           throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

This is a convenience which creates an instance of the DeleteCollectionRequest.Builder avoiding the need to create one manually via DeleteCollectionRequest.builder()

Parameters:

deleteCollectionRequest - A Consumer that will call methods on DeleteCollectionRequest.Builder to create a request.

Returns:

Result of the DeleteCollection operation returned by the service.

See Also:

• Code Example

deleteDataset

default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
                                     throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

deleteDataset

default DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
                                     throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to create one manually via DeleteDatasetRequest.builder()

Parameters:

deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.

Returns:

Result of the DeleteDataset operation returned by the service.

deleteFaces

default DeleteFacesResponse deleteFaces(DeleteFacesRequest deleteFacesRequest)
                                 throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

See Also:

• Code Example

deleteFaces

default DeleteFacesResponse deleteFaces(Consumer<DeleteFacesRequest.Builder> deleteFacesRequest)
                                 throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the DeleteFacesRequest.Builder avoiding the need to create one manually via DeleteFacesRequest.builder()

Parameters:

deleteFacesRequest - A Consumer that will call methods on DeleteFacesRequest.Builder to create a request.

Returns:

Result of the DeleteFaces operation returned by the service.

See Also:

• Code Example

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws ResourceInUseException,
ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

deleteProject

default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
                                     throws ResourceInUseException,
ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.

Returns:

Result of the DeleteProject operation returned by the service.

deleteProjectPolicy

default DeleteProjectPolicyResponse deleteProjectPolicy(DeleteProjectPolicyRequest deleteProjectPolicyRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ResourceNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPolicyRevisionIdException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing project policy.

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

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

Parameters:

deleteProjectPolicyRequest -

Returns:

Result of the DeleteProjectPolicy operation returned by the service.

deleteProjectPolicy

default DeleteProjectPolicyResponse deleteProjectPolicy(Consumer<DeleteProjectPolicyRequest.Builder> deleteProjectPolicyRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ResourceNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPolicyRevisionIdException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing project policy.

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

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

This is a convenience which creates an instance of the DeleteProjectPolicyRequest.Builder avoiding the need to create one manually via DeleteProjectPolicyRequest.builder()

Parameters:

deleteProjectPolicyRequest - A Consumer that will call methods on DeleteProjectPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteProjectPolicy operation returned by the service.

deleteProjectVersion

default DeleteProjectVersionResponse deleteProjectVersion(DeleteProjectVersionRequest deleteProjectVersionRequest)
                                                   throws ResourceNotFoundException,
ResourceInUseException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

Parameters:

deleteProjectVersionRequest -

Returns:

Result of the DeleteProjectVersion operation returned by the service.

deleteProjectVersion

default DeleteProjectVersionResponse deleteProjectVersion(Consumer<DeleteProjectVersionRequest.Builder> deleteProjectVersionRequest)
                                                   throws ResourceNotFoundException,
ResourceInUseException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

This is a convenience which creates an instance of the DeleteProjectVersionRequest.Builder avoiding the need to create one manually via DeleteProjectVersionRequest.builder()

Parameters:

deleteProjectVersionRequest - A Consumer that will call methods on DeleteProjectVersionRequest.Builder to create a request.

Returns:

Result of the DeleteProjectVersion operation returned by the service.

deleteStreamProcessor

default DeleteStreamProcessorResponse deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ResourceInUseException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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.

deleteStreamProcessor

default DeleteStreamProcessorResponse deleteStreamProcessor(Consumer<DeleteStreamProcessorRequest.Builder> deleteStreamProcessorRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ResourceInUseException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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.

This is a convenience which creates an instance of the DeleteStreamProcessorRequest.Builder avoiding the need to create one manually via DeleteStreamProcessorRequest.builder()

Parameters:

deleteStreamProcessorRequest - A Consumer that will call methods on DeleteStreamProcessorRequest.Builder to create a request.

Returns:

Result of the DeleteStreamProcessor operation returned by the service.

deleteUser

default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
                               throws InvalidParameterException,
ConflictException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

deleteUser

default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
                               throws InvalidParameterException,
ConflictException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

Result of the DeleteUser operation returned by the service.

describeCollection

default DescribeCollectionResponse describeCollection(DescribeCollectionRequest describeCollectionRequest)
                                               throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

See Also:

• Code Example

describeCollection

default DescribeCollectionResponse describeCollection(Consumer<DescribeCollectionRequest.Builder> describeCollectionRequest)
                                               throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the DescribeCollectionRequest.Builder avoiding the need to create one manually via DescribeCollectionRequest.builder()

Parameters:

describeCollectionRequest - A Consumer that will call methods on DescribeCollectionRequest.Builder to create a request.

Returns:

Result of the DescribeCollection operation returned by the service.

See Also:

• Code Example

describeDataset

default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest)
                                         throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

describeDataset

default DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
                                         throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need to create one manually via DescribeDatasetRequest.builder()

Parameters:

describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.

Returns:

Result of the DescribeDataset operation returned by the service.

describeProjectVersions

default DescribeProjectVersionsResponse describeProjectVersions(DescribeProjectVersionsRequest describeProjectVersionsRequest)
                                                         throws ResourceNotFoundException,
InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

Parameters:

describeProjectVersionsRequest -

Returns:

Result of the DescribeProjectVersions operation returned by the service.

describeProjectVersions

default DescribeProjectVersionsResponse describeProjectVersions(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)
                                                         throws ResourceNotFoundException,
InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

This is a convenience which creates an instance of the DescribeProjectVersionsRequest.Builder avoiding the need to create one manually via DescribeProjectVersionsRequest.builder()

Parameters:

describeProjectVersionsRequest - A Consumer that will call methods on DescribeProjectVersionsRequest.Builder to create a request.

Returns:

Result of the DescribeProjectVersions operation returned by the service.

describeProjectVersionsPaginator

default DescribeProjectVersionsIterable describeProjectVersionsPaginator(DescribeProjectVersionsRequest describeProjectVersionsRequest)
                                                                  throws ResourceNotFoundException,
InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable responses = client.describeProjectVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable responses = client
             .describeProjectVersionsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable responses = client.describeProjectVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) operation.

Parameters:

describeProjectVersionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeProjectVersionsPaginator

default DescribeProjectVersionsIterable describeProjectVersionsPaginator(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)
                                                                  throws ResourceNotFoundException,
InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable responses = client.describeProjectVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable responses = client
             .describeProjectVersionsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable responses = client.describeProjectVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) operation.

This is a convenience which creates an instance of the DescribeProjectVersionsRequest.Builder avoiding the need to create one manually via DescribeProjectVersionsRequest.builder()

Parameters:

describeProjectVersionsRequest - A Consumer that will call methods on DescribeProjectVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeProjects

default DescribeProjectsResponse describeProjects(DescribeProjectsRequest describeProjectsRequest)
                                           throws InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Gets information about your Rekognition projects.

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

Parameters:

describeProjectsRequest -

Returns:

Result of the DescribeProjects operation returned by the service.

describeProjects

default DescribeProjectsResponse describeProjects(Consumer<DescribeProjectsRequest.Builder> describeProjectsRequest)
                                           throws InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Gets information about your Rekognition projects.

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

This is a convenience which creates an instance of the DescribeProjectsRequest.Builder avoiding the need to create one manually via DescribeProjectsRequest.builder()

Parameters:

describeProjectsRequest - A Consumer that will call methods on DescribeProjectsRequest.Builder to create a request.

Returns:

Result of the DescribeProjects operation returned by the service.

describeProjectsPaginator

default DescribeProjectsIterable describeProjectsPaginator(DescribeProjectsRequest describeProjectsRequest)
                                                    throws InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable responses = client.describeProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable responses = client
             .describeProjectsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.DescribeProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable responses = client.describeProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest) operation.

Parameters:

describeProjectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeProjectsPaginator

default DescribeProjectsIterable describeProjectsPaginator(Consumer<DescribeProjectsRequest.Builder> describeProjectsRequest)
                                                    throws InvalidPaginationTokenException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable responses = client.describeProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable responses = client
             .describeProjectsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.DescribeProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable responses = client.describeProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest) operation.

This is a convenience which creates an instance of the DescribeProjectsRequest.Builder avoiding the need to create one manually via DescribeProjectsRequest.builder()

Parameters:

describeProjectsRequest - A Consumer that will call methods on DescribeProjectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeStreamProcessor

default DescribeStreamProcessorResponse describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest)
                                                         throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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.

describeStreamProcessor

default DescribeStreamProcessorResponse describeStreamProcessor(Consumer<DescribeStreamProcessorRequest.Builder> describeStreamProcessorRequest)
                                                         throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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.

This is a convenience which creates an instance of the DescribeStreamProcessorRequest.Builder avoiding the need to create one manually via DescribeStreamProcessorRequest.builder()

Parameters:

describeStreamProcessorRequest - A Consumer that will call methods on DescribeStreamProcessorRequest.Builder to create a request.

Returns:

Result of the DescribeStreamProcessor operation returned by the service.

detectCustomLabels

default DetectCustomLabelsResponse detectCustomLabels(DetectCustomLabelsRequest detectCustomLabelsRequest)
                                               throws ResourceNotFoundException,
ResourceNotReadyException,
InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
LimitExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

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

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

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

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

Parameters:

detectCustomLabelsRequest -

Returns:

Result of the DetectCustomLabels operation returned by the service.

detectCustomLabels

default DetectCustomLabelsResponse detectCustomLabels(Consumer<DetectCustomLabelsRequest.Builder> detectCustomLabelsRequest)
                                               throws ResourceNotFoundException,
ResourceNotReadyException,
InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
LimitExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

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

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

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

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

This is a convenience which creates an instance of the DetectCustomLabelsRequest.Builder avoiding the need to create one manually via DetectCustomLabelsRequest.builder()

Parameters:

detectCustomLabelsRequest - A Consumer that will call methods on DetectCustomLabelsRequest.Builder to create a request.

Returns:

Result of the DetectCustomLabels operation returned by the service.

detectFaces

default DetectFacesResponse detectFaces(DetectFacesRequest detectFacesRequest)
                                 throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

Detects faces within an image that is provided as input.

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

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

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

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

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

Parameters:

detectFacesRequest -

Returns:

Result of the DetectFaces operation returned by the service.

See Also:

• Code Example

detectFaces

default DetectFacesResponse detectFaces(Consumer<DetectFacesRequest.Builder> detectFacesRequest)
                                 throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

Detects faces within an image that is provided as input.

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

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

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

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

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

This is a convenience which creates an instance of the DetectFacesRequest.Builder avoiding the need to create one manually via DetectFacesRequest.builder()

Parameters:

detectFacesRequest - A Consumer that will call methods on DetectFacesRequest.Builder to create a request.

Returns:

Result of the DetectFaces operation returned by the service.

See Also:

• Code Example

detectLabels

default DetectLabelsResponse detectLabels(DetectLabelsRequest detectLabelsRequest)
                                   throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.

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

Optional Parameters

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

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

When getting labels, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. The default and upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a feature type.

Response Elements

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

• Name - The name of the detected label.

• Confidence - The level of confidence in the label assigned to a detected object.

• Parents - The ancestor labels for a detected label. DetectLabels returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

• Aliases - Possible Aliases for the label.

• Categories - The label categories that the detected label belongs to.

• BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

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

• Quality - Information about the Sharpness, Brightness, and Contrast of the input image, scored between 0 to 100. Image quality is returned for the entire image, as well as the background and the foreground.

• Dominant Color - An array of the dominant colors in the image.

• Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.

• Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

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

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

The list of labels can include multiple labels for the same object. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

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

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

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

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

Parameters:

detectLabelsRequest -

Returns:

Result of the DetectLabels operation returned by the service.

See Also:

• Code Example

detectLabels

default DetectLabelsResponse detectLabels(Consumer<DetectLabelsRequest.Builder> detectLabelsRequest)
                                   throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.

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

Optional Parameters

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

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

When getting labels, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. The default and upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a feature type.

Response Elements

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

• Name - The name of the detected label.

• Confidence - The level of confidence in the label assigned to a detected object.

• Parents - The ancestor labels for a detected label. DetectLabels returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

• Aliases - Possible Aliases for the label.

• Categories - The label categories that the detected label belongs to.

• BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

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

• Quality - Information about the Sharpness, Brightness, and Contrast of the input image, scored between 0 to 100. Image quality is returned for the entire image, as well as the background and the foreground.

• Dominant Color - An array of the dominant colors in the image.

• Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.

• Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

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

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

The list of labels can include multiple labels for the same object. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

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

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

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

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

This is a convenience which creates an instance of the DetectLabelsRequest.Builder avoiding the need to create one manually via DetectLabelsRequest.builder()

Parameters:

detectLabelsRequest - A Consumer that will call methods on DetectLabelsRequest.Builder to create a request.

Returns:

Result of the DetectLabels operation returned by the service.

See Also:

• Code Example

detectModerationLabels

default DetectModerationLabelsResponse detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest)
                                                       throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
HumanLoopQuotaExceededException,
ResourceNotFoundException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

Parameters:

detectModerationLabelsRequest -

Returns:

Result of the DetectModerationLabels operation returned by the service.

See Also:

• Code Example

detectModerationLabels

default DetectModerationLabelsResponse detectModerationLabels(Consumer<DetectModerationLabelsRequest.Builder> detectModerationLabelsRequest)
                                                       throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
HumanLoopQuotaExceededException,
ResourceNotFoundException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

This is a convenience which creates an instance of the DetectModerationLabelsRequest.Builder avoiding the need to create one manually via DetectModerationLabelsRequest.builder()

Parameters:

detectModerationLabelsRequest - A Consumer that will call methods on DetectModerationLabelsRequest.Builder to create a request.

Returns:

Result of the DetectModerationLabels operation returned by the service.

See Also:

• Code Example

detectProtectiveEquipment

default DetectProtectiveEquipmentResponse detectProtectiveEquipment(DetectProtectiveEquipmentRequest detectProtectiveEquipmentRequest)
                                                             throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

detectProtectiveEquipment

default DetectProtectiveEquipmentResponse detectProtectiveEquipment(Consumer<DetectProtectiveEquipmentRequest.Builder> detectProtectiveEquipmentRequest)
                                                             throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the DetectProtectiveEquipmentRequest.Builder avoiding the need to create one manually via DetectProtectiveEquipmentRequest.builder()

Parameters:

detectProtectiveEquipmentRequest - A Consumer that will call methods on DetectProtectiveEquipmentRequest.Builder to create a request.

Returns:

Result of the DetectProtectiveEquipment operation returned by the service.

detectText

default DetectTextResponse detectText(DetectTextRequest detectTextRequest)
                               throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

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

Parameters:

detectTextRequest -

Returns:

Result of the DetectText operation returned by the service.

See Also:

• Code Example

detectText

default DetectTextResponse detectText(Consumer<DetectTextRequest.Builder> detectTextRequest)
                               throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

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

This is a convenience which creates an instance of the DetectTextRequest.Builder avoiding the need to create one manually via DetectTextRequest.builder()

Parameters:

detectTextRequest - A Consumer that will call methods on DetectTextRequest.Builder to create a request.

Returns:

Result of the DetectText operation returned by the service.

See Also:

• Code Example

disassociateFaces

default DisassociateFacesResponse disassociateFaces(DisassociateFacesRequest disassociateFacesRequest)
                                             throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Parameters:

disassociateFacesRequest -

Returns:

Result of the DisassociateFaces operation returned by the service.

disassociateFaces

default DisassociateFacesResponse disassociateFaces(Consumer<DisassociateFacesRequest.Builder> disassociateFacesRequest)
                                             throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
IdempotentParameterMismatchException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
RekognitionException

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

This is a convenience which creates an instance of the DisassociateFacesRequest.Builder avoiding the need to create one manually via DisassociateFacesRequest.builder()

Parameters:

disassociateFacesRequest - A Consumer that will call methods on DisassociateFacesRequest.Builder to create a request.

Returns:

Result of the DisassociateFaces operation returned by the service.

distributeDatasetEntries

default DistributeDatasetEntriesResponse distributeDatasetEntries(DistributeDatasetEntriesRequest distributeDatasetEntriesRequest)
                                                           throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

Parameters:

distributeDatasetEntriesRequest -

Returns:

Result of the DistributeDatasetEntries operation returned by the service.

distributeDatasetEntries

default DistributeDatasetEntriesResponse distributeDatasetEntries(Consumer<DistributeDatasetEntriesRequest.Builder> distributeDatasetEntriesRequest)
                                                           throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

This is a convenience which creates an instance of the DistributeDatasetEntriesRequest.Builder avoiding the need to create one manually via DistributeDatasetEntriesRequest.builder()

Parameters:

distributeDatasetEntriesRequest - A Consumer that will call methods on DistributeDatasetEntriesRequest.Builder to create a request.

Returns:

Result of the DistributeDatasetEntries operation returned by the service.

getCelebrityInfo

default GetCelebrityInfoResponse getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest)
                                           throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

Parameters:

getCelebrityInfoRequest -

Returns:

Result of the GetCelebrityInfo operation returned by the service.

getCelebrityInfo

default GetCelebrityInfoResponse getCelebrityInfo(Consumer<GetCelebrityInfoRequest.Builder> getCelebrityInfoRequest)
                                           throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

This is a convenience which creates an instance of the GetCelebrityInfoRequest.Builder avoiding the need to create one manually via GetCelebrityInfoRequest.builder()

Parameters:

getCelebrityInfoRequest - A Consumer that will call methods on GetCelebrityInfoRequest.Builder to create a request.

Returns:

Result of the GetCelebrityInfo operation returned by the service.

getCelebrityRecognition

default GetCelebrityRecognitionResponse getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)
                                                         throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

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

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

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array ( Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

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

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

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

No information is returned for faces not recognized as celebrities.

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

Parameters:

getCelebrityRecognitionRequest -

Returns:

Result of the GetCelebrityRecognition operation returned by the service.

getCelebrityRecognition

default GetCelebrityRecognitionResponse getCelebrityRecognition(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest)
                                                         throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

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

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

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array ( Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

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

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

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

No information is returned for faces not recognized as celebrities.

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

This is a convenience which creates an instance of the GetCelebrityRecognitionRequest.Builder avoiding the need to create one manually via GetCelebrityRecognitionRequest.builder()

Parameters:

getCelebrityRecognitionRequest - A Consumer that will call methods on GetCelebrityRecognitionRequest.Builder to create a request.

Returns:

Result of the GetCelebrityRecognition operation returned by the service.

getCelebrityRecognitionPaginator

default GetCelebrityRecognitionIterable getCelebrityRecognitionPaginator(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)
                                                                  throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client
             .getCelebrityRecognitionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest) operation.

Parameters:

getCelebrityRecognitionRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getCelebrityRecognitionPaginator

default GetCelebrityRecognitionIterable getCelebrityRecognitionPaginator(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest)
                                                                  throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client
             .getCelebrityRecognitionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest) operation.

This is a convenience which creates an instance of the GetCelebrityRecognitionRequest.Builder avoiding the need to create one manually via GetCelebrityRecognitionRequest.builder()

Parameters:

getCelebrityRecognitionRequest - A Consumer that will call methods on GetCelebrityRecognitionRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getContentModeration

default GetContentModerationResponse getContentModeration(GetContentModerationRequest getContentModerationRequest)
                                                   throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

Parameters:

getContentModerationRequest -

Returns:

Result of the GetContentModeration operation returned by the service.

getContentModeration

default GetContentModerationResponse getContentModeration(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest)
                                                   throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

This is a convenience which creates an instance of the GetContentModerationRequest.Builder avoiding the need to create one manually via GetContentModerationRequest.builder()

Parameters:

getContentModerationRequest - A Consumer that will call methods on GetContentModerationRequest.Builder to create a request.

Returns:

Result of the GetContentModeration operation returned by the service.

getContentModerationPaginator

default GetContentModerationIterable getContentModerationPaginator(GetContentModerationRequest getContentModerationRequest)
                                                            throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client
             .getContentModerationPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetContentModerationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest) operation.

Parameters:

getContentModerationRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getContentModerationPaginator

default GetContentModerationIterable getContentModerationPaginator(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest)
                                                            throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client
             .getContentModerationPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetContentModerationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest) operation.

This is a convenience which creates an instance of the GetContentModerationRequest.Builder avoiding the need to create one manually via GetContentModerationRequest.builder()

Parameters:

getContentModerationRequest - A Consumer that will call methods on GetContentModerationRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getFaceDetection

default GetFaceDetectionResponse getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest)
                                           throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

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

Parameters:

getFaceDetectionRequest -

Returns:

Result of the GetFaceDetection operation returned by the service.

getFaceDetection

default GetFaceDetectionResponse getFaceDetection(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest)
                                           throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

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

This is a convenience which creates an instance of the GetFaceDetectionRequest.Builder avoiding the need to create one manually via GetFaceDetectionRequest.builder()

Parameters:

getFaceDetectionRequest - A Consumer that will call methods on GetFaceDetectionRequest.Builder to create a request.

Returns:

Result of the GetFaceDetection operation returned by the service.

getFaceDetectionPaginator

default GetFaceDetectionIterable getFaceDetectionPaginator(GetFaceDetectionRequest getFaceDetectionRequest)
                                                    throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client
             .getFaceDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetFaceDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest) operation.

Parameters:

getFaceDetectionRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getFaceDetectionPaginator

default GetFaceDetectionIterable getFaceDetectionPaginator(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest)
                                                    throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client
             .getFaceDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetFaceDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest) operation.

This is a convenience which creates an instance of the GetFaceDetectionRequest.Builder avoiding the need to create one manually via GetFaceDetectionRequest.builder()

Parameters:

getFaceDetectionRequest - A Consumer that will call methods on GetFaceDetectionRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getFaceLivenessSessionResults

default GetFaceLivenessSessionResultsResponse getFaceLivenessSessionResults(GetFaceLivenessSessionResultsRequest getFaceLivenessSessionResultsRequest)
                                                                     throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
SessionNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

For a session that has completed, the response can also include a Feedback list describing conditions that were detected in the selfie-video, such as low lighting or an obstructed face, and Metadata about the client that streamed the session.

Parameters:

getFaceLivenessSessionResultsRequest -

Returns:

Result of the GetFaceLivenessSessionResults operation returned by the service.

getFaceLivenessSessionResults

default GetFaceLivenessSessionResultsResponse getFaceLivenessSessionResults(Consumer<GetFaceLivenessSessionResultsRequest.Builder> getFaceLivenessSessionResultsRequest)
                                                                     throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
SessionNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

For a session that has completed, the response can also include a Feedback list describing conditions that were detected in the selfie-video, such as low lighting or an obstructed face, and Metadata about the client that streamed the session.

This is a convenience which creates an instance of the GetFaceLivenessSessionResultsRequest.Builder avoiding the need to create one manually via GetFaceLivenessSessionResultsRequest.builder()

Parameters:

getFaceLivenessSessionResultsRequest - A Consumer that will call methods on GetFaceLivenessSessionResultsRequest.Builder to create a request.

Returns:

Result of the GetFaceLivenessSessionResults operation returned by the service.

getFaceSearch

default GetFaceSearchResponse getFaceSearch(GetFaceSearchRequest getFaceSearchRequest)
                                     throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

getFaceSearch

default GetFaceSearchResponse getFaceSearch(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest)
                                     throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the GetFaceSearchRequest.Builder avoiding the need to create one manually via GetFaceSearchRequest.builder()

Parameters:

getFaceSearchRequest - A Consumer that will call methods on GetFaceSearchRequest.Builder to create a request.

Returns:

Result of the GetFaceSearch operation returned by the service.

getFaceSearchPaginator

default GetFaceSearchIterable getFaceSearchPaginator(GetFaceSearchRequest getFaceSearchRequest)
                                              throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client
             .getFaceSearchPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetFaceSearchResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest) operation.

Parameters:

getFaceSearchRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getFaceSearchPaginator

default GetFaceSearchIterable getFaceSearchPaginator(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest)
                                              throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client
             .getFaceSearchPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetFaceSearchResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest) operation.

This is a convenience which creates an instance of the GetFaceSearchRequest.Builder avoiding the need to create one manually via GetFaceSearchRequest.builder()

Parameters:

getFaceSearchRequest - A Consumer that will call methods on GetFaceSearchRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getLabelDetection

default GetLabelDetectionResponse getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest)
                                             throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

The label detection operation is started by a call to StartLabelDetection which returns a job identifier ( JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection.

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

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. If there is no NAME specified, the default sort is by timestamp.

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

The returned Labels array may include the following attributes:

• Name - The name of the detected label.

• Confidence - The level of confidence in the label assigned to a detected object.

• Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

• Aliases - Possible Aliases for the label.

• Categories - The label categories that the detected label belongs to.

• BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

• Timestamp - Time, in milliseconds from the start of the video, that the label was detected. For aggregation by SEGMENTS, the StartTimestampMillis, EndTimestampMillis, and DurationMillis structures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same as StartTimestampMillis.

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

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

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

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

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

Parameters:

getLabelDetectionRequest -

Returns:

Result of the GetLabelDetection operation returned by the service.

getLabelDetection

default GetLabelDetectionResponse getLabelDetection(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest)
                                             throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

The label detection operation is started by a call to StartLabelDetection which returns a job identifier ( JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection.

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

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. If there is no NAME specified, the default sort is by timestamp.

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

The returned Labels array may include the following attributes:

• Name - The name of the detected label.

• Confidence - The level of confidence in the label assigned to a detected object.

• Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

• Aliases - Possible Aliases for the label.

• Categories - The label categories that the detected label belongs to.

• BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

• Timestamp - Time, in milliseconds from the start of the video, that the label was detected. For aggregation by SEGMENTS, the StartTimestampMillis, EndTimestampMillis, and DurationMillis structures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same as StartTimestampMillis.

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

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

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

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

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

This is a convenience which creates an instance of the GetLabelDetectionRequest.Builder avoiding the need to create one manually via GetLabelDetectionRequest.builder()

Parameters:

getLabelDetectionRequest - A Consumer that will call methods on GetLabelDetectionRequest.Builder to create a request.

Returns:

Result of the GetLabelDetection operation returned by the service.

getLabelDetectionPaginator

default GetLabelDetectionIterable getLabelDetectionPaginator(GetLabelDetectionRequest getLabelDetectionRequest)
                                                      throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client
             .getLabelDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetLabelDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest) operation.

Parameters:

getLabelDetectionRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getLabelDetectionPaginator

default GetLabelDetectionIterable getLabelDetectionPaginator(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest)
                                                      throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client
             .getLabelDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetLabelDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest) operation.

This is a convenience which creates an instance of the GetLabelDetectionRequest.Builder avoiding the need to create one manually via GetLabelDetectionRequest.builder()

Parameters:

getLabelDetectionRequest - A Consumer that will call methods on GetLabelDetectionRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getMediaAnalysisJob

default GetMediaAnalysisJobResponse getMediaAnalysisJob(GetMediaAnalysisJobRequest getMediaAnalysisJobRequest)
                                                 throws AccessDeniedException,
ResourceNotFoundException,
InternalServerErrorException,
InvalidParameterException,
ProvisionedThroughputExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

Parameters:

getMediaAnalysisJobRequest -

Returns:

Result of the GetMediaAnalysisJob operation returned by the service.

getMediaAnalysisJob

default GetMediaAnalysisJobResponse getMediaAnalysisJob(Consumer<GetMediaAnalysisJobRequest.Builder> getMediaAnalysisJobRequest)
                                                 throws AccessDeniedException,
ResourceNotFoundException,
InternalServerErrorException,
InvalidParameterException,
ProvisionedThroughputExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

This is a convenience which creates an instance of the GetMediaAnalysisJobRequest.Builder avoiding the need to create one manually via GetMediaAnalysisJobRequest.builder()

Parameters:

getMediaAnalysisJobRequest - A Consumer that will call methods on GetMediaAnalysisJobRequest.Builder to create a request.

Returns:

Result of the GetMediaAnalysisJob operation returned by the service.

getPersonTracking

default GetPersonTrackingResponse getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest)
                                             throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post.

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.

getPersonTracking

default GetPersonTrackingResponse getPersonTracking(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest)
                                             throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post.

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.

This is a convenience which creates an instance of the GetPersonTrackingRequest.Builder avoiding the need to create one manually via GetPersonTrackingRequest.builder()

Parameters:

getPersonTrackingRequest - A Consumer that will call methods on GetPersonTrackingRequest.Builder to create a request.

Returns:

Result of the GetPersonTracking operation returned by the service.

getPersonTrackingPaginator

default GetPersonTrackingIterable getPersonTrackingPaginator(GetPersonTrackingRequest getPersonTrackingRequest)
                                                      throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client
             .getPersonTrackingPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetPersonTrackingResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest) operation.

Parameters:

getPersonTrackingRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getPersonTrackingPaginator

default GetPersonTrackingIterable getPersonTrackingPaginator(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest)
                                                      throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client
             .getPersonTrackingPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetPersonTrackingResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest) operation.

This is a convenience which creates an instance of the GetPersonTrackingRequest.Builder avoiding the need to create one manually via GetPersonTrackingRequest.builder()

Parameters:

getPersonTrackingRequest - A Consumer that will call methods on GetPersonTrackingRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getSegmentDetection

default GetSegmentDetectionResponse getSegmentDetection(GetSegmentDetectionRequest getSegmentDetectionRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

getSegmentDetection

default GetSegmentDetectionResponse getSegmentDetection(Consumer<GetSegmentDetectionRequest.Builder> getSegmentDetectionRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the GetSegmentDetectionRequest.Builder avoiding the need to create one manually via GetSegmentDetectionRequest.builder()

Parameters:

getSegmentDetectionRequest - A Consumer that will call methods on GetSegmentDetectionRequest.Builder to create a request.

Returns:

Result of the GetSegmentDetection operation returned by the service.

getSegmentDetectionPaginator

default GetSegmentDetectionIterable getSegmentDetectionPaginator(GetSegmentDetectionRequest getSegmentDetectionRequest)
                                                          throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable responses = client.getSegmentDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable responses = client
             .getSegmentDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable responses = client.getSegmentDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest) operation.

Parameters:

getSegmentDetectionRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getSegmentDetectionPaginator

default GetSegmentDetectionIterable getSegmentDetectionPaginator(Consumer<GetSegmentDetectionRequest.Builder> getSegmentDetectionRequest)
                                                          throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable responses = client.getSegmentDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable responses = client
             .getSegmentDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable responses = client.getSegmentDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest) operation.

This is a convenience which creates an instance of the GetSegmentDetectionRequest.Builder avoiding the need to create one manually via GetSegmentDetectionRequest.builder()

Parameters:

getSegmentDetectionRequest - A Consumer that will call methods on GetSegmentDetectionRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getTextDetection

default GetTextDetectionResponse getTextDetection(GetTextDetectionRequest getTextDetectionRequest)
                                           throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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 100 words per frame of video.

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

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

Parameters:

getTextDetectionRequest -

Returns:

Result of the GetTextDetection operation returned by the service.

getTextDetection

default GetTextDetectionResponse getTextDetection(Consumer<GetTextDetectionRequest.Builder> getTextDetectionRequest)
                                           throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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 100 words per frame of video.

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

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

This is a convenience which creates an instance of the GetTextDetectionRequest.Builder avoiding the need to create one manually via GetTextDetectionRequest.builder()

Parameters:

getTextDetectionRequest - A Consumer that will call methods on GetTextDetectionRequest.Builder to create a request.

Returns:

Result of the GetTextDetection operation returned by the service.

getTextDetectionPaginator

default GetTextDetectionIterable getTextDetectionPaginator(GetTextDetectionRequest getTextDetectionRequest)
                                                    throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable responses = client.getTextDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable responses = client
             .getTextDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetTextDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable responses = client.getTextDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest) operation.

Parameters:

getTextDetectionRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

getTextDetectionPaginator

default GetTextDetectionIterable getTextDetectionPaginator(Consumer<GetTextDetectionRequest.Builder> getTextDetectionRequest)
                                                    throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable responses = client.getTextDetectionPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable responses = client
             .getTextDetectionPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.GetTextDetectionResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable responses = client.getTextDetectionPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest) operation.

This is a convenience which creates an instance of the GetTextDetectionRequest.Builder avoiding the need to create one manually via GetTextDetectionRequest.builder()

Parameters:

getTextDetectionRequest - A Consumer that will call methods on GetTextDetectionRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

indexFaces

default IndexFacesResponse indexFaces(IndexFacesRequest indexFacesRequest)
                               throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
InvalidImageFormatException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

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

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

Parameters:

indexFacesRequest -

Returns:

Result of the IndexFaces operation returned by the service.

See Also:

• Code Example

indexFaces

default IndexFacesResponse indexFaces(Consumer<IndexFacesRequest.Builder> indexFacesRequest)
                               throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
InvalidImageFormatException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

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

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

This is a convenience which creates an instance of the IndexFacesRequest.Builder avoiding the need to create one manually via IndexFacesRequest.builder()

Parameters:

indexFacesRequest - A Consumer that will call methods on IndexFacesRequest.Builder to create a request.

Returns:

Result of the IndexFaces operation returned by the service.

See Also:

• Code Example

listCollections

default ListCollectionsResponse listCollections(ListCollectionsRequest listCollectionsRequest)
                                         throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

See Also:

• Code Example

listCollections

default ListCollectionsResponse listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
                                         throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the ListCollectionsRequest.Builder avoiding the need to create one manually via ListCollectionsRequest.builder()

Parameters:

listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.

Returns:

Result of the ListCollections operation returned by the service.

See Also:

• Code Example

listCollections

default ListCollectionsResponse listCollections()
                                         throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see Listing collections in the Amazon Rekognition Developer Guide.

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

Returns:

Result of the ListCollections operation returned by the service.

See Also:

• listCollections(ListCollectionsRequest)
• Code Example

listCollectionsPaginator

default ListCollectionsIterable listCollectionsPaginator()
                                                  throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client
             .listCollectionsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listCollectionsPaginator(ListCollectionsRequest)
• Code Example

listCollectionsPaginator

default ListCollectionsIterable listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
                                                  throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client
             .listCollectionsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation.

Parameters:

listCollectionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• Code Example

listCollectionsPaginator

default ListCollectionsIterable listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
                                                  throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client
             .listCollectionsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest) operation.

This is a convenience which creates an instance of the ListCollectionsRequest.Builder avoiding the need to create one manually via ListCollectionsRequest.builder()

Parameters:

listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• Code Example

listDatasetEntries

default ListDatasetEntriesResponse listDatasetEntries(ListDatasetEntriesRequest listDatasetEntriesRequest)
                                               throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

Parameters:

listDatasetEntriesRequest -

Returns:

Result of the ListDatasetEntries operation returned by the service.

listDatasetEntries

default ListDatasetEntriesResponse listDatasetEntries(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)
                                               throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

This is a convenience which creates an instance of the ListDatasetEntriesRequest.Builder avoiding the need to create one manually via ListDatasetEntriesRequest.builder()

Parameters:

listDatasetEntriesRequest - A Consumer that will call methods on ListDatasetEntriesRequest.Builder to create a request.

Returns:

Result of the ListDatasetEntries operation returned by the service.

listDatasetEntriesPaginator

default ListDatasetEntriesIterable listDatasetEntriesPaginator(ListDatasetEntriesRequest listDatasetEntriesRequest)
                                                        throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable responses = client
             .listDatasetEntriesPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest) operation.

Parameters:

listDatasetEntriesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

listDatasetEntriesPaginator

default ListDatasetEntriesIterable listDatasetEntriesPaginator(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)
                                                        throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable responses = client
             .listDatasetEntriesPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest) operation.

This is a convenience which creates an instance of the ListDatasetEntriesRequest.Builder avoiding the need to create one manually via ListDatasetEntriesRequest.builder()

Parameters:

listDatasetEntriesRequest - A Consumer that will call methods on ListDatasetEntriesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listDatasetLabels

default ListDatasetLabelsResponse listDatasetLabels(ListDatasetLabelsRequest listDatasetLabelsRequest)
                                             throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
InvalidPaginationTokenException,
ResourceNotFoundException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

Parameters:

listDatasetLabelsRequest -

Returns:

Result of the ListDatasetLabels operation returned by the service.

listDatasetLabels

default ListDatasetLabelsResponse listDatasetLabels(Consumer<ListDatasetLabelsRequest.Builder> listDatasetLabelsRequest)
                                             throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
InvalidPaginationTokenException,
ResourceNotFoundException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

This is a convenience which creates an instance of the ListDatasetLabelsRequest.Builder avoiding the need to create one manually via ListDatasetLabelsRequest.builder()

Parameters:

listDatasetLabelsRequest - A Consumer that will call methods on ListDatasetLabelsRequest.Builder to create a request.

Returns:

Result of the ListDatasetLabels operation returned by the service.

listDatasetLabelsPaginator

default ListDatasetLabelsIterable listDatasetLabelsPaginator(ListDatasetLabelsRequest listDatasetLabelsRequest)
                                                      throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
InvalidPaginationTokenException,
ResourceNotFoundException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable responses = client.listDatasetLabelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable responses = client
             .listDatasetLabelsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable responses = client.listDatasetLabelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest) operation.

Parameters:

listDatasetLabelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

listDatasetLabelsPaginator

default ListDatasetLabelsIterable listDatasetLabelsPaginator(Consumer<ListDatasetLabelsRequest.Builder> listDatasetLabelsRequest)
                                                      throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
ResourceInUseException,
InvalidPaginationTokenException,
ResourceNotFoundException,
ResourceNotReadyException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable responses = client.listDatasetLabelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable responses = client
             .listDatasetLabelsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable responses = client.listDatasetLabelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest) operation.

This is a convenience which creates an instance of the ListDatasetLabelsRequest.Builder avoiding the need to create one manually via ListDatasetLabelsRequest.builder()

Parameters:

listDatasetLabelsRequest - A Consumer that will call methods on ListDatasetLabelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listFaces

default ListFacesResponse listFaces(ListFacesRequest listFacesRequest)
                             throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

See Also:

• Code Example

listFaces

default ListFacesResponse listFaces(Consumer<ListFacesRequest.Builder> listFacesRequest)
                             throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the ListFacesRequest.Builder avoiding the need to create one manually via ListFacesRequest.builder()

Parameters:

listFacesRequest - A Consumer that will call methods on ListFacesRequest.Builder to create a request.

Returns:

Result of the ListFaces operation returned by the service.

See Also:

• Code Example

listFacesPaginator

default ListFacesIterable listFacesPaginator(ListFacesRequest listFacesRequest)
                                      throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListFacesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest) operation.

Parameters:

listFacesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• Code Example

listFacesPaginator

default ListFacesIterable listFacesPaginator(Consumer<ListFacesRequest.Builder> listFacesRequest)
                                      throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListFacesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest) operation.

This is a convenience which creates an instance of the ListFacesRequest.Builder avoiding the need to create one manually via ListFacesRequest.builder()

Parameters:

listFacesRequest - A Consumer that will call methods on ListFacesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• Code Example

listMediaAnalysisJobs

default ListMediaAnalysisJobsResponse listMediaAnalysisJobs(ListMediaAnalysisJobsRequest listMediaAnalysisJobsRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

Parameters:

listMediaAnalysisJobsRequest -

Returns:

Result of the ListMediaAnalysisJobs operation returned by the service.

listMediaAnalysisJobs

default ListMediaAnalysisJobsResponse listMediaAnalysisJobs(Consumer<ListMediaAnalysisJobsRequest.Builder> listMediaAnalysisJobsRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

This is a convenience which creates an instance of the ListMediaAnalysisJobsRequest.Builder avoiding the need to create one manually via ListMediaAnalysisJobsRequest.builder()

Parameters:

listMediaAnalysisJobsRequest - A Consumer that will call methods on ListMediaAnalysisJobsRequest.Builder to create a request.

Returns:

Result of the ListMediaAnalysisJobs operation returned by the service.

listMediaAnalysisJobsPaginator

default ListMediaAnalysisJobsIterable listMediaAnalysisJobsPaginator(ListMediaAnalysisJobsRequest listMediaAnalysisJobsRequest)
                                                              throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listMediaAnalysisJobs(software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListMediaAnalysisJobsIterable responses = client.listMediaAnalysisJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListMediaAnalysisJobsIterable responses = client
             .listMediaAnalysisJobsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListMediaAnalysisJobsIterable responses = client.listMediaAnalysisJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMediaAnalysisJobs(software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsRequest) operation.

Parameters:

listMediaAnalysisJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

listMediaAnalysisJobsPaginator

default ListMediaAnalysisJobsIterable listMediaAnalysisJobsPaginator(Consumer<ListMediaAnalysisJobsRequest.Builder> listMediaAnalysisJobsRequest)
                                                              throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listMediaAnalysisJobs(software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListMediaAnalysisJobsIterable responses = client.listMediaAnalysisJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListMediaAnalysisJobsIterable responses = client
             .listMediaAnalysisJobsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListMediaAnalysisJobsIterable responses = client.listMediaAnalysisJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMediaAnalysisJobs(software.amazon.awssdk.services.rekognition.model.ListMediaAnalysisJobsRequest) operation.

This is a convenience which creates an instance of the ListMediaAnalysisJobsRequest.Builder avoiding the need to create one manually via ListMediaAnalysisJobsRequest.builder()

Parameters:

listMediaAnalysisJobsRequest - A Consumer that will call methods on ListMediaAnalysisJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listProjectPolicies

default ListProjectPoliciesResponse listProjectPolicies(ListProjectPoliciesRequest listProjectPoliciesRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ResourceNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

Parameters:

listProjectPoliciesRequest -

Returns:

Result of the ListProjectPolicies operation returned by the service.

listProjectPolicies

default ListProjectPoliciesResponse listProjectPolicies(Consumer<ListProjectPoliciesRequest.Builder> listProjectPoliciesRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ResourceNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

This is a convenience which creates an instance of the ListProjectPoliciesRequest.Builder avoiding the need to create one manually via ListProjectPoliciesRequest.builder()

Parameters:

listProjectPoliciesRequest - A Consumer that will call methods on ListProjectPoliciesRequest.Builder to create a request.

Returns:

Result of the ListProjectPolicies operation returned by the service.

listProjectPoliciesPaginator

default ListProjectPoliciesIterable listProjectPoliciesPaginator(ListProjectPoliciesRequest listProjectPoliciesRequest)
                                                          throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ResourceNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable responses = client.listProjectPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable responses = client
             .listProjectPoliciesPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable responses = client.listProjectPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest) operation.

Parameters:

listProjectPoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

listProjectPoliciesPaginator

default ListProjectPoliciesIterable listProjectPoliciesPaginator(Consumer<ListProjectPoliciesRequest.Builder> listProjectPoliciesRequest)
                                                          throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
ResourceNotFoundException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable responses = client.listProjectPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable responses = client
             .listProjectPoliciesPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable responses = client.listProjectPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest) operation.

This is a convenience which creates an instance of the ListProjectPoliciesRequest.Builder avoiding the need to create one manually via ListProjectPoliciesRequest.builder()

Parameters:

listProjectPoliciesRequest - A Consumer that will call methods on ListProjectPoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listStreamProcessors

default ListStreamProcessorsResponse listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest)
                                                   throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

Parameters:

listStreamProcessorsRequest -

Returns:

Result of the ListStreamProcessors operation returned by the service.

listStreamProcessors

default ListStreamProcessorsResponse listStreamProcessors(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest)
                                                   throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

This is a convenience which creates an instance of the ListStreamProcessorsRequest.Builder avoiding the need to create one manually via ListStreamProcessorsRequest.builder()

Parameters:

listStreamProcessorsRequest - A Consumer that will call methods on ListStreamProcessorsRequest.Builder to create a request.

Returns:

Result of the ListStreamProcessors operation returned by the service.

listStreamProcessors

default ListStreamProcessorsResponse listStreamProcessors()
                                                   throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

Returns:

Result of the ListStreamProcessors operation returned by the service.

See Also:

• listStreamProcessors(ListStreamProcessorsRequest)

listStreamProcessorsPaginator

default ListStreamProcessorsIterable listStreamProcessorsPaginator()
                                                            throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client
             .listStreamProcessorsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listStreamProcessorsPaginator(ListStreamProcessorsRequest)

listStreamProcessorsPaginator

default ListStreamProcessorsIterable listStreamProcessorsPaginator(ListStreamProcessorsRequest listStreamProcessorsRequest)
                                                            throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client
             .listStreamProcessorsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation.

Parameters:

listStreamProcessorsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

listStreamProcessorsPaginator

default ListStreamProcessorsIterable listStreamProcessorsPaginator(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest)
                                                            throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client
             .listStreamProcessorsPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest) operation.

This is a convenience which creates an instance of the ListStreamProcessorsRequest.Builder avoiding the need to create one manually via ListStreamProcessorsRequest.builder()

Parameters:

listStreamProcessorsRequest - A Consumer that will call methods on ListStreamProcessorsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

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

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws InvalidParameterException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws InvalidParameterException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

Result of the ListUsers operation returned by the service.

listUsersPaginator

default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest)
                                      throws InvalidParameterException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest) operation.

Parameters:

listUsersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

listUsersPaginator

default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
                                      throws InvalidParameterException,
ResourceNotFoundException,
InvalidPaginationTokenException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

This is a variant of listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.rekognition.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest) operation.

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

putProjectPolicy

default PutProjectPolicyResponse putProjectPolicy(PutProjectPolicyRequest putProjectPolicyRequest)
                                           throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPolicyRevisionIdException,
MalformedPolicyDocumentException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
ThrottlingException,
ServiceQuotaExceededException,
ProvisionedThroughputExceededException,
LimitExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

You copy a model version by calling CopyProjectVersion.

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

Parameters:

putProjectPolicyRequest -

Returns:

Result of the PutProjectPolicy operation returned by the service.

putProjectPolicy

default PutProjectPolicyResponse putProjectPolicy(Consumer<PutProjectPolicyRequest.Builder> putProjectPolicyRequest)
                                           throws AccessDeniedException,
InternalServerErrorException,
InvalidParameterException,
InvalidPolicyRevisionIdException,
MalformedPolicyDocumentException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
ThrottlingException,
ServiceQuotaExceededException,
ProvisionedThroughputExceededException,
LimitExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

You copy a model version by calling CopyProjectVersion.

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

This is a convenience which creates an instance of the PutProjectPolicyRequest.Builder avoiding the need to create one manually via PutProjectPolicyRequest.builder()

Parameters:

putProjectPolicyRequest - A Consumer that will call methods on PutProjectPolicyRequest.Builder to create a request.

Returns:

Result of the PutProjectPolicy operation returned by the service.

recognizeCelebrities

default RecognizeCelebritiesResponse recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest)
                                                   throws InvalidS3ObjectException,
InvalidParameterException,
InvalidImageFormatException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.

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

Parameters:

recognizeCelebritiesRequest -

Returns:

Result of the RecognizeCelebrities operation returned by the service.

See Also:

• Code Example

recognizeCelebrities

default RecognizeCelebritiesResponse recognizeCelebrities(Consumer<RecognizeCelebritiesRequest.Builder> recognizeCelebritiesRequest)
                                                   throws InvalidS3ObjectException,
InvalidParameterException,
InvalidImageFormatException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.

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

This is a convenience which creates an instance of the RecognizeCelebritiesRequest.Builder avoiding the need to create one manually via RecognizeCelebritiesRequest.builder()

Parameters:

recognizeCelebritiesRequest - A Consumer that will call methods on RecognizeCelebritiesRequest.Builder to create a request.

Returns:

Result of the RecognizeCelebrities operation returned by the service.

See Also:

• Code Example

searchFaces

default SearchFacesResponse searchFaces(SearchFacesRequest searchFacesRequest)
                                 throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

See Also:

• Code Example

searchFaces

default SearchFacesResponse searchFaces(Consumer<SearchFacesRequest.Builder> searchFacesRequest)
                                 throws InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the SearchFacesRequest.Builder avoiding the need to create one manually via SearchFacesRequest.builder()

Parameters:

searchFacesRequest - A Consumer that will call methods on SearchFacesRequest.Builder to create a request.

Returns:

Result of the SearchFaces operation returned by the service.

See Also:

• Code Example

searchFacesByImage

default SearchFacesByImageResponse searchFacesByImage(SearchFacesByImageRequest searchFacesByImageRequest)
                                               throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

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

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

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

Parameters:

searchFacesByImageRequest -

Returns:

Result of the SearchFacesByImage operation returned by the service.

See Also:

• Code Example

searchFacesByImage

default SearchFacesByImageResponse searchFacesByImage(Consumer<SearchFacesByImageRequest.Builder> searchFacesByImageRequest)
                                               throws InvalidS3ObjectException,
InvalidParameterException,
ImageTooLargeException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
InvalidImageFormatException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

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

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

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

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

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

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

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

This is a convenience which creates an instance of the SearchFacesByImageRequest.Builder avoiding the need to create one manually via SearchFacesByImageRequest.builder()

Parameters:

searchFacesByImageRequest - A Consumer that will call methods on SearchFacesByImageRequest.Builder to create a request.

Returns:

Result of the SearchFacesByImage operation returned by the service.

See Also:

• Code Example

searchUsers

default SearchUsersResponse searchUsers(SearchUsersRequest searchUsersRequest)
                                 throws InvalidParameterException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

Parameters:

searchUsersRequest -

Returns:

Result of the SearchUsers operation returned by the service.

searchUsers

default SearchUsersResponse searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
                                 throws InvalidParameterException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

This is a convenience which creates an instance of the SearchUsersRequest.Builder avoiding the need to create one manually via SearchUsersRequest.builder()

Parameters:

searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.Builder to create a request.

Returns:

Result of the SearchUsers operation returned by the service.

searchUsersByImage

default SearchUsersByImageResponse searchUsersByImage(SearchUsersByImageRequest searchUsersByImageRequest)
                                               throws InvalidParameterException,
ResourceNotFoundException,
InvalidImageFormatException,
InvalidS3ObjectException,
ImageTooLargeException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

Parameters:

searchUsersByImageRequest -

Returns:

Result of the SearchUsersByImage operation returned by the service.

searchUsersByImage

default SearchUsersByImageResponse searchUsersByImage(Consumer<SearchUsersByImageRequest.Builder> searchUsersByImageRequest)
                                               throws InvalidParameterException,
ResourceNotFoundException,
InvalidImageFormatException,
InvalidS3ObjectException,
ImageTooLargeException,
ProvisionedThroughputExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

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

This is a convenience which creates an instance of the SearchUsersByImageRequest.Builder avoiding the need to create one manually via SearchUsersByImageRequest.builder()

Parameters:

searchUsersByImageRequest - A Consumer that will call methods on SearchUsersByImageRequest.Builder to create a request.

Returns:

Result of the SearchUsersByImage operation returned by the service.

startCelebrityRecognition

default StartCelebrityRecognitionResponse startCelebrityRecognition(StartCelebrityRecognitionRequest startCelebrityRecognitionRequest)
                                                             throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

startCelebrityRecognition

default StartCelebrityRecognitionResponse startCelebrityRecognition(Consumer<StartCelebrityRecognitionRequest.Builder> startCelebrityRecognitionRequest)
                                                             throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the StartCelebrityRecognitionRequest.Builder avoiding the need to create one manually via StartCelebrityRecognitionRequest.builder()

Parameters:

startCelebrityRecognitionRequest - A Consumer that will call methods on StartCelebrityRecognitionRequest.Builder to create a request.

Returns:

Result of the StartCelebrityRecognition operation returned by the service.

startContentModeration

default StartContentModerationResponse startContentModeration(StartContentModerationRequest startContentModerationRequest)
                                                       throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

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

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

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

Parameters:

startContentModerationRequest -

Returns:

Result of the StartContentModeration operation returned by the service.

startContentModeration

default StartContentModerationResponse startContentModeration(Consumer<StartContentModerationRequest.Builder> startContentModerationRequest)
                                                       throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

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

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

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

This is a convenience which creates an instance of the StartContentModerationRequest.Builder avoiding the need to create one manually via StartContentModerationRequest.builder()

Parameters:

startContentModerationRequest - A Consumer that will call methods on StartContentModerationRequest.Builder to create a request.

Returns:

Result of the StartContentModeration operation returned by the service.

startFaceDetection

default StartFaceDetectionResponse startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest)
                                               throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

startFaceDetection

default StartFaceDetectionResponse startFaceDetection(Consumer<StartFaceDetectionRequest.Builder> startFaceDetectionRequest)
                                               throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the StartFaceDetectionRequest.Builder avoiding the need to create one manually via StartFaceDetectionRequest.builder()

Parameters:

startFaceDetectionRequest - A Consumer that will call methods on StartFaceDetectionRequest.Builder to create a request.

Returns:

Result of the StartFaceDetection operation returned by the service.

startFaceSearch

default StartFaceSearchResponse startFaceSearch(StartFaceSearchRequest startFaceSearchRequest)
                                         throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

Parameters:

startFaceSearchRequest -

Returns:

Result of the StartFaceSearch operation returned by the service.

startFaceSearch

default StartFaceSearchResponse startFaceSearch(Consumer<StartFaceSearchRequest.Builder> startFaceSearchRequest)
                                         throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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

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

This is a convenience which creates an instance of the StartFaceSearchRequest.Builder avoiding the need to create one manually via StartFaceSearchRequest.builder()

Parameters:

startFaceSearchRequest - A Consumer that will call methods on StartFaceSearchRequest.Builder to create a request.

Returns:

Result of the StartFaceSearch operation returned by the service.

startLabelDetection

default StartLabelDetectionResponse startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest)
                                                 throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

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

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

Optional Parameters

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

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

Parameters:

startLabelDetectionRequest -

Returns:

Result of the StartLabelDetection operation returned by the service.

startLabelDetection

default StartLabelDetectionResponse startLabelDetection(Consumer<StartLabelDetectionRequest.Builder> startLabelDetectionRequest)
                                                 throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

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

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

Optional Parameters

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

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

This is a convenience which creates an instance of the StartLabelDetectionRequest.Builder avoiding the need to create one manually via StartLabelDetectionRequest.builder()

Parameters:

startLabelDetectionRequest - A Consumer that will call methods on StartLabelDetectionRequest.Builder to create a request.

Returns:

Result of the StartLabelDetection operation returned by the service.

startMediaAnalysisJob

default StartMediaAnalysisJobResponse startMediaAnalysisJob(StartMediaAnalysisJobRequest startMediaAnalysisJobRequest)
                                                     throws InternalServerErrorException,
AccessDeniedException,
InvalidParameterException,
InvalidManifestException,
InvalidS3ObjectException,
ResourceNotFoundException,
ResourceNotReadyException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
IdempotentParameterMismatchException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

Parameters:

startMediaAnalysisJobRequest -

Returns:

Result of the StartMediaAnalysisJob operation returned by the service.

startMediaAnalysisJob

default StartMediaAnalysisJobResponse startMediaAnalysisJob(Consumer<StartMediaAnalysisJobRequest.Builder> startMediaAnalysisJobRequest)
                                                     throws InternalServerErrorException,
AccessDeniedException,
InvalidParameterException,
InvalidManifestException,
InvalidS3ObjectException,
ResourceNotFoundException,
ResourceNotReadyException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
IdempotentParameterMismatchException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

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

This is a convenience which creates an instance of the StartMediaAnalysisJobRequest.Builder avoiding the need to create one manually via StartMediaAnalysisJobRequest.builder()

Parameters:

startMediaAnalysisJobRequest - A Consumer that will call methods on StartMediaAnalysisJobRequest.Builder to create a request.

Returns:

Result of the StartMediaAnalysisJob operation returned by the service.

startPersonTracking

default StartPersonTrackingResponse startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest)
                                                 throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post.

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.

startPersonTracking

default StartPersonTrackingResponse startPersonTracking(Consumer<StartPersonTrackingRequest.Builder> startPersonTrackingRequest)
                                                 throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post.

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.

This is a convenience which creates an instance of the StartPersonTrackingRequest.Builder avoiding the need to create one manually via StartPersonTrackingRequest.builder()

Parameters:

startPersonTrackingRequest - A Consumer that will call methods on StartPersonTrackingRequest.Builder to create a request.

Returns:

Result of the StartPersonTracking operation returned by the service.

startProjectVersion

default StartProjectVersionResponse startProjectVersion(StartProjectVersionRequest startProjectVersionRequest)
                                                 throws ResourceNotFoundException,
ResourceInUseException,
LimitExceededException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

Parameters:

startProjectVersionRequest -

Returns:

Result of the StartProjectVersion operation returned by the service.

startProjectVersion

default StartProjectVersionResponse startProjectVersion(Consumer<StartProjectVersionRequest.Builder> startProjectVersionRequest)
                                                 throws ResourceNotFoundException,
ResourceInUseException,
LimitExceededException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

This is a convenience which creates an instance of the StartProjectVersionRequest.Builder avoiding the need to create one manually via StartProjectVersionRequest.builder()

Parameters:

startProjectVersionRequest - A Consumer that will call methods on StartProjectVersionRequest.Builder to create a request.

Returns:

Result of the StartProjectVersion operation returned by the service.

startSegmentDetection

default StartSegmentDetectionResponse startSegmentDetection(StartSegmentDetectionRequest startSegmentDetectionRequest)
                                                     throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

startSegmentDetection

default StartSegmentDetectionResponse startSegmentDetection(Consumer<StartSegmentDetectionRequest.Builder> startSegmentDetectionRequest)
                                                     throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the StartSegmentDetectionRequest.Builder avoiding the need to create one manually via StartSegmentDetectionRequest.builder()

Parameters:

startSegmentDetectionRequest - A Consumer that will call methods on StartSegmentDetectionRequest.Builder to create a request.

Returns:

Result of the StartSegmentDetection operation returned by the service.

startStreamProcessor

default StartStreamProcessorResponse startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest)
                                                   throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ResourceInUseException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

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

Parameters:

startStreamProcessorRequest -

Returns:

Result of the StartStreamProcessor operation returned by the service.

startStreamProcessor

default StartStreamProcessorResponse startStreamProcessor(Consumer<StartStreamProcessorRequest.Builder> startStreamProcessorRequest)
                                                   throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ResourceInUseException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

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

This is a convenience which creates an instance of the StartStreamProcessorRequest.Builder avoiding the need to create one manually via StartStreamProcessorRequest.builder()

Parameters:

startStreamProcessorRequest - A Consumer that will call methods on StartStreamProcessorRequest.Builder to create a request.

Returns:

Result of the StartStreamProcessor operation returned by the service.

startTextDetection

default StartTextDetectionResponse startTextDetection(StartTextDetectionRequest startTextDetectionRequest)
                                               throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

startTextDetection

default StartTextDetectionResponse startTextDetection(Consumer<StartTextDetectionRequest.Builder> startTextDetectionRequest)
                                               throws AccessDeniedException,
IdempotentParameterMismatchException,
InvalidParameterException,
InvalidS3ObjectException,
InternalServerErrorException,
VideoTooLargeException,
ProvisionedThroughputExceededException,
LimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
RekognitionException

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.

This is a convenience which creates an instance of the StartTextDetectionRequest.Builder avoiding the need to create one manually via StartTextDetectionRequest.builder()

Parameters:

startTextDetectionRequest - A Consumer that will call methods on StartTextDetectionRequest.Builder to create a request.

Returns:

Result of the StartTextDetection operation returned by the service.

stopProjectVersion

default StopProjectVersionResponse stopProjectVersion(StopProjectVersionRequest stopProjectVersionRequest)
                                               throws ResourceNotFoundException,
ResourceInUseException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

Parameters:

stopProjectVersionRequest -

Returns:

Result of the StopProjectVersion operation returned by the service.

stopProjectVersion

default StopProjectVersionResponse stopProjectVersion(Consumer<StopProjectVersionRequest.Builder> stopProjectVersionRequest)
                                               throws ResourceNotFoundException,
ResourceInUseException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

This is a convenience which creates an instance of the StopProjectVersionRequest.Builder avoiding the need to create one manually via StopProjectVersionRequest.builder()

Parameters:

stopProjectVersionRequest - A Consumer that will call methods on StopProjectVersionRequest.Builder to create a request.

Returns:

Result of the StopProjectVersion operation returned by the service.

stopStreamProcessor

default StopStreamProcessorResponse stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ResourceInUseException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Stops a running stream processor that was created by CreateStreamProcessor.

Parameters:

stopStreamProcessorRequest -

Returns:

Result of the StopStreamProcessor operation returned by the service.

stopStreamProcessor

default StopStreamProcessorResponse stopStreamProcessor(Consumer<StopStreamProcessorRequest.Builder> stopStreamProcessorRequest)
                                                 throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ResourceInUseException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Stops a running stream processor that was created by CreateStreamProcessor.

This is a convenience which creates an instance of the StopStreamProcessorRequest.Builder avoiding the need to create one manually via StopStreamProcessorRequest.builder()

Parameters:

stopStreamProcessorRequest - A Consumer that will call methods on StopStreamProcessorRequest.Builder to create a request.

Returns:

Result of the StopStreamProcessor operation returned by the service.

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
InvalidParameterException,
ServiceQuotaExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
InvalidParameterException,
ServiceQuotaExceededException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.

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

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
AwsServiceException,
SdkClientException,
RekognitionException

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

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

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

updateDatasetEntries

default UpdateDatasetEntriesResponse updateDatasetEntries(UpdateDatasetEntriesRequest updateDatasetEntriesRequest)
                                                   throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

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

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

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

Parameters:

updateDatasetEntriesRequest -

Returns:

Result of the UpdateDatasetEntries operation returned by the service.

updateDatasetEntries

default UpdateDatasetEntriesResponse updateDatasetEntries(Consumer<UpdateDatasetEntriesRequest.Builder> updateDatasetEntriesRequest)
                                                   throws InternalServerErrorException,
ThrottlingException,
ProvisionedThroughputExceededException,
InvalidParameterException,
AccessDeniedException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RekognitionException

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

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

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

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

This is a convenience which creates an instance of the UpdateDatasetEntriesRequest.Builder avoiding the need to create one manually via UpdateDatasetEntriesRequest.builder()

Parameters:

updateDatasetEntriesRequest - A Consumer that will call methods on UpdateDatasetEntriesRequest.Builder to create a request.

Returns:

Result of the UpdateDatasetEntries operation returned by the service.

updateStreamProcessor

default UpdateStreamProcessorResponse updateStreamProcessor(UpdateStreamProcessorRequest updateStreamProcessorRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.

Parameters:

updateStreamProcessorRequest -

Returns:

Result of the UpdateStreamProcessor operation returned by the service.

updateStreamProcessor

default UpdateStreamProcessorResponse updateStreamProcessor(Consumer<UpdateStreamProcessorRequest.Builder> updateStreamProcessorRequest)
                                                     throws AccessDeniedException,
InternalServerErrorException,
ThrottlingException,
InvalidParameterException,
ResourceNotFoundException,
ProvisionedThroughputExceededException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
RekognitionException

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.

This is a convenience which creates an instance of the UpdateStreamProcessorRequest.Builder avoiding the need to create one manually via UpdateStreamProcessorRequest.builder()

Parameters:

updateStreamProcessorRequest - A Consumer that will call methods on UpdateStreamProcessorRequest.Builder to create a request.

Returns:

Result of the UpdateStreamProcessor operation returned by the service.

waiter

default RekognitionWaiter waiter()

Create an instance of RekognitionWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of RekognitionWaiter

create

static RekognitionClient create()

Create a RekognitionClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static RekognitionClientBuilder builder()

Create a builder that can be used to configure and create a RekognitionClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default RekognitionServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration