software.amazon.awssdk.services.rekognition.RekognitionClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rekognition;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.rekognition.model.AccessDeniedException;
import software.amazon.awssdk.services.rekognition.model.AssociateFacesRequest;
import software.amazon.awssdk.services.rekognition.model.AssociateFacesResponse;
import software.amazon.awssdk.services.rekognition.model.CompareFacesRequest;
import software.amazon.awssdk.services.rekognition.model.CompareFacesResponse;
import software.amazon.awssdk.services.rekognition.model.ConflictException;
import software.amazon.awssdk.services.rekognition.model.CopyProjectVersionRequest;
import software.amazon.awssdk.services.rekognition.model.CopyProjectVersionResponse;
import software.amazon.awssdk.services.rekognition.model.CreateCollectionRequest;
import software.amazon.awssdk.services.rekognition.model.CreateCollectionResponse;
import software.amazon.awssdk.services.rekognition.model.CreateDatasetRequest;
import software.amazon.awssdk.services.rekognition.model.CreateDatasetResponse;
import software.amazon.awssdk.services.rekognition.model.CreateFaceLivenessSessionRequest;
import software.amazon.awssdk.services.rekognition.model.CreateFaceLivenessSessionResponse;
import software.amazon.awssdk.services.rekognition.model.CreateProjectRequest;
import software.amazon.awssdk.services.rekognition.model.CreateProjectResponse;
import software.amazon.awssdk.services.rekognition.model.CreateProjectVersionRequest;
import software.amazon.awssdk.services.rekognition.model.CreateProjectVersionResponse;
import software.amazon.awssdk.services.rekognition.model.CreateStreamProcessorRequest;
import software.amazon.awssdk.services.rekognition.model.CreateStreamProcessorResponse;
import software.amazon.awssdk.services.rekognition.model.CreateUserRequest;
import software.amazon.awssdk.services.rekognition.model.CreateUserResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteCollectionRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteCollectionResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteDatasetRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteDatasetResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteFacesRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteFacesResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteProjectPolicyRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteProjectPolicyResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteProjectRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteProjectResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteProjectVersionRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteProjectVersionResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteStreamProcessorRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteStreamProcessorResponse;
import software.amazon.awssdk.services.rekognition.model.DeleteUserRequest;
import software.amazon.awssdk.services.rekognition.model.DeleteUserResponse;
import software.amazon.awssdk.services.rekognition.model.DescribeCollectionRequest;
import software.amazon.awssdk.services.rekognition.model.DescribeCollectionResponse;
import software.amazon.awssdk.services.rekognition.model.DescribeDatasetRequest;
import software.amazon.awssdk.services.rekognition.model.DescribeDatasetResponse;
import software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest;
import software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsResponse;
import software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest;
import software.amazon.awssdk.services.rekognition.model.DescribeProjectsResponse;
import software.amazon.awssdk.services.rekognition.model.DescribeStreamProcessorRequest;
import software.amazon.awssdk.services.rekognition.model.DescribeStreamProcessorResponse;
import software.amazon.awssdk.services.rekognition.model.DetectCustomLabelsRequest;
import software.amazon.awssdk.services.rekognition.model.DetectCustomLabelsResponse;
import software.amazon.awssdk.services.rekognition.model.DetectFacesRequest;
import software.amazon.awssdk.services.rekognition.model.DetectFacesResponse;
import software.amazon.awssdk.services.rekognition.model.DetectLabelsRequest;
import software.amazon.awssdk.services.rekognition.model.DetectLabelsResponse;
import software.amazon.awssdk.services.rekognition.model.DetectModerationLabelsRequest;
import software.amazon.awssdk.services.rekognition.model.DetectModerationLabelsResponse;
import software.amazon.awssdk.services.rekognition.model.DetectProtectiveEquipmentRequest;
import software.amazon.awssdk.services.rekognition.model.DetectProtectiveEquipmentResponse;
import software.amazon.awssdk.services.rekognition.model.DetectTextRequest;
import software.amazon.awssdk.services.rekognition.model.DetectTextResponse;
import software.amazon.awssdk.services.rekognition.model.DisassociateFacesRequest;
import software.amazon.awssdk.services.rekognition.model.DisassociateFacesResponse;
import software.amazon.awssdk.services.rekognition.model.DistributeDatasetEntriesRequest;
import software.amazon.awssdk.services.rekognition.model.DistributeDatasetEntriesResponse;
import software.amazon.awssdk.services.rekognition.model.GetCelebrityInfoRequest;
import software.amazon.awssdk.services.rekognition.model.GetCelebrityInfoResponse;
import software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest;
import software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionResponse;
import software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest;
import software.amazon.awssdk.services.rekognition.model.GetContentModerationResponse;
import software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.GetFaceDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.GetFaceLivenessSessionResultsRequest;
import software.amazon.awssdk.services.rekognition.model.GetFaceLivenessSessionResultsResponse;
import software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest;
import software.amazon.awssdk.services.rekognition.model.GetFaceSearchResponse;
import software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.GetLabelDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest;
import software.amazon.awssdk.services.rekognition.model.GetPersonTrackingResponse;
import software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.GetTextDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.HumanLoopQuotaExceededException;
import software.amazon.awssdk.services.rekognition.model.IdempotentParameterMismatchException;
import software.amazon.awssdk.services.rekognition.model.ImageTooLargeException;
import software.amazon.awssdk.services.rekognition.model.IndexFacesRequest;
import software.amazon.awssdk.services.rekognition.model.IndexFacesResponse;
import software.amazon.awssdk.services.rekognition.model.InternalServerErrorException;
import software.amazon.awssdk.services.rekognition.model.InvalidImageFormatException;
import software.amazon.awssdk.services.rekognition.model.InvalidPaginationTokenException;
import software.amazon.awssdk.services.rekognition.model.InvalidParameterException;
import software.amazon.awssdk.services.rekognition.model.InvalidPolicyRevisionIdException;
import software.amazon.awssdk.services.rekognition.model.InvalidS3ObjectException;
import software.amazon.awssdk.services.rekognition.model.LimitExceededException;
import software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest;
import software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse;
import software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest;
import software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesResponse;
import software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest;
import software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsResponse;
import software.amazon.awssdk.services.rekognition.model.ListFacesRequest;
import software.amazon.awssdk.services.rekognition.model.ListFacesResponse;
import software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest;
import software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesResponse;
import software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest;
import software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse;
import software.amazon.awssdk.services.rekognition.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.rekognition.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.rekognition.model.ListUsersRequest;
import software.amazon.awssdk.services.rekognition.model.ListUsersResponse;
import software.amazon.awssdk.services.rekognition.model.MalformedPolicyDocumentException;
import software.amazon.awssdk.services.rekognition.model.ProvisionedThroughputExceededException;
import software.amazon.awssdk.services.rekognition.model.PutProjectPolicyRequest;
import software.amazon.awssdk.services.rekognition.model.PutProjectPolicyResponse;
import software.amazon.awssdk.services.rekognition.model.RecognizeCelebritiesRequest;
import software.amazon.awssdk.services.rekognition.model.RecognizeCelebritiesResponse;
import software.amazon.awssdk.services.rekognition.model.RekognitionException;
import software.amazon.awssdk.services.rekognition.model.ResourceAlreadyExistsException;
import software.amazon.awssdk.services.rekognition.model.ResourceInUseException;
import software.amazon.awssdk.services.rekognition.model.ResourceNotFoundException;
import software.amazon.awssdk.services.rekognition.model.ResourceNotReadyException;
import software.amazon.awssdk.services.rekognition.model.SearchFacesByImageRequest;
import software.amazon.awssdk.services.rekognition.model.SearchFacesByImageResponse;
import software.amazon.awssdk.services.rekognition.model.SearchFacesRequest;
import software.amazon.awssdk.services.rekognition.model.SearchFacesResponse;
import software.amazon.awssdk.services.rekognition.model.SearchUsersByImageRequest;
import software.amazon.awssdk.services.rekognition.model.SearchUsersByImageResponse;
import software.amazon.awssdk.services.rekognition.model.SearchUsersRequest;
import software.amazon.awssdk.services.rekognition.model.SearchUsersResponse;
import software.amazon.awssdk.services.rekognition.model.ServiceQuotaExceededException;
import software.amazon.awssdk.services.rekognition.model.SessionNotFoundException;
import software.amazon.awssdk.services.rekognition.model.StartCelebrityRecognitionRequest;
import software.amazon.awssdk.services.rekognition.model.StartCelebrityRecognitionResponse;
import software.amazon.awssdk.services.rekognition.model.StartContentModerationRequest;
import software.amazon.awssdk.services.rekognition.model.StartContentModerationResponse;
import software.amazon.awssdk.services.rekognition.model.StartFaceDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.StartFaceDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.StartFaceSearchRequest;
import software.amazon.awssdk.services.rekognition.model.StartFaceSearchResponse;
import software.amazon.awssdk.services.rekognition.model.StartLabelDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.StartLabelDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.StartPersonTrackingRequest;
import software.amazon.awssdk.services.rekognition.model.StartPersonTrackingResponse;
import software.amazon.awssdk.services.rekognition.model.StartProjectVersionRequest;
import software.amazon.awssdk.services.rekognition.model.StartProjectVersionResponse;
import software.amazon.awssdk.services.rekognition.model.StartSegmentDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.StartSegmentDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.StartStreamProcessorRequest;
import software.amazon.awssdk.services.rekognition.model.StartStreamProcessorResponse;
import software.amazon.awssdk.services.rekognition.model.StartTextDetectionRequest;
import software.amazon.awssdk.services.rekognition.model.StartTextDetectionResponse;
import software.amazon.awssdk.services.rekognition.model.StopProjectVersionRequest;
import software.amazon.awssdk.services.rekognition.model.StopProjectVersionResponse;
import software.amazon.awssdk.services.rekognition.model.StopStreamProcessorRequest;
import software.amazon.awssdk.services.rekognition.model.StopStreamProcessorResponse;
import software.amazon.awssdk.services.rekognition.model.TagResourceRequest;
import software.amazon.awssdk.services.rekognition.model.TagResourceResponse;
import software.amazon.awssdk.services.rekognition.model.ThrottlingException;
import software.amazon.awssdk.services.rekognition.model.UntagResourceRequest;
import software.amazon.awssdk.services.rekognition.model.UntagResourceResponse;
import software.amazon.awssdk.services.rekognition.model.UpdateDatasetEntriesRequest;
import software.amazon.awssdk.services.rekognition.model.UpdateDatasetEntriesResponse;
import software.amazon.awssdk.services.rekognition.model.UpdateStreamProcessorRequest;
import software.amazon.awssdk.services.rekognition.model.UpdateStreamProcessorResponse;
import software.amazon.awssdk.services.rekognition.model.VideoTooLargeException;
import software.amazon.awssdk.services.rekognition.paginators.DescribeProjectVersionsIterable;
import software.amazon.awssdk.services.rekognition.paginators.DescribeProjectsIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetSegmentDetectionIterable;
import software.amazon.awssdk.services.rekognition.paginators.GetTextDetectionIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListDatasetEntriesIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListDatasetLabelsIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListProjectPoliciesIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable;
import software.amazon.awssdk.services.rekognition.paginators.ListUsersIterable;
import software.amazon.awssdk.services.rekognition.waiters.RekognitionWaiter;
/**
* Service client for accessing Amazon Rekognition. This can be created using the static {@link #builder()} method.
*
*
* This is the API Reference for Amazon
* Rekognition Image, Amazon
* Rekognition Custom Labels, Amazon
* Rekognition Stored Video, Amazon
* Rekognition Streaming Video. It provides descriptions of actions, data types, common parameters, and common
* errors.
*
*
* Amazon Rekognition Image
*
*
* -
*
* AssociateFaces
*
*
* -
*
* CompareFaces
*
*
* -
*
* CreateCollection
*
*
* -
*
* CreateUser
*
*
* -
*
* DeleteCollection
*
*
* -
*
* DeleteFaces
*
*
* -
*
* DeleteUser
*
*
* -
*
*
* -
*
* DetectFaces
*
*
* -
*
* DetectLabels
*
*
* -
*
*
* -
*
*
* -
*
* DetectText
*
*
* -
*
*
* -
*
* GetCelebrityInfo
*
*
* -
*
* IndexFaces
*
*
* -
*
* ListCollections
*
*
* -
*
* ListFaces
*
*
* -
*
* ListUsers
*
*
* -
*
*
* -
*
* SearchFaces
*
*
* -
*
*
* -
*
* SearchUsers
*
*
* -
*
*
*
*
* Amazon Rekognition Custom Labels
*
*
* -
*
*
* -
*
* CreateDataset
*
*
* -
*
* CreateProject
*
*
* -
*
*
* -
*
* DeleteDataset
*
*
* -
*
* DeleteProject
*
*
* -
*
*
* -
*
*
* -
*
* DescribeDataset
*
*
* -
*
* DescribeProjects
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
* PutProjectPolicy
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* Amazon Rekognition Video Stored Video
*
*
* -
*
*
* -
*
*
* -
*
* GetFaceDetection
*
*
* -
*
* GetFaceSearch
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
* GetTextDetection
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
* StartFaceSearch
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* Amazon Rekognition Video Streaming Video
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface RekognitionClient extends AwsClient {
String SERVICE_NAME = "rekognition";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "rekognition";
/**
*
* Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each
* FaceId that are present in the FaceIds list is associated with the provided UserID. The
* maximum number of total FaceIds per UserID is 100.
*
*
* The UserMatchThreshold parameter specifies the minimum user match confidence required for the face
* to be associated with a UserID that has at least one FaceID already associated. This ensures that
* the FaceIds are associated with the right UserID. The value ranges from 0-100 and default value is
* 75.
*
*
* If successful, an array of AssociatedFace objects containing the associated FaceIds is
* returned. If a given face is already associated with the given UserID, it will be ignored and will
* not be returned in the response. If a given face is already associated to a different UserID, isn't
* found in the collection, doesn’t meet the UserMatchThreshold, or there are already 100 faces
* associated with the UserID, it will be returned as part of an array of
* UnsuccessfulFaceAssociations.
*
*
* The UserStatus reflects the status of an operation which updates a UserID representation with a list
* of given faces. The UserStatus can be:
*
*
* -
*
* ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.
*
*
* -
*
* CREATED - A UserID has been created, but has no FaceID(s) associated with it.
*
*
* -
*
* UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking
* place.
*
*
*
*
* @param associateFacesRequest
* @return Result of the AssociateFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.AssociateFaces
*/
default AssociateFacesResponse associateFaces(AssociateFacesRequest associateFacesRequest) throws InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
IdempotentParameterMismatchException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each
* FaceId that are present in the FaceIds list is associated with the provided UserID. The
* maximum number of total FaceIds per UserID is 100.
*
*
* The UserMatchThreshold parameter specifies the minimum user match confidence required for the face
* to be associated with a UserID that has at least one FaceID already associated. This ensures that
* the FaceIds are associated with the right UserID. The value ranges from 0-100 and default value is
* 75.
*
*
* If successful, an array of AssociatedFace objects containing the associated FaceIds is
* returned. If a given face is already associated with the given UserID, it will be ignored and will
* not be returned in the response. If a given face is already associated to a different UserID, isn't
* found in the collection, doesn’t meet the UserMatchThreshold, or there are already 100 faces
* associated with the UserID, it will be returned as part of an array of
* UnsuccessfulFaceAssociations.
*
*
* The UserStatus reflects the status of an operation which updates a UserID representation with a list
* of given faces. The UserStatus can be:
*
*
* -
*
* ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.
*
*
* -
*
* CREATED - A UserID has been created, but has no FaceID(s) associated with it.
*
*
* -
*
* UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking
* place.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link AssociateFacesRequest.Builder} avoiding the need to
* create one manually via {@link AssociateFacesRequest#builder()}
*
*
* @param associateFacesRequest
* A {@link Consumer} that will call methods on {@link AssociateFacesRequest.Builder} to create a request.
* @return Result of the AssociateFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.AssociateFaces
*/
default AssociateFacesResponse associateFaces(Consumer associateFacesRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, IdempotentParameterMismatchException, ResourceNotFoundException,
ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
return associateFaces(AssociateFacesRequest.builder().applyMutation(associateFacesRequest).build());
}
/**
*
* 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.
*
*
* @param compareFacesRequest
* @return Result of the CompareFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CompareFaces
*/
default CompareFacesResponse compareFaces(CompareFacesRequest compareFacesRequest) throws InvalidParameterException,
InvalidS3ObjectException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CompareFacesRequest.Builder} avoiding the need to
* create one manually via {@link CompareFacesRequest#builder()}
*
*
* @param compareFacesRequest
* A {@link Consumer} that will call methods on {@link CompareFacesRequest.Builder} to create a request.
* @return Result of the CompareFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CompareFaces
*/
default CompareFacesResponse compareFaces(Consumer compareFacesRequest)
throws InvalidParameterException, InvalidS3ObjectException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException {
return compareFaces(CompareFacesRequest.builder().applyMutation(compareFacesRequest).build());
}
/**
*
* 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.
*
*
*
* 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.
*
*
* @param copyProjectVersionRequest
* @return Result of the CopyProjectVersion operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CopyProjectVersion
*/
default CopyProjectVersionResponse copyProjectVersion(CopyProjectVersionRequest copyProjectVersionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, LimitExceededException,
ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException,
ProvisionedThroughputExceededException, ResourceInUseException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* 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 {@link CopyProjectVersionRequest.Builder} avoiding the
* need to create one manually via {@link CopyProjectVersionRequest#builder()}
*
*
* @param copyProjectVersionRequest
* A {@link Consumer} that will call methods on {@link CopyProjectVersionRequest.Builder} to create a
* request.
* @return Result of the CopyProjectVersion operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CopyProjectVersion
*/
default CopyProjectVersionResponse copyProjectVersion(Consumer copyProjectVersionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, LimitExceededException,
ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException,
ProvisionedThroughputExceededException, ResourceInUseException, AwsServiceException, SdkClientException,
RekognitionException {
return copyProjectVersion(CopyProjectVersionRequest.builder().applyMutation(copyProjectVersionRequest).build());
}
/**
*
* 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.
*
*
* @param createCollectionRequest
* @return Result of the CreateCollection operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceAlreadyExistsException
* A resource with the specified ID already exists.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateCollection
*/
default CreateCollectionResponse createCollection(CreateCollectionRequest createCollectionRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceAlreadyExistsException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateCollectionRequest.Builder} avoiding the need
* to create one manually via {@link CreateCollectionRequest#builder()}
*
*
* @param createCollectionRequest
* A {@link Consumer} that will call methods on {@link CreateCollectionRequest.Builder} to create a request.
* @return Result of the CreateCollection operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceAlreadyExistsException
* A resource with the specified ID already exists.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateCollection
*/
default CreateCollectionResponse createCollection(Consumer createCollectionRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceAlreadyExistsException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, RekognitionException {
return createCollection(CreateCollectionRequest.builder().applyMutation(createCollectionRequest).build());
}
/**
*
* 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.
*
*
* @param createDatasetRequest
* @return Result of the CreateDataset operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws ResourceAlreadyExistsException
* A resource with the specified ID already exists.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateDataset
*/
default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest) throws InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidParameterException, AccessDeniedException,
LimitExceededException, InvalidS3ObjectException, ResourceAlreadyExistsException, ResourceNotFoundException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDatasetRequest.Builder} avoiding the need to
* create one manually via {@link CreateDatasetRequest#builder()}
*
*
* @param createDatasetRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetRequest.Builder} to create a request.
* @return Result of the CreateDataset operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws ResourceAlreadyExistsException
* A resource with the specified ID already exists.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateDataset
*/
default CreateDatasetResponse createDataset(Consumer createDatasetRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, LimitExceededException, InvalidS3ObjectException,
ResourceAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return createDataset(CreateDatasetRequest.builder().applyMutation(createDatasetRequest).build());
}
/**
*
* 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. You can use AuditImagesLimit to limit the number of
* audit images returned. 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.
*
*
* @param createFaceLivenessSessionRequest
* @return Result of the CreateFaceLivenessSession operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateFaceLivenessSession
*/
default CreateFaceLivenessSessionResponse createFaceLivenessSession(
CreateFaceLivenessSessionRequest createFaceLivenessSessionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, ThrottlingException, ProvisionedThroughputExceededException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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. You can use AuditImagesLimit to limit the number of
* audit images returned. 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.
*
*
*
* This is a convenience which creates an instance of the {@link CreateFaceLivenessSessionRequest.Builder} avoiding
* the need to create one manually via {@link CreateFaceLivenessSessionRequest#builder()}
*
*
* @param createFaceLivenessSessionRequest
* A {@link Consumer} that will call methods on {@link CreateFaceLivenessSessionRequest.Builder} to create a
* request.
* @return Result of the CreateFaceLivenessSession operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateFaceLivenessSession
*/
default CreateFaceLivenessSessionResponse createFaceLivenessSession(
Consumer createFaceLivenessSessionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, ThrottlingException, ProvisionedThroughputExceededException,
AwsServiceException, SdkClientException, RekognitionException {
return createFaceLivenessSession(CreateFaceLivenessSessionRequest.builder()
.applyMutation(createFaceLivenessSessionRequest).build());
}
/**
*
* Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model
* versions) that you use to create and manage Amazon Rekognition Custom Labels models.
*
*
* This operation requires permissions to perform the rekognition:CreateProject action.
*
*
* @param createProjectRequest
* @return Result of the CreateProject operation returned by the service.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateProject
*/
default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws ResourceInUseException,
LimitExceededException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model
* versions) that you use to create and manage Amazon Rekognition Custom Labels models.
*
*
* This operation requires permissions to perform the rekognition:CreateProject action.
*
*
*
* This is a convenience which creates an instance of the {@link CreateProjectRequest.Builder} avoiding the need to
* create one manually via {@link CreateProjectRequest#builder()}
*
*
* @param createProjectRequest
* A {@link Consumer} that will call methods on {@link CreateProjectRequest.Builder} to create a request.
* @return Result of the CreateProject operation returned by the service.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateProject
*/
default CreateProjectResponse createProject(Consumer createProjectRequest)
throws ResourceInUseException, LimitExceededException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return createProject(CreateProjectRequest.builder().applyMutation(createProjectRequest).build());
}
/**
*
* Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom
* Labels project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the
* version of the model.
*
*
* Training uses the training and test datasets associated with the project. For more information, see Creating
* training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.
*
*
*
* 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.
*
*
*
* Training takes 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.
*
*
* If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer
* guide.
*
*
* Once training has successfully completed, call DescribeProjectVersions to get the training results and
* evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the
* Amazon Rekognition Custom Labels developers guide.
*
*
* After evaluating the model, you start the model by calling StartProjectVersion.
*
*
* This operation requires permissions to perform the rekognition:CreateProjectVersion action.
*
*
* @param createProjectVersionRequest
* @return Result of the CreateProjectVersion operation returned by the service.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateProjectVersion
*/
default CreateProjectVersionResponse createProjectVersion(CreateProjectVersionRequest createProjectVersionRequest)
throws ResourceInUseException, ResourceNotFoundException, LimitExceededException, InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom
* Labels project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the
* version of the model.
*
*
* Training uses the training and test datasets associated with the project. For more information, see Creating
* training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.
*
*
*
* 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.
*
*
*
* Training takes 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.
*
*
* If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer
* guide.
*
*
* Once training has successfully completed, call DescribeProjectVersions to get the training results and
* evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the
* Amazon Rekognition Custom Labels developers guide.
*
*
* After evaluating the model, you start the model by calling StartProjectVersion.
*
*
* This operation requires permissions to perform the rekognition:CreateProjectVersion action.
*
*
*
* This is a convenience which creates an instance of the {@link CreateProjectVersionRequest.Builder} avoiding the
* need to create one manually via {@link CreateProjectVersionRequest#builder()}
*
*
* @param createProjectVersionRequest
* A {@link Consumer} that will call methods on {@link CreateProjectVersionRequest.Builder} to create a
* request.
* @return Result of the CreateProjectVersion operation returned by the service.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateProjectVersion
*/
default CreateProjectVersionResponse createProjectVersion(
Consumer createProjectVersionRequest) throws ResourceInUseException,
ResourceNotFoundException, LimitExceededException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
return createProjectVersion(CreateProjectVersionRequest.builder().applyMutation(createProjectVersionRequest).build());
}
/**
*
* 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.
*
*
* @param createStreamProcessorRequest
* @return Result of the CreateStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateStreamProcessor
*/
default CreateStreamProcessorResponse createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
LimitExceededException, ResourceInUseException, ProvisionedThroughputExceededException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateStreamProcessorRequest.Builder} avoiding the
* need to create one manually via {@link CreateStreamProcessorRequest#builder()}
*
*
* @param createStreamProcessorRequest
* A {@link Consumer} that will call methods on {@link CreateStreamProcessorRequest.Builder} to create a
* request.
* @return Result of the CreateStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateStreamProcessor
*/
default CreateStreamProcessorResponse createStreamProcessor(
Consumer createStreamProcessorRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, LimitExceededException,
ResourceInUseException, ProvisionedThroughputExceededException, ServiceQuotaExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return createStreamProcessor(CreateStreamProcessorRequest.builder().applyMutation(createStreamProcessorRequest).build());
}
/**
*
* 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.
*
*
* @param createUserRequest
* @return Result of the CreateUser operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateUser
*/
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws InvalidParameterException,
ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, ProvisionedThroughputExceededException,
IdempotentParameterMismatchException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateUserRequest.Builder} avoiding the need to
* create one manually via {@link CreateUserRequest#builder()}
*
*
* @param createUserRequest
* A {@link Consumer} that will call methods on {@link CreateUserRequest.Builder} to create a request.
* @return Result of the CreateUser operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.CreateUser
*/
default CreateUserResponse createUser(Consumer createUserRequest)
throws InvalidParameterException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException,
ProvisionedThroughputExceededException, IdempotentParameterMismatchException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return createUser(CreateUserRequest.builder().applyMutation(createUserRequest).build());
}
/**
*
* 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.
*
*
* @param deleteCollectionRequest
* @return Result of the DeleteCollection operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteCollection
*/
default DeleteCollectionResponse deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteCollectionRequest.Builder} avoiding the need
* to create one manually via {@link DeleteCollectionRequest#builder()}
*
*
* @param deleteCollectionRequest
* A {@link Consumer} that will call methods on {@link DeleteCollectionRequest.Builder} to create a request.
* @return Result of the DeleteCollection operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteCollection
*/
default DeleteCollectionResponse deleteCollection(Consumer deleteCollectionRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return deleteCollection(DeleteCollectionRequest.builder().applyMutation(deleteCollectionRequest).build());
}
/**
*
* 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.
*
*
* @param deleteDatasetRequest
* @return Result of the DeleteDataset operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteDataset
*/
default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidParameterException, AccessDeniedException,
LimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDatasetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDatasetRequest#builder()}
*
*
* @param deleteDatasetRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetRequest.Builder} to create a request.
* @return Result of the DeleteDataset operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteDataset
*/
default DeleteDatasetResponse deleteDataset(Consumer deleteDatasetRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, LimitExceededException, ResourceInUseException,
ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException {
return deleteDataset(DeleteDatasetRequest.builder().applyMutation(deleteDatasetRequest).build());
}
/**
*
* 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.
*
*
* @param deleteFacesRequest
* @return Result of the DeleteFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteFaces
*/
default DeleteFacesResponse deleteFaces(DeleteFacesRequest deleteFacesRequest) throws InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteFacesRequest.Builder} avoiding the need to
* create one manually via {@link DeleteFacesRequest#builder()}
*
*
* @param deleteFacesRequest
* A {@link Consumer} that will call methods on {@link DeleteFacesRequest.Builder} to create a request.
* @return Result of the DeleteFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteFaces
*/
default DeleteFacesResponse deleteFaces(Consumer deleteFacesRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return deleteFaces(DeleteFacesRequest.builder().applyMutation(deleteFacesRequest).build());
}
/**
*
* Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models
* associated with the project. To delete a model, see DeleteProjectVersion.
*
*
* 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.
*
*
* @param deleteProjectRequest
* @return Result of the DeleteProject operation returned by the service.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteProject
*/
default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws ResourceInUseException,
ResourceNotFoundException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models
* associated with the project. To delete a model, see DeleteProjectVersion.
*
*
* 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 {@link DeleteProjectRequest.Builder} avoiding the need to
* create one manually via {@link DeleteProjectRequest#builder()}
*
*
* @param deleteProjectRequest
* A {@link Consumer} that will call methods on {@link DeleteProjectRequest.Builder} to create a request.
* @return Result of the DeleteProject operation returned by the service.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteProject
*/
default DeleteProjectResponse deleteProject(Consumer deleteProjectRequest)
throws ResourceInUseException, ResourceNotFoundException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return deleteProject(DeleteProjectRequest.builder().applyMutation(deleteProjectRequest).build());
}
/**
*
* 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.
*
*
* @param deleteProjectPolicyRequest
* @return Result of the DeleteProjectPolicy operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPolicyRevisionIdException
* The supplied revision id for the project policy is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteProjectPolicy
*/
default DeleteProjectPolicyResponse deleteProjectPolicy(DeleteProjectPolicyRequest deleteProjectPolicyRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, ResourceNotFoundException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidPolicyRevisionIdException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteProjectPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteProjectPolicyRequest#builder()}
*
*
* @param deleteProjectPolicyRequest
* A {@link Consumer} that will call methods on {@link DeleteProjectPolicyRequest.Builder} to create a
* request.
* @return Result of the DeleteProjectPolicy operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPolicyRevisionIdException
* The supplied revision id for the project policy is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteProjectPolicy
*/
default DeleteProjectPolicyResponse deleteProjectPolicy(
Consumer deleteProjectPolicyRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, ResourceNotFoundException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPolicyRevisionIdException, AwsServiceException, SdkClientException,
RekognitionException {
return deleteProjectPolicy(DeleteProjectPolicyRequest.builder().applyMutation(deleteProjectPolicyRequest).build());
}
/**
*
* Deletes an Amazon Rekognition Custom Labels model.
*
*
* You can't delete a model if it is running or if it is training. To check the status of a model, use the
* Status field returned from DescribeProjectVersions. To stop a running model call
* StopProjectVersion. If the model is training, wait until it finishes.
*
*
* This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
*
*
* @param deleteProjectVersionRequest
* @return Result of the DeleteProjectVersion operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteProjectVersion
*/
default DeleteProjectVersionResponse deleteProjectVersion(DeleteProjectVersionRequest deleteProjectVersionRequest)
throws ResourceNotFoundException, ResourceInUseException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Amazon Rekognition Custom Labels model.
*
*
* You can't delete a model if it is running or if it is training. To check the status of a model, use the
* Status field returned from DescribeProjectVersions. To stop a running model call
* StopProjectVersion. If the model is training, wait until it finishes.
*
*
* This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteProjectVersionRequest.Builder} avoiding the
* need to create one manually via {@link DeleteProjectVersionRequest#builder()}
*
*
* @param deleteProjectVersionRequest
* A {@link Consumer} that will call methods on {@link DeleteProjectVersionRequest.Builder} to create a
* request.
* @return Result of the DeleteProjectVersion operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteProjectVersion
*/
default DeleteProjectVersionResponse deleteProjectVersion(
Consumer deleteProjectVersionRequest) throws ResourceNotFoundException,
ResourceInUseException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return deleteProjectVersion(DeleteProjectVersionRequest.builder().applyMutation(deleteProjectVersionRequest).build());
}
/**
*
* 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.
*
*
* @param deleteStreamProcessorRequest
* @return Result of the DeleteStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteStreamProcessor
*/
default DeleteStreamProcessorResponse deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteStreamProcessorRequest.Builder} avoiding the
* need to create one manually via {@link DeleteStreamProcessorRequest#builder()}
*
*
* @param deleteStreamProcessorRequest
* A {@link Consumer} that will call methods on {@link DeleteStreamProcessorRequest.Builder} to create a
* request.
* @return Result of the DeleteStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteStreamProcessor
*/
default DeleteStreamProcessorResponse deleteStreamProcessor(
Consumer deleteStreamProcessorRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException,
ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return deleteStreamProcessor(DeleteStreamProcessorRequest.builder().applyMutation(deleteStreamProcessorRequest).build());
}
/**
*
* 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.
*
*
* @param deleteUserRequest
* @return Result of the DeleteUser operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteUser
*/
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws InvalidParameterException,
ConflictException, ResourceNotFoundException, ProvisionedThroughputExceededException,
IdempotentParameterMismatchException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteUserRequest.Builder} avoiding the need to
* create one manually via {@link DeleteUserRequest#builder()}
*
*
* @param deleteUserRequest
* A {@link Consumer} that will call methods on {@link DeleteUserRequest.Builder} to create a request.
* @return Result of the DeleteUser operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DeleteUser
*/
default DeleteUserResponse deleteUser(Consumer deleteUserRequest)
throws InvalidParameterException, ConflictException, ResourceNotFoundException,
ProvisionedThroughputExceededException, IdempotentParameterMismatchException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return deleteUser(DeleteUserRequest.builder().applyMutation(deleteUserRequest).build());
}
/**
*
* 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.
*
*
* @param describeCollectionRequest
* @return Result of the DescribeCollection operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeCollection
*/
default DescribeCollectionResponse describeCollection(DescribeCollectionRequest describeCollectionRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeCollectionRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCollectionRequest#builder()}
*
*
* @param describeCollectionRequest
* A {@link Consumer} that will call methods on {@link DescribeCollectionRequest.Builder} to create a
* request.
* @return Result of the DescribeCollection operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeCollection
*/
default DescribeCollectionResponse describeCollection(Consumer describeCollectionRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return describeCollection(DescribeCollectionRequest.builder().applyMutation(describeCollectionRequest).build());
}
/**
*
* 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.
*
*
* @param describeDatasetRequest
* @return Result of the DescribeDataset operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeDataset
*/
default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDatasetRequest.Builder} avoiding the need
* to create one manually via {@link DescribeDatasetRequest#builder()}
*
*
* @param describeDatasetRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetRequest.Builder} to create a request.
* @return Result of the DescribeDataset operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeDataset
*/
default DescribeDatasetResponse describeDataset(Consumer describeDatasetRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return describeDataset(DescribeDatasetRequest.builder().applyMutation(describeDatasetRequest).build());
}
/**
*
* Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to
* 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model
* versions in the project are returned.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
*
*
* @param describeProjectVersionsRequest
* @return Result of the DescribeProjectVersions operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjectVersions
*/
default DescribeProjectVersionsResponse describeProjectVersions(DescribeProjectVersionsRequest describeProjectVersionsRequest)
throws ResourceNotFoundException, InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to
* 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model
* 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 {@link DescribeProjectVersionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeProjectVersionsRequest#builder()}
*
*
* @param describeProjectVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeProjectVersionsRequest.Builder} to create a
* request.
* @return Result of the DescribeProjectVersions operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjectVersions
*/
default DescribeProjectVersionsResponse describeProjectVersions(
Consumer describeProjectVersionsRequest) throws ResourceNotFoundException,
InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return describeProjectVersions(DescribeProjectVersionsRequest.builder().applyMutation(describeProjectVersionsRequest)
.build());
}
/**
*
* Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to
* 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model
* versions in the project are returned.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest)}
* operation.
*
*
* @param describeProjectVersionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjectVersions
*/
default DescribeProjectVersionsIterable describeProjectVersionsPaginator(
DescribeProjectVersionsRequest describeProjectVersionsRequest) throws ResourceNotFoundException,
InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return new DescribeProjectVersionsIterable(this, describeProjectVersionsRequest);
}
/**
*
* Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to
* 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model
* versions in the project are returned.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeProjectVersionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeProjectVersionsRequest#builder()}
*
*
* @param describeProjectVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeProjectVersionsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjectVersions
*/
default DescribeProjectVersionsIterable describeProjectVersionsPaginator(
Consumer describeProjectVersionsRequest) throws ResourceNotFoundException,
InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return describeProjectVersionsPaginator(DescribeProjectVersionsRequest.builder()
.applyMutation(describeProjectVersionsRequest).build());
}
/**
*
* Gets information about your Amazon Rekognition Custom Labels projects.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjects action.
*
*
* @param describeProjectsRequest
* @return Result of the DescribeProjects operation returned by the service.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjects
*/
default DescribeProjectsResponse describeProjects(DescribeProjectsRequest describeProjectsRequest)
throws InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about your Amazon Rekognition Custom Labels projects.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjects action.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeProjectsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeProjectsRequest#builder()}
*
*
* @param describeProjectsRequest
* A {@link Consumer} that will call methods on {@link DescribeProjectsRequest.Builder} to create a request.
* @return Result of the DescribeProjects operation returned by the service.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjects
*/
default DescribeProjectsResponse describeProjects(Consumer describeProjectsRequest)
throws InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return describeProjects(DescribeProjectsRequest.builder().applyMutation(describeProjectsRequest).build());
}
/**
*
* Gets information about your Amazon Rekognition Custom Labels projects.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjects action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest)}
* operation.
*
*
* @param describeProjectsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjects
*/
default DescribeProjectsIterable describeProjectsPaginator(DescribeProjectsRequest describeProjectsRequest)
throws InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return new DescribeProjectsIterable(this, describeProjectsRequest);
}
/**
*
* Gets information about your Amazon Rekognition Custom Labels projects.
*
*
* This operation requires permissions to perform the rekognition:DescribeProjects action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeProjects(software.amazon.awssdk.services.rekognition.model.DescribeProjectsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeProjectsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeProjectsRequest#builder()}
*
*
* @param describeProjectsRequest
* A {@link Consumer} that will call methods on {@link DescribeProjectsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeProjects
*/
default DescribeProjectsIterable describeProjectsPaginator(Consumer describeProjectsRequest)
throws InvalidPaginationTokenException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return describeProjectsPaginator(DescribeProjectsRequest.builder().applyMutation(describeProjectsRequest).build());
}
/**
*
* 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.
*
*
* @param describeStreamProcessorRequest
* @return Result of the DescribeStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeStreamProcessor
*/
default DescribeStreamProcessorResponse describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
ResourceNotFoundException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStreamProcessorRequest.Builder} avoiding
* the need to create one manually via {@link DescribeStreamProcessorRequest#builder()}
*
*
* @param describeStreamProcessorRequest
* A {@link Consumer} that will call methods on {@link DescribeStreamProcessorRequest.Builder} to create a
* request.
* @return Result of the DescribeStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DescribeStreamProcessor
*/
default DescribeStreamProcessorResponse describeStreamProcessor(
Consumer describeStreamProcessorRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
return describeStreamProcessor(DescribeStreamProcessorRequest.builder().applyMutation(describeStreamProcessorRequest)
.build());
}
/**
*
* 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.
*
*
* @param detectCustomLabelsRequest
* @return Result of the DetectCustomLabels operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectCustomLabels
*/
default DetectCustomLabelsResponse detectCustomLabels(DetectCustomLabelsRequest detectCustomLabelsRequest)
throws ResourceNotFoundException, ResourceNotReadyException, InvalidS3ObjectException, InvalidParameterException,
ImageTooLargeException, LimitExceededException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DetectCustomLabelsRequest.Builder} avoiding the
* need to create one manually via {@link DetectCustomLabelsRequest#builder()}
*
*
* @param detectCustomLabelsRequest
* A {@link Consumer} that will call methods on {@link DetectCustomLabelsRequest.Builder} to create a
* request.
* @return Result of the DetectCustomLabels operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectCustomLabels
*/
default DetectCustomLabelsResponse detectCustomLabels(Consumer detectCustomLabelsRequest)
throws ResourceNotFoundException, ResourceNotReadyException, InvalidS3ObjectException, InvalidParameterException,
ImageTooLargeException, LimitExceededException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
return detectCustomLabels(DetectCustomLabelsRequest.builder().applyMutation(detectCustomLabelsRequest).build());
}
/**
*
* 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.
*
*
* @param detectFacesRequest
* @return Result of the DetectFaces operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectFaces
*/
default DetectFacesResponse detectFaces(DetectFacesRequest detectFacesRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DetectFacesRequest.Builder} avoiding the need to
* create one manually via {@link DetectFacesRequest#builder()}
*
*
* @param detectFacesRequest
* A {@link Consumer} that will call methods on {@link DetectFacesRequest.Builder} to create a request.
* @return Result of the DetectFaces operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectFaces
*/
default DetectFacesResponse detectFaces(Consumer detectFacesRequest)
throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException {
return detectFaces(DetectFacesRequest.builder().applyMutation(detectFacesRequest).build());
}
/**
*
* 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.
*
*
* 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.
*
*
* 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.
*
*
* @param detectLabelsRequest
* @return Result of the DetectLabels operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectLabels
*/
default DetectLabelsResponse detectLabels(DetectLabelsRequest detectLabelsRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
* 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.
*
*
* 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 {@link DetectLabelsRequest.Builder} avoiding the need to
* create one manually via {@link DetectLabelsRequest#builder()}
*
*
* @param detectLabelsRequest
* A {@link Consumer} that will call methods on {@link DetectLabelsRequest.Builder} to create a request.
* @return Result of the DetectLabels operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectLabels
*/
default DetectLabelsResponse detectLabels(Consumer detectLabelsRequest)
throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException {
return detectLabels(DetectLabelsRequest.builder().applyMutation(detectLabelsRequest).build());
}
/**
*
* 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.
*
*
* @param detectModerationLabelsRequest
* @return Result of the DetectModerationLabels operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws HumanLoopQuotaExceededException
* The number of in-progress human reviews you have has exceeded the number allowed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectModerationLabels
*/
default DetectModerationLabelsResponse detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest)
throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidImageFormatException, HumanLoopQuotaExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link DetectModerationLabelsRequest.Builder} avoiding the
* need to create one manually via {@link DetectModerationLabelsRequest#builder()}
*
*
* @param detectModerationLabelsRequest
* A {@link Consumer} that will call methods on {@link DetectModerationLabelsRequest.Builder} to create a
* request.
* @return Result of the DetectModerationLabels operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws HumanLoopQuotaExceededException
* The number of in-progress human reviews you have has exceeded the number allowed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectModerationLabels
*/
default DetectModerationLabelsResponse detectModerationLabels(
Consumer detectModerationLabelsRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException,
HumanLoopQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
return detectModerationLabels(DetectModerationLabelsRequest.builder().applyMutation(detectModerationLabelsRequest)
.build());
}
/**
*
* 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.
*
*
* @param detectProtectiveEquipmentRequest
* @return Result of the DetectProtectiveEquipment operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectProtectiveEquipment
*/
default DetectProtectiveEquipmentResponse detectProtectiveEquipment(
DetectProtectiveEquipmentRequest detectProtectiveEquipmentRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DetectProtectiveEquipmentRequest.Builder} avoiding
* the need to create one manually via {@link DetectProtectiveEquipmentRequest#builder()}
*
*
* @param detectProtectiveEquipmentRequest
* A {@link Consumer} that will call methods on {@link DetectProtectiveEquipmentRequest.Builder} to create a
* request.
* @return Result of the DetectProtectiveEquipment operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectProtectiveEquipment
*/
default DetectProtectiveEquipmentResponse detectProtectiveEquipment(
Consumer detectProtectiveEquipmentRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
return detectProtectiveEquipment(DetectProtectiveEquipmentRequest.builder()
.applyMutation(detectProtectiveEquipmentRequest).build());
}
/**
*
* 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.
*
*
* @param detectTextRequest
* @return Result of the DetectText operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectText
*/
default DetectTextResponse detectText(DetectTextRequest detectTextRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DetectTextRequest.Builder} avoiding the need to
* create one manually via {@link DetectTextRequest#builder()}
*
*
* @param detectTextRequest
* A {@link Consumer} that will call methods on {@link DetectTextRequest.Builder} to create a request.
* @return Result of the DetectText operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DetectText
*/
default DetectTextResponse detectText(Consumer detectTextRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException,
SdkClientException, RekognitionException {
return detectText(DetectTextRequest.builder().applyMutation(detectTextRequest).build());
}
/**
*
* 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.
*
*
* @param disassociateFacesRequest
* @return Result of the DisassociateFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DisassociateFaces
*/
default DisassociateFacesResponse disassociateFaces(DisassociateFacesRequest disassociateFacesRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, IdempotentParameterMismatchException, ResourceNotFoundException,
ConflictException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DisassociateFacesRequest.Builder} avoiding the need
* to create one manually via {@link DisassociateFacesRequest#builder()}
*
*
* @param disassociateFacesRequest
* A {@link Consumer} that will call methods on {@link DisassociateFacesRequest.Builder} to create a request.
* @return Result of the DisassociateFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ConflictException
* A User with the same Id already exists within the collection, or the update or deletion of the User
* caused an inconsistent state. **
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DisassociateFaces
*/
default DisassociateFacesResponse disassociateFaces(Consumer disassociateFacesRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, IdempotentParameterMismatchException, ResourceNotFoundException,
ConflictException, AwsServiceException, SdkClientException, RekognitionException {
return disassociateFaces(DisassociateFacesRequest.builder().applyMutation(disassociateFacesRequest).build());
}
/**
*
* 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.
*
*
* @param distributeDatasetEntriesRequest
* @return Result of the DistributeDatasetEntries operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DistributeDatasetEntries
*/
default DistributeDatasetEntriesResponse distributeDatasetEntries(
DistributeDatasetEntriesRequest distributeDatasetEntriesRequest) throws ResourceNotFoundException,
InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotReadyException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DistributeDatasetEntriesRequest.Builder} avoiding
* the need to create one manually via {@link DistributeDatasetEntriesRequest#builder()}
*
*
* @param distributeDatasetEntriesRequest
* A {@link Consumer} that will call methods on {@link DistributeDatasetEntriesRequest.Builder} to create a
* request.
* @return Result of the DistributeDatasetEntries operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.DistributeDatasetEntries
*/
default DistributeDatasetEntriesResponse distributeDatasetEntries(
Consumer distributeDatasetEntriesRequest) throws ResourceNotFoundException,
InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotReadyException, AwsServiceException, SdkClientException,
RekognitionException {
return distributeDatasetEntries(DistributeDatasetEntriesRequest.builder().applyMutation(distributeDatasetEntriesRequest)
.build());
}
/**
*
* 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.
*
*
* @param getCelebrityInfoRequest
* @return Result of the GetCelebrityInfo operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetCelebrityInfo
*/
default GetCelebrityInfoResponse getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetCelebrityInfoRequest.Builder} avoiding the need
* to create one manually via {@link GetCelebrityInfoRequest#builder()}
*
*
* @param getCelebrityInfoRequest
* A {@link Consumer} that will call methods on {@link GetCelebrityInfoRequest.Builder} to create a request.
* @return Result of the GetCelebrityInfo operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetCelebrityInfo
*/
default GetCelebrityInfoResponse getCelebrityInfo(Consumer getCelebrityInfoRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return getCelebrityInfo(GetCelebrityInfoRequest.builder().applyMutation(getCelebrityInfoRequest).build());
}
/**
*
* 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.
*
*
* @param getCelebrityRecognitionRequest
* @return Result of the GetCelebrityRecognition operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetCelebrityRecognition
*/
default GetCelebrityRecognitionResponse getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetCelebrityRecognitionRequest.Builder} avoiding
* the need to create one manually via {@link GetCelebrityRecognitionRequest#builder()}
*
*
* @param getCelebrityRecognitionRequest
* A {@link Consumer} that will call methods on {@link GetCelebrityRecognitionRequest.Builder} to create a
* request.
* @return Result of the GetCelebrityRecognition operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetCelebrityRecognition
*/
default GetCelebrityRecognitionResponse getCelebrityRecognition(
Consumer getCelebrityRecognitionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getCelebrityRecognition(GetCelebrityRecognitionRequest.builder().applyMutation(getCelebrityRecognitionRequest)
.build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest)}
* operation.
*
*
* @param getCelebrityRecognitionRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetCelebrityRecognition
*/
default GetCelebrityRecognitionIterable getCelebrityRecognitionPaginator(
GetCelebrityRecognitionRequest getCelebrityRecognitionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return new GetCelebrityRecognitionIterable(this, getCelebrityRecognitionRequest);
}
/**
*
* Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
* StartCelebrityRecognition.
*
*
* Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to
* StartCelebrityRecognition which returns a job identifier (JobId).
*
*
* When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the
* Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition
* . To get the results of the celebrity recognition analysis, first check that the status value published to the
* Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job
* identifier (JobId) from the initial call to StartCelebrityDetection.
*
*
* For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
*
*
* GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (
* Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains
* information about the celebrity in a CelebrityDetail object and the time, Timestamp, the
* celebrity was detected. 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetCelebrityRecognitionRequest.Builder} avoiding
* the need to create one manually via {@link GetCelebrityRecognitionRequest#builder()}
*
*
* @param getCelebrityRecognitionRequest
* A {@link Consumer} that will call methods on {@link GetCelebrityRecognitionRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetCelebrityRecognition
*/
default GetCelebrityRecognitionIterable getCelebrityRecognitionPaginator(
Consumer getCelebrityRecognitionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getCelebrityRecognitionPaginator(GetCelebrityRecognitionRequest.builder()
.applyMutation(getCelebrityRecognitionRequest).build());
}
/**
*
* 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.
*
*
* @param getContentModerationRequest
* @return Result of the GetContentModeration operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetContentModeration
*/
default GetContentModerationResponse getContentModeration(GetContentModerationRequest getContentModerationRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetContentModerationRequest.Builder} avoiding the
* need to create one manually via {@link GetContentModerationRequest#builder()}
*
*
* @param getContentModerationRequest
* A {@link Consumer} that will call methods on {@link GetContentModerationRequest.Builder} to create a
* request.
* @return Result of the GetContentModeration operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetContentModeration
*/
default GetContentModerationResponse getContentModeration(
Consumer getContentModerationRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getContentModeration(GetContentModerationRequest.builder().applyMutation(getContentModerationRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest)}
* operation.
*
*
* @param getContentModerationRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetContentModeration
*/
default GetContentModerationIterable getContentModerationPaginator(GetContentModerationRequest getContentModerationRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return new GetContentModerationIterable(this, getContentModerationRequest);
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetContentModerationRequest.Builder} avoiding the
* need to create one manually via {@link GetContentModerationRequest#builder()}
*
*
* @param getContentModerationRequest
* A {@link Consumer} that will call methods on {@link GetContentModerationRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetContentModeration
*/
default GetContentModerationIterable getContentModerationPaginator(
Consumer getContentModerationRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getContentModerationPaginator(GetContentModerationRequest.builder().applyMutation(getContentModerationRequest)
.build());
}
/**
*
* 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.
*
*
* @param getFaceDetectionRequest
* @return Result of the GetFaceDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceDetection
*/
default GetFaceDetectionResponse getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetFaceDetectionRequest.Builder} avoiding the need
* to create one manually via {@link GetFaceDetectionRequest#builder()}
*
*
* @param getFaceDetectionRequest
* A {@link Consumer} that will call methods on {@link GetFaceDetectionRequest.Builder} to create a request.
* @return Result of the GetFaceDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceDetection
*/
default GetFaceDetectionResponse getFaceDetection(Consumer getFaceDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getFaceDetection(GetFaceDetectionRequest.builder().applyMutation(getFaceDetectionRequest).build());
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest)}
* operation.
*
*
* @param getFaceDetectionRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceDetection
*/
default GetFaceDetectionIterable getFaceDetectionPaginator(GetFaceDetectionRequest getFaceDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return new GetFaceDetectionIterable(this, getFaceDetectionRequest);
}
/**
*
* Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
*
*
* Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling
* StartFaceDetection which returns a job identifier (JobId). When the face detection operation
* finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartFaceDetection. To get the results of the face detection
* operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so,
* call GetFaceDetection and pass the job identifier (JobId) from the initial call to
* StartFaceDetection.
*
*
* GetFaceDetection returns an array of detected faces (Faces) sorted by the time the
* faces were detected.
*
*
* Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in
* MaxResults, the value of NextToken in the operation response contains a pagination
* token for getting the next set of results. To get the next page of results, call GetFaceDetection
* and populate the NextToken request parameter with the token value returned from the previous call to
* GetFaceDetection.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetFaceDetectionRequest.Builder} avoiding the need
* to create one manually via {@link GetFaceDetectionRequest#builder()}
*
*
* @param getFaceDetectionRequest
* A {@link Consumer} that will call methods on {@link GetFaceDetectionRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceDetection
*/
default GetFaceDetectionIterable getFaceDetectionPaginator(Consumer getFaceDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getFaceDetectionPaginator(GetFaceDetectionRequest.builder().applyMutation(getFaceDetectionRequest).build());
}
/**
*
* 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 reference image can optionally be returned.
*
*
* @param getFaceLivenessSessionResultsRequest
* @return Result of the GetFaceLivenessSessionResults operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws SessionNotFoundException
* Occurs when a given sessionId is not found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceLivenessSessionResults
*/
default GetFaceLivenessSessionResultsResponse getFaceLivenessSessionResults(
GetFaceLivenessSessionResultsRequest getFaceLivenessSessionResultsRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, SessionNotFoundException, ThrottlingException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 reference image can optionally be returned.
*
*
*
* This is a convenience which creates an instance of the {@link GetFaceLivenessSessionResultsRequest.Builder}
* avoiding the need to create one manually via {@link GetFaceLivenessSessionResultsRequest#builder()}
*
*
* @param getFaceLivenessSessionResultsRequest
* A {@link Consumer} that will call methods on {@link GetFaceLivenessSessionResultsRequest.Builder} to
* create a request.
* @return Result of the GetFaceLivenessSessionResults operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws SessionNotFoundException
* Occurs when a given sessionId is not found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceLivenessSessionResults
*/
default GetFaceLivenessSessionResultsResponse getFaceLivenessSessionResults(
Consumer getFaceLivenessSessionResultsRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, SessionNotFoundException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return getFaceLivenessSessionResults(GetFaceLivenessSessionResultsRequest.builder()
.applyMutation(getFaceLivenessSessionResultsRequest).build());
}
/**
*
* 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.
*
*
* @param getFaceSearchRequest
* @return Result of the GetFaceSearch operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceSearch
*/
default GetFaceSearchResponse getFaceSearch(GetFaceSearchRequest getFaceSearchRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetFaceSearchRequest.Builder} avoiding the need to
* create one manually via {@link GetFaceSearchRequest#builder()}
*
*
* @param getFaceSearchRequest
* A {@link Consumer} that will call methods on {@link GetFaceSearchRequest.Builder} to create a request.
* @return Result of the GetFaceSearch operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceSearch
*/
default GetFaceSearchResponse getFaceSearch(Consumer getFaceSearchRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getFaceSearch(GetFaceSearchRequest.builder().applyMutation(getFaceSearchRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest)} operation.
*
*
* @param getFaceSearchRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceSearch
*/
default GetFaceSearchIterable getFaceSearchPaginator(GetFaceSearchRequest getFaceSearchRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return new GetFaceSearchIterable(this, getFaceSearchRequest);
}
/**
*
* Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The
* search returns faces in a collection that match the faces of persons detected in a video. It also includes the
* time(s) that faces are matched in the video.
*
*
* Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch
* which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video
* publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to
* StartFaceSearch. To get the search results, first check that the status value published to the
* Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (
* JobId) from the initial call to StartFaceSearch.
*
*
* For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
*
*
* The search results are retured in an array, Persons, of PersonMatch objects. Each
* PersonMatch element contains details about the matching faces in the input collection, person
* information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the
* person was matched in the video.
*
*
*
* GetFaceSearch only returns the default facial attributes (BoundingBox,
* Confidence, Landmarks, Pose, and Quality). The other facial
* attributes listed in the Face object of the following response syntax are not returned. For more
* information, see FaceDetail in the Amazon Rekognition Developer Guide.
*
*
*
* By default, the Persons array is sorted by the time, in milliseconds from the start of the video,
* persons are matched. You can also sort by persons by specifying INDEX for the SORTBY
* input parameter.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetFaceSearchRequest.Builder} avoiding the need to
* create one manually via {@link GetFaceSearchRequest#builder()}
*
*
* @param getFaceSearchRequest
* A {@link Consumer} that will call methods on {@link GetFaceSearchRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetFaceSearch
*/
default GetFaceSearchIterable getFaceSearchPaginator(Consumer getFaceSearchRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getFaceSearchPaginator(GetFaceSearchRequest.builder().applyMutation(getFaceSearchRequest).build());
}
/**
*
* 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.
*
*
* @param getLabelDetectionRequest
* @return Result of the GetLabelDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetLabelDetection
*/
default GetLabelDetectionResponse getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetLabelDetectionRequest.Builder} avoiding the need
* to create one manually via {@link GetLabelDetectionRequest#builder()}
*
*
* @param getLabelDetectionRequest
* A {@link Consumer} that will call methods on {@link GetLabelDetectionRequest.Builder} to create a request.
* @return Result of the GetLabelDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetLabelDetection
*/
default GetLabelDetectionResponse getLabelDetection(Consumer getLabelDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getLabelDetection(GetLabelDetectionRequest.builder().applyMutation(getLabelDetectionRequest).build());
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest)}
* operation.
*
*
* @param getLabelDetectionRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetLabelDetection
*/
default GetLabelDetectionIterable getLabelDetectionPaginator(GetLabelDetectionRequest getLabelDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return new GetLabelDetectionIterable(this, getLabelDetectionRequest);
}
/**
*
* Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
*
*
* The label detection operation is started by a call to StartLabelDetection which returns a job identifier (
* JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion
* status to the Amazon Simple Notification Service topic registered in the initial call to
* StartlabelDetection.
*
*
* To get the results of the label detection operation, first check that the status value published to the Amazon
* SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (
* JobId) from the initial call to StartLabelDetection.
*
*
* GetLabelDetection returns an array of detected labels (Labels) sorted by the time the
* labels were detected. You can also sort by the label name by specifying NAME for the
* SortBy input parameter. 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.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetLabelDetectionRequest.Builder} avoiding the need
* to create one manually via {@link GetLabelDetectionRequest#builder()}
*
*
* @param getLabelDetectionRequest
* A {@link Consumer} that will call methods on {@link GetLabelDetectionRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetLabelDetection
*/
default GetLabelDetectionIterable getLabelDetectionPaginator(
Consumer getLabelDetectionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getLabelDetectionPaginator(GetLabelDetectionRequest.builder().applyMutation(getLabelDetectionRequest).build());
}
/**
*
* 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.
*
*
* @param getPersonTrackingRequest
* @return Result of the GetPersonTracking operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetPersonTracking
*/
default GetPersonTrackingResponse getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetPersonTrackingRequest.Builder} avoiding the need
* to create one manually via {@link GetPersonTrackingRequest#builder()}
*
*
* @param getPersonTrackingRequest
* A {@link Consumer} that will call methods on {@link GetPersonTrackingRequest.Builder} to create a request.
* @return Result of the GetPersonTracking operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetPersonTracking
*/
default GetPersonTrackingResponse getPersonTracking(Consumer getPersonTrackingRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getPersonTracking(GetPersonTrackingRequest.builder().applyMutation(getPersonTrackingRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest)}
* operation.
*
*
* @param getPersonTrackingRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetPersonTracking
*/
default GetPersonTrackingIterable getPersonTrackingPaginator(GetPersonTrackingRequest getPersonTrackingRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return new GetPersonTrackingIterable(this, getPersonTrackingRequest);
}
/**
*
* Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
*
*
* The person path tracking operation is started by a call to StartPersonTracking which returns a job
* identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion
* status to the Amazon Simple Notification Service topic registered in the initial call to
* StartPersonTracking.
*
*
* To get the results of the person path tracking operation, first check that the status value published to the
* Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (
* JobId) from the initial call to StartPersonTracking.
*
*
* GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their
* paths were tracked in the video.
*
*
*
* GetPersonTracking only returns the default facial attributes (BoundingBox,
* Confidence, Landmarks, Pose, and Quality). The other facial
* attributes listed in the Face object of the following response syntax are not returned.
*
*
* For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
*
*
*
* By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked
* persons by specifying INDEX for the SortBy input parameter.
*
*
* Use the MaxResults parameter to limit the number of items returned. If there are more results than
* specified in MaxResults, the value of NextToken in the operation response contains a
* pagination token for getting the next set of results. To get the next page of results, call
* GetPersonTracking and populate the NextToken request parameter with the token value
* returned from the previous call to GetPersonTracking.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetPersonTrackingRequest.Builder} avoiding the need
* to create one manually via {@link GetPersonTrackingRequest#builder()}
*
*
* @param getPersonTrackingRequest
* A {@link Consumer} that will call methods on {@link GetPersonTrackingRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetPersonTracking
*/
default GetPersonTrackingIterable getPersonTrackingPaginator(
Consumer getPersonTrackingRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getPersonTrackingPaginator(GetPersonTrackingRequest.builder().applyMutation(getPersonTrackingRequest).build());
}
/**
*
* 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.
*
*
* @param getSegmentDetectionRequest
* @return Result of the GetSegmentDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetSegmentDetection
*/
default GetSegmentDetectionResponse getSegmentDetection(GetSegmentDetectionRequest getSegmentDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSegmentDetectionRequest.Builder} avoiding the
* need to create one manually via {@link GetSegmentDetectionRequest#builder()}
*
*
* @param getSegmentDetectionRequest
* A {@link Consumer} that will call methods on {@link GetSegmentDetectionRequest.Builder} to create a
* request.
* @return Result of the GetSegmentDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetSegmentDetection
*/
default GetSegmentDetectionResponse getSegmentDetection(
Consumer getSegmentDetectionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getSegmentDetection(GetSegmentDetectionRequest.builder().applyMutation(getSegmentDetectionRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest)}
* operation.
*
*
* @param getSegmentDetectionRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetSegmentDetection
*/
default GetSegmentDetectionIterable getSegmentDetectionPaginator(GetSegmentDetectionRequest getSegmentDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return new GetSegmentDetectionIterable(this, getSegmentDetectionRequest);
}
/**
*
* Gets the segment detection results of a Amazon Rekognition Video analysis started by
* StartSegmentDetection.
*
*
* Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by
* calling StartSegmentDetection which returns a job identifier (JobId). When the segment
* detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification
* Service topic registered in the initial call to StartSegmentDetection. To get the results of the
* segment detection operation, first check that the status value published to the Amazon SNS topic is
* SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (
* JobId) from the initial call of StartSegmentDetection.
*
*
* GetSegmentDetection returns detected segments in an array (Segments) of
* SegmentDetection objects. Segments is sorted by the segment types specified in the
* SegmentTypes input parameter of StartSegmentDetection. Each element of the array
* includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the
* segment, and the frame in which the segment was detected.
*
*
* Use SelectedSegmentTypes to find out the type of segment detection requested in the call to
* StartSegmentDetection.
*
*
* Use the MaxResults parameter to limit the number of segment detections returned. If there are more
* results than specified in MaxResults, the value of NextToken in the operation response
* contains a pagination token for getting the next set of results. To get the next page of results, call
* GetSegmentDetection and populate the NextToken request parameter with the token value
* returned from the previous call to GetSegmentDetection.
*
*
* For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getSegmentDetection(software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetSegmentDetectionRequest.Builder} avoiding the
* need to create one manually via {@link GetSegmentDetectionRequest#builder()}
*
*
* @param getSegmentDetectionRequest
* A {@link Consumer} that will call methods on {@link GetSegmentDetectionRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetSegmentDetection
*/
default GetSegmentDetectionIterable getSegmentDetectionPaginator(
Consumer getSegmentDetectionRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return getSegmentDetectionPaginator(GetSegmentDetectionRequest.builder().applyMutation(getSegmentDetectionRequest)
.build());
}
/**
*
* Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
*
*
* Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling
* StartTextDetection which returns a job identifier (JobId) When the text detection operation
* finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartTextDetection. To get the results of the text detection
* operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so,
* call GetTextDetection and pass the job identifier (JobId) from the initial call of
* StartLabelDetection.
*
*
* GetTextDetection returns an array of detected text (TextDetections) sorted by the time
* the text was detected, up to 50 words per frame of video.
*
*
* Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected
* text, the time the text was detected, bounding box information for where the text was located, and unique
* identifiers for words and their lines.
*
*
* Use MaxResults parameter to limit the number of text detections returned. If there are more results than
* specified in MaxResults, the value of NextToken in the operation response contains a
* pagination token for getting the next set of results. To get the next page of results, call
* GetTextDetection and populate the NextToken request parameter with the token value
* returned from the previous call to GetTextDetection.
*
*
* @param getTextDetectionRequest
* @return Result of the GetTextDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetTextDetection
*/
default GetTextDetectionResponse getTextDetection(GetTextDetectionRequest getTextDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
*
*
* Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling
* StartTextDetection which returns a job identifier (JobId) When the text detection operation
* finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartTextDetection. To get the results of the text detection
* operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so,
* call GetTextDetection and pass the job identifier (JobId) from the initial call of
* StartLabelDetection.
*
*
* GetTextDetection returns an array of detected text (TextDetections) sorted by the time
* the text was detected, up to 50 words per frame of video.
*
*
* Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected
* text, the time the text was detected, bounding box information for where the text was located, and unique
* identifiers for words and their lines.
*
*
* Use MaxResults parameter to limit the number of text detections returned. If there are more results than
* specified in MaxResults, the value of NextToken in the operation response contains a
* pagination token for getting the next set of results. To get the next page of results, call
* GetTextDetection and populate the NextToken request parameter with the token value
* returned from the previous call to GetTextDetection.
*
*
*
* This is a convenience which creates an instance of the {@link GetTextDetectionRequest.Builder} avoiding the need
* to create one manually via {@link GetTextDetectionRequest#builder()}
*
*
* @param getTextDetectionRequest
* A {@link Consumer} that will call methods on {@link GetTextDetectionRequest.Builder} to create a request.
* @return Result of the GetTextDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetTextDetection
*/
default GetTextDetectionResponse getTextDetection(Consumer getTextDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getTextDetection(GetTextDetectionRequest.builder().applyMutation(getTextDetectionRequest).build());
}
/**
*
* Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
*
*
* Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling
* StartTextDetection which returns a job identifier (JobId) When the text detection operation
* finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartTextDetection. To get the results of the text detection
* operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so,
* call GetTextDetection and pass the job identifier (JobId) from the initial call of
* StartLabelDetection.
*
*
* GetTextDetection returns an array of detected text (TextDetections) sorted by the time
* the text was detected, up to 50 words per frame of video.
*
*
* Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected
* text, the time the text was detected, bounding box information for where the text was located, and unique
* identifiers for words and their lines.
*
*
* Use MaxResults parameter to limit the number of text detections returned. If there are more results than
* specified in MaxResults, the value of NextToken in the operation response contains a
* pagination token for getting the next set of results. To get the next page of results, call
* GetTextDetection and populate the NextToken request parameter with the token value
* returned from the previous call to GetTextDetection.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest)}
* operation.
*
*
* @param getTextDetectionRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetTextDetection
*/
default GetTextDetectionIterable getTextDetectionPaginator(GetTextDetectionRequest getTextDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return new GetTextDetectionIterable(this, getTextDetectionRequest);
}
/**
*
* Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
*
*
* Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling
* StartTextDetection which returns a job identifier (JobId) When the text detection operation
* finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartTextDetection. To get the results of the text detection
* operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so,
* call GetTextDetection and pass the job identifier (JobId) from the initial call of
* StartLabelDetection.
*
*
* GetTextDetection returns an array of detected text (TextDetections) sorted by the time
* the text was detected, up to 50 words per frame of video.
*
*
* Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected
* text, the time the text was detected, bounding box information for where the text was located, and unique
* identifiers for words and their lines.
*
*
* Use MaxResults parameter to limit the number of text detections returned. If there are more results than
* specified in MaxResults, the value of NextToken in the operation response contains a
* pagination token for getting the next set of results. To get the next page of results, call
* GetTextDetection and populate the NextToken request parameter with the token value
* returned from the previous call to GetTextDetection.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #getTextDetection(software.amazon.awssdk.services.rekognition.model.GetTextDetectionRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetTextDetectionRequest.Builder} avoiding the need
* to create one manually via {@link GetTextDetectionRequest#builder()}
*
*
* @param getTextDetectionRequest
* A {@link Consumer} that will call methods on {@link GetTextDetectionRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.GetTextDetection
*/
default GetTextDetectionIterable getTextDetectionPaginator(Consumer getTextDetectionRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return getTextDetectionPaginator(GetTextDetectionRequest.builder().applyMutation(getTextDetectionRequest).build());
}
/**
*
* 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.
*
*
* @param indexFacesRequest
* @return Result of the IndexFaces operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.IndexFaces
*/
default IndexFacesResponse indexFaces(IndexFacesRequest indexFacesRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, InvalidImageFormatException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link IndexFacesRequest.Builder} avoiding the need to
* create one manually via {@link IndexFacesRequest#builder()}
*
*
* @param indexFacesRequest
* A {@link Consumer} that will call methods on {@link IndexFacesRequest.Builder} to create a request.
* @return Result of the IndexFaces operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.IndexFaces
*/
default IndexFacesResponse indexFaces(Consumer indexFacesRequest) throws InvalidS3ObjectException,
InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, InvalidImageFormatException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, RekognitionException {
return indexFaces(IndexFacesRequest.builder().applyMutation(indexFacesRequest).build());
}
/**
*
* 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.
*
*
* @param listCollectionsRequest
* @return Result of the ListCollections operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListCollections
*/
default ListCollectionsResponse listCollections(ListCollectionsRequest listCollectionsRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListCollectionsRequest.Builder} avoiding the need
* to create one manually via {@link ListCollectionsRequest#builder()}
*
*
* @param listCollectionsRequest
* A {@link Consumer} that will call methods on {@link ListCollectionsRequest.Builder} to create a request.
* @return Result of the ListCollections operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListCollections
*/
default ListCollectionsResponse listCollections(Consumer listCollectionsRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException,
AwsServiceException, SdkClientException, RekognitionException {
return listCollections(ListCollectionsRequest.builder().applyMutation(listCollectionsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the ListCollections operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListCollections
* @see #listCollections(ListCollectionsRequest)
*/
default ListCollectionsResponse listCollections() throws InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return listCollections(ListCollectionsRequest.builder().build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListCollections
* @see #listCollectionsPaginator(ListCollectionsRequest)
*/
default ListCollectionsIterable listCollectionsPaginator() throws InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return listCollectionsPaginator(ListCollectionsRequest.builder().build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)} operation.
*
*
* @param listCollectionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListCollections
*/
default ListCollectionsIterable listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException,
AwsServiceException, SdkClientException, RekognitionException {
return new ListCollectionsIterable(this, listCollectionsRequest);
}
/**
*
* Returns list of collection IDs in your account. If the result is truncated, the response also provides a
* NextToken that you can use in the subsequent request to fetch the next set of collection IDs.
*
*
* For an example, see Listing collections in the Amazon Rekognition Developer Guide.
*
*
* This operation requires permissions to perform the rekognition:ListCollections action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListCollectionsRequest.Builder} avoiding the need
* to create one manually via {@link ListCollectionsRequest#builder()}
*
*
* @param listCollectionsRequest
* A {@link Consumer} that will call methods on {@link ListCollectionsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListCollections
*/
default ListCollectionsIterable listCollectionsPaginator(Consumer listCollectionsRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException,
AwsServiceException, SdkClientException, RekognitionException {
return listCollectionsPaginator(ListCollectionsRequest.builder().applyMutation(listCollectionsRequest).build());
}
/**
*
* 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.
*
*
* @param listDatasetEntriesRequest
* @return Result of the ListDatasetEntries operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetEntries
*/
default ListDatasetEntriesResponse listDatasetEntries(ListDatasetEntriesRequest listDatasetEntriesRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceInUseException, ResourceNotFoundException,
InvalidPaginationTokenException, ResourceNotReadyException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetEntriesRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetEntriesRequest#builder()}
*
*
* @param listDatasetEntriesRequest
* A {@link Consumer} that will call methods on {@link ListDatasetEntriesRequest.Builder} to create a
* request.
* @return Result of the ListDatasetEntries operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetEntries
*/
default ListDatasetEntriesResponse listDatasetEntries(Consumer listDatasetEntriesRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceInUseException, ResourceNotFoundException,
InvalidPaginationTokenException, ResourceNotReadyException, AwsServiceException, SdkClientException,
RekognitionException {
return listDatasetEntries(ListDatasetEntriesRequest.builder().applyMutation(listDatasetEntriesRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest)}
* operation.
*
*
* @param listDatasetEntriesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetEntries
*/
default ListDatasetEntriesIterable listDatasetEntriesPaginator(ListDatasetEntriesRequest listDatasetEntriesRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceInUseException, ResourceNotFoundException,
InvalidPaginationTokenException, ResourceNotReadyException, AwsServiceException, SdkClientException,
RekognitionException {
return new ListDatasetEntriesIterable(this, listDatasetEntriesRequest);
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listDatasetEntries(software.amazon.awssdk.services.rekognition.model.ListDatasetEntriesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetEntriesRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetEntriesRequest#builder()}
*
*
* @param listDatasetEntriesRequest
* A {@link Consumer} that will call methods on {@link ListDatasetEntriesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetEntries
*/
default ListDatasetEntriesIterable listDatasetEntriesPaginator(
Consumer listDatasetEntriesRequest) throws InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidParameterException, AccessDeniedException,
ResourceInUseException, ResourceNotFoundException, InvalidPaginationTokenException, ResourceNotReadyException,
AwsServiceException, SdkClientException, RekognitionException {
return listDatasetEntriesPaginator(ListDatasetEntriesRequest.builder().applyMutation(listDatasetEntriesRequest).build());
}
/**
*
* 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.
*
*
* @param listDatasetLabelsRequest
* @return Result of the ListDatasetLabels operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetLabels
*/
default ListDatasetLabelsResponse listDatasetLabels(ListDatasetLabelsRequest listDatasetLabelsRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceInUseException, InvalidPaginationTokenException,
ResourceNotFoundException, ResourceNotReadyException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetLabelsRequest.Builder} avoiding the need
* to create one manually via {@link ListDatasetLabelsRequest#builder()}
*
*
* @param listDatasetLabelsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetLabelsRequest.Builder} to create a request.
* @return Result of the ListDatasetLabels operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetLabels
*/
default ListDatasetLabelsResponse listDatasetLabels(Consumer listDatasetLabelsRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceInUseException, InvalidPaginationTokenException,
ResourceNotFoundException, ResourceNotReadyException, AwsServiceException, SdkClientException, RekognitionException {
return listDatasetLabels(ListDatasetLabelsRequest.builder().applyMutation(listDatasetLabelsRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest)}
* operation.
*
*
* @param listDatasetLabelsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetLabels
*/
default ListDatasetLabelsIterable listDatasetLabelsPaginator(ListDatasetLabelsRequest listDatasetLabelsRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, ResourceInUseException, InvalidPaginationTokenException,
ResourceNotFoundException, ResourceNotReadyException, AwsServiceException, SdkClientException, RekognitionException {
return new ListDatasetLabelsIterable(this, listDatasetLabelsRequest);
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listDatasetLabels(software.amazon.awssdk.services.rekognition.model.ListDatasetLabelsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetLabelsRequest.Builder} avoiding the need
* to create one manually via {@link ListDatasetLabelsRequest#builder()}
*
*
* @param listDatasetLabelsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetLabelsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceNotReadyException
* The requested resource isn't ready. For example, this exception occurs when you call
* DetectCustomLabels with a model version that isn't deployed.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListDatasetLabels
*/
default ListDatasetLabelsIterable listDatasetLabelsPaginator(
Consumer listDatasetLabelsRequest) throws InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidParameterException, AccessDeniedException,
ResourceInUseException, InvalidPaginationTokenException, ResourceNotFoundException, ResourceNotReadyException,
AwsServiceException, SdkClientException, RekognitionException {
return listDatasetLabelsPaginator(ListDatasetLabelsRequest.builder().applyMutation(listDatasetLabelsRequest).build());
}
/**
*
* 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.
*
*
* @param listFacesRequest
* @return Result of the ListFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListFaces
*/
default ListFacesResponse listFaces(ListFacesRequest listFacesRequest) throws InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListFacesRequest.Builder} avoiding the need to
* create one manually via {@link ListFacesRequest#builder()}
*
*
* @param listFacesRequest
* A {@link Consumer} that will call methods on {@link ListFacesRequest.Builder} to create a request.
* @return Result of the ListFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListFaces
*/
default ListFacesResponse listFaces(Consumer listFacesRequest) throws InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return listFaces(ListFacesRequest.builder().applyMutation(listFacesRequest).build());
}
/**
*
* 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 variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest)} operation.
*
*
* @param listFacesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListFaces
*/
default ListFacesIterable listFacesPaginator(ListFacesRequest listFacesRequest) throws InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return new ListFacesIterable(this, listFacesRequest);
}
/**
*
* Returns metadata for faces in the specified collection. This metadata includes information such as the bounding
* box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing
* Faces in a Collection in the Amazon Rekognition Developer Guide.
*
*
* This operation requires permissions to perform the rekognition:ListFaces action.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListFacesRequest.Builder} avoiding the need to
* create one manually via {@link ListFacesRequest#builder()}
*
*
* @param listFacesRequest
* A {@link Consumer} that will call methods on {@link ListFacesRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListFaces
*/
default ListFacesIterable listFacesPaginator(Consumer listFacesRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException,
AwsServiceException, SdkClientException, RekognitionException {
return listFacesPaginator(ListFacesRequest.builder().applyMutation(listFacesRequest).build());
}
/**
*
* 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.
*
*
* @param listProjectPoliciesRequest
* @return Result of the ListProjectPolicies operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListProjectPolicies
*/
default ListProjectPoliciesResponse listProjectPolicies(ListProjectPoliciesRequest listProjectPoliciesRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, ResourceNotFoundException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListProjectPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListProjectPoliciesRequest#builder()}
*
*
* @param listProjectPoliciesRequest
* A {@link Consumer} that will call methods on {@link ListProjectPoliciesRequest.Builder} to create a
* request.
* @return Result of the ListProjectPolicies operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListProjectPolicies
*/
default ListProjectPoliciesResponse listProjectPolicies(
Consumer listProjectPoliciesRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, ResourceNotFoundException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, AwsServiceException, SdkClientException,
RekognitionException {
return listProjectPolicies(ListProjectPoliciesRequest.builder().applyMutation(listProjectPoliciesRequest).build());
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest)}
* operation.
*
*
* @param listProjectPoliciesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListProjectPolicies
*/
default ListProjectPoliciesIterable listProjectPoliciesPaginator(ListProjectPoliciesRequest listProjectPoliciesRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, ResourceNotFoundException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, AwsServiceException,
SdkClientException, RekognitionException {
return new ListProjectPoliciesIterable(this, listProjectPoliciesRequest);
}
/**
*
* 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 variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listProjectPolicies(software.amazon.awssdk.services.rekognition.model.ListProjectPoliciesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListProjectPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListProjectPoliciesRequest#builder()}
*
*
* @param listProjectPoliciesRequest
* A {@link Consumer} that will call methods on {@link ListProjectPoliciesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListProjectPolicies
*/
default ListProjectPoliciesIterable listProjectPoliciesPaginator(
Consumer listProjectPoliciesRequest) throws AccessDeniedException,
InternalServerErrorException, InvalidParameterException, ResourceNotFoundException, ThrottlingException,
ProvisionedThroughputExceededException, InvalidPaginationTokenException, AwsServiceException, SdkClientException,
RekognitionException {
return listProjectPoliciesPaginator(ListProjectPoliciesRequest.builder().applyMutation(listProjectPoliciesRequest)
.build());
}
/**
*
* Gets a list of stream processors that you have created with CreateStreamProcessor.
*
*
* @param listStreamProcessorsRequest
* @return Result of the ListStreamProcessors operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListStreamProcessors
*/
default ListStreamProcessorsResponse listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of stream processors that you have created with CreateStreamProcessor.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamProcessorsRequest.Builder} avoiding the
* need to create one manually via {@link ListStreamProcessorsRequest#builder()}
*
*
* @param listStreamProcessorsRequest
* A {@link Consumer} that will call methods on {@link ListStreamProcessorsRequest.Builder} to create a
* request.
* @return Result of the ListStreamProcessors operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListStreamProcessors
*/
default ListStreamProcessorsResponse listStreamProcessors(
Consumer listStreamProcessorsRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
return listStreamProcessors(ListStreamProcessorsRequest.builder().applyMutation(listStreamProcessorsRequest).build());
}
/**
*
* Gets a list of stream processors that you have created with CreateStreamProcessor.
*
*
* @return Result of the ListStreamProcessors operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListStreamProcessors
* @see #listStreamProcessors(ListStreamProcessorsRequest)
*/
default ListStreamProcessorsResponse listStreamProcessors() throws AccessDeniedException, InternalServerErrorException,
ThrottlingException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
return listStreamProcessors(ListStreamProcessorsRequest.builder().build());
}
/**
*
* Gets a list of stream processors that you have created with CreateStreamProcessor.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListStreamProcessors
* @see #listStreamProcessorsPaginator(ListStreamProcessorsRequest)
*/
default ListStreamProcessorsIterable listStreamProcessorsPaginator() throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
return listStreamProcessorsPaginator(ListStreamProcessorsRequest.builder().build());
}
/**
*
* Gets a list of stream processors that you have created with CreateStreamProcessor.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)}
* operation.
*
*
* @param listStreamProcessorsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListStreamProcessors
*/
default ListStreamProcessorsIterable listStreamProcessorsPaginator(ListStreamProcessorsRequest listStreamProcessorsRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return new ListStreamProcessorsIterable(this, listStreamProcessorsRequest);
}
/**
*
* Gets a list of stream processors that you have created with CreateStreamProcessor.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListStreamProcessorsRequest.Builder} avoiding the
* need to create one manually via {@link ListStreamProcessorsRequest#builder()}
*
*
* @param listStreamProcessorsRequest
* A {@link Consumer} that will call methods on {@link ListStreamProcessorsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListStreamProcessors
*/
default ListStreamProcessorsIterable listStreamProcessorsPaginator(
Consumer listStreamProcessorsRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
return listStreamProcessorsPaginator(ListStreamProcessorsRequest.builder().applyMutation(listStreamProcessorsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListTagsForResource
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ResourceNotFoundException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListTagsForResource
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ResourceNotFoundException,
InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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.
*
*
* @param listUsersRequest
* @return Result of the ListUsers operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListUsers
*/
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException,
ResourceNotFoundException, InvalidPaginationTokenException, ProvisionedThroughputExceededException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on {@link ListUsersRequest.Builder} to create a request.
* @return Result of the ListUsers operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListUsers
*/
default ListUsersResponse listUsers(Consumer listUsersRequest) throws InvalidParameterException,
ResourceNotFoundException, InvalidPaginationTokenException, ProvisionedThroughputExceededException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException,
RekognitionException {
return listUsers(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* 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 variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest)} operation.
*
*
* @param listUsersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListUsers
*/
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException,
ResourceNotFoundException, InvalidPaginationTokenException, ProvisionedThroughputExceededException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException,
RekognitionException {
return new ListUsersIterable(this, listUsersRequest);
}
/**
*
* 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 variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listUsers(software.amazon.awssdk.services.rekognition.model.ListUsersRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on {@link ListUsersRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidPaginationTokenException
* Pagination token in the request is not valid.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.ListUsers
*/
default ListUsersIterable listUsersPaginator(Consumer listUsersRequest)
throws InvalidParameterException, ResourceNotFoundException, InvalidPaginationTokenException,
ProvisionedThroughputExceededException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
AwsServiceException, SdkClientException, RekognitionException {
return listUsersPaginator(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* 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.
*
*
* 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.
*
*
* @param putProjectPolicyRequest
* @return Result of the PutProjectPolicy operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPolicyRevisionIdException
* The supplied revision id for the project policy is invalid.
* @throws MalformedPolicyDocumentException
* The format of the project policy document that you supplied to PutProjectPolicy is
* incorrect.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceAlreadyExistsException
* A resource with the specified ID already exists.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.PutProjectPolicy
*/
default PutProjectPolicyResponse putProjectPolicy(PutProjectPolicyRequest putProjectPolicyRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPolicyRevisionIdException, MalformedPolicyDocumentException, ResourceNotFoundException,
ResourceAlreadyExistsException, ThrottlingException, ServiceQuotaExceededException,
ProvisionedThroughputExceededException, LimitExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
* 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 {@link PutProjectPolicyRequest.Builder} avoiding the need
* to create one manually via {@link PutProjectPolicyRequest#builder()}
*
*
* @param putProjectPolicyRequest
* A {@link Consumer} that will call methods on {@link PutProjectPolicyRequest.Builder} to create a request.
* @return Result of the PutProjectPolicy operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidPolicyRevisionIdException
* The supplied revision id for the project policy is invalid.
* @throws MalformedPolicyDocumentException
* The format of the project policy document that you supplied to PutProjectPolicy is
* incorrect.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceAlreadyExistsException
* A resource with the specified ID already exists.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.PutProjectPolicy
*/
default PutProjectPolicyResponse putProjectPolicy(Consumer putProjectPolicyRequest)
throws AccessDeniedException, InternalServerErrorException, InvalidParameterException,
InvalidPolicyRevisionIdException, MalformedPolicyDocumentException, ResourceNotFoundException,
ResourceAlreadyExistsException, ThrottlingException, ServiceQuotaExceededException,
ProvisionedThroughputExceededException, LimitExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return putProjectPolicy(PutProjectPolicyRequest.builder().applyMutation(putProjectPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param recognizeCelebritiesRequest
* @return Result of the RecognizeCelebrities operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.RecognizeCelebrities
*/
default RecognizeCelebritiesResponse recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest)
throws InvalidS3ObjectException, InvalidParameterException, InvalidImageFormatException, ImageTooLargeException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RecognizeCelebritiesRequest.Builder} avoiding the
* need to create one manually via {@link RecognizeCelebritiesRequest#builder()}
*
*
* @param recognizeCelebritiesRequest
* A {@link Consumer} that will call methods on {@link RecognizeCelebritiesRequest.Builder} to create a
* request.
* @return Result of the RecognizeCelebrities operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.RecognizeCelebrities
*/
default RecognizeCelebritiesResponse recognizeCelebrities(
Consumer recognizeCelebritiesRequest) throws InvalidS3ObjectException,
InvalidParameterException, InvalidImageFormatException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return recognizeCelebrities(RecognizeCelebritiesRequest.builder().applyMutation(recognizeCelebritiesRequest).build());
}
/**
*
* 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.
*
*
* @param searchFacesRequest
* @return Result of the SearchFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchFaces
*/
default SearchFacesResponse searchFaces(SearchFacesRequest searchFacesRequest) throws InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SearchFacesRequest.Builder} avoiding the need to
* create one manually via {@link SearchFacesRequest#builder()}
*
*
* @param searchFacesRequest
* A {@link Consumer} that will call methods on {@link SearchFacesRequest.Builder} to create a request.
* @return Result of the SearchFaces operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchFaces
*/
default SearchFacesResponse searchFaces(Consumer searchFacesRequest)
throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return searchFaces(SearchFacesRequest.builder().applyMutation(searchFacesRequest).build());
}
/**
*
* 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.
*
*
* @param searchFacesByImageRequest
* @return Result of the SearchFacesByImage operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchFacesByImage
*/
default SearchFacesByImageResponse searchFacesByImage(SearchFacesByImageRequest searchFacesByImageRequest)
throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException,
InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SearchFacesByImageRequest.Builder} avoiding the
* need to create one manually via {@link SearchFacesByImageRequest#builder()}
*
*
* @param searchFacesByImageRequest
* A {@link Consumer} that will call methods on {@link SearchFacesByImageRequest.Builder} to create a
* request.
* @return Result of the SearchFacesByImage operation returned by the service.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchFacesByImage
*/
default SearchFacesByImageResponse searchFacesByImage(Consumer searchFacesByImageRequest)
throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException,
InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException {
return searchFacesByImage(SearchFacesByImageRequest.builder().applyMutation(searchFacesByImageRequest).build());
}
/**
*
* 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.
*
*
* @param searchUsersRequest
* @return Result of the SearchUsers operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchUsers
*/
default SearchUsersResponse searchUsers(SearchUsersRequest searchUsersRequest) throws InvalidParameterException,
ResourceNotFoundException, ProvisionedThroughputExceededException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SearchUsersRequest.Builder} avoiding the need to
* create one manually via {@link SearchUsersRequest#builder()}
*
*
* @param searchUsersRequest
* A {@link Consumer} that will call methods on {@link SearchUsersRequest.Builder} to create a request.
* @return Result of the SearchUsers operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchUsers
*/
default SearchUsersResponse searchUsers(Consumer searchUsersRequest)
throws InvalidParameterException, ResourceNotFoundException, ProvisionedThroughputExceededException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException,
RekognitionException {
return searchUsers(SearchUsersRequest.builder().applyMutation(searchUsersRequest).build());
}
/**
*
* 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.
*
*
* @param searchUsersByImageRequest
* @return Result of the SearchUsersByImage operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchUsersByImage
*/
default SearchUsersByImageResponse searchUsersByImage(SearchUsersByImageRequest searchUsersByImageRequest)
throws InvalidParameterException, ResourceNotFoundException, InvalidImageFormatException, InvalidS3ObjectException,
ImageTooLargeException, ProvisionedThroughputExceededException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SearchUsersByImageRequest.Builder} avoiding the
* need to create one manually via {@link SearchUsersByImageRequest#builder()}
*
*
* @param searchUsersByImageRequest
* A {@link Consumer} that will call methods on {@link SearchUsersByImageRequest.Builder} to create a
* request.
* @return Result of the SearchUsersByImage operation returned by the service.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidImageFormatException
* The provided image format is not supported.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws ImageTooLargeException
* The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image
* size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon
* Rekognition in the Amazon Rekognition Developer Guide.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.SearchUsersByImage
*/
default SearchUsersByImageResponse searchUsersByImage(Consumer searchUsersByImageRequest)
throws InvalidParameterException, ResourceNotFoundException, InvalidImageFormatException, InvalidS3ObjectException,
ImageTooLargeException, ProvisionedThroughputExceededException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return searchUsersByImage(SearchUsersByImageRequest.builder().applyMutation(searchUsersByImageRequest).build());
}
/**
*
* 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.
*
*
* @param startCelebrityRecognitionRequest
* @return Result of the StartCelebrityRecognition operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartCelebrityRecognition
*/
default StartCelebrityRecognitionResponse startCelebrityRecognition(
StartCelebrityRecognitionRequest startCelebrityRecognitionRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartCelebrityRecognitionRequest.Builder} avoiding
* the need to create one manually via {@link StartCelebrityRecognitionRequest#builder()}
*
*
* @param startCelebrityRecognitionRequest
* A {@link Consumer} that will call methods on {@link StartCelebrityRecognitionRequest.Builder} to create a
* request.
* @return Result of the StartCelebrityRecognition operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartCelebrityRecognition
*/
default StartCelebrityRecognitionResponse startCelebrityRecognition(
Consumer startCelebrityRecognitionRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return startCelebrityRecognition(StartCelebrityRecognitionRequest.builder()
.applyMutation(startCelebrityRecognitionRequest).build());
}
/**
*
* 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.
*
*
* @param startContentModerationRequest
* @return Result of the StartContentModeration operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartContentModeration
*/
default StartContentModerationResponse startContentModeration(StartContentModerationRequest startContentModerationRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartContentModerationRequest.Builder} avoiding the
* need to create one manually via {@link StartContentModerationRequest#builder()}
*
*
* @param startContentModerationRequest
* A {@link Consumer} that will call methods on {@link StartContentModerationRequest.Builder} to create a
* request.
* @return Result of the StartContentModeration operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartContentModeration
*/
default StartContentModerationResponse startContentModeration(
Consumer startContentModerationRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return startContentModeration(StartContentModerationRequest.builder().applyMutation(startContentModerationRequest)
.build());
}
/**
*
* 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.
*
*
* @param startFaceDetectionRequest
* @return Result of the StartFaceDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartFaceDetection
*/
default StartFaceDetectionResponse startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartFaceDetectionRequest.Builder} avoiding the
* need to create one manually via {@link StartFaceDetectionRequest#builder()}
*
*
* @param startFaceDetectionRequest
* A {@link Consumer} that will call methods on {@link StartFaceDetectionRequest.Builder} to create a
* request.
* @return Result of the StartFaceDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartFaceDetection
*/
default StartFaceDetectionResponse startFaceDetection(Consumer startFaceDetectionRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return startFaceDetection(StartFaceDetectionRequest.builder().applyMutation(startFaceDetectionRequest).build());
}
/**
*
* 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.
*
*
* @param startFaceSearchRequest
* @return Result of the StartFaceSearch operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartFaceSearch
*/
default StartFaceSearchResponse startFaceSearch(StartFaceSearchRequest startFaceSearchRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartFaceSearchRequest.Builder} avoiding the need
* to create one manually via {@link StartFaceSearchRequest#builder()}
*
*
* @param startFaceSearchRequest
* A {@link Consumer} that will call methods on {@link StartFaceSearchRequest.Builder} to create a request.
* @return Result of the StartFaceSearch operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartFaceSearch
*/
default StartFaceSearchResponse startFaceSearch(Consumer startFaceSearchRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ResourceNotFoundException, ThrottlingException,
AwsServiceException, SdkClientException, RekognitionException {
return startFaceSearch(StartFaceSearchRequest.builder().applyMutation(startFaceSearchRequest).build());
}
/**
*
* 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.
*
*
* @param startLabelDetectionRequest
* @return Result of the StartLabelDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartLabelDetection
*/
default StartLabelDetectionResponse startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartLabelDetectionRequest.Builder} avoiding the
* need to create one manually via {@link StartLabelDetectionRequest#builder()}
*
*
* @param startLabelDetectionRequest
* A {@link Consumer} that will call methods on {@link StartLabelDetectionRequest.Builder} to create a
* request.
* @return Result of the StartLabelDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartLabelDetection
*/
default StartLabelDetectionResponse startLabelDetection(
Consumer startLabelDetectionRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return startLabelDetection(StartLabelDetectionRequest.builder().applyMutation(startLabelDetectionRequest).build());
}
/**
*
* 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.
*
*
* @param startPersonTrackingRequest
* @return Result of the StartPersonTracking operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartPersonTracking
*/
default StartPersonTrackingResponse startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartPersonTrackingRequest.Builder} avoiding the
* need to create one manually via {@link StartPersonTrackingRequest#builder()}
*
*
* @param startPersonTrackingRequest
* A {@link Consumer} that will call methods on {@link StartPersonTrackingRequest.Builder} to create a
* request.
* @return Result of the StartPersonTracking operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartPersonTracking
*/
default StartPersonTrackingResponse startPersonTracking(
Consumer startPersonTrackingRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return startPersonTracking(StartPersonTrackingRequest.builder().applyMutation(startPersonTrackingRequest).build());
}
/**
*
* 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.
*
*
*
* For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon
* Rekognition Custom Labels Guide.
*
*
* This operation requires permissions to perform the rekognition:StartProjectVersion action.
*
*
* @param startProjectVersionRequest
* @return Result of the StartProjectVersion operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartProjectVersion
*/
default StartProjectVersionResponse startProjectVersion(StartProjectVersionRequest startProjectVersionRequest)
throws ResourceNotFoundException, ResourceInUseException, LimitExceededException, InvalidParameterException,
AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon
* Rekognition Custom Labels Guide.
*
*
* This operation requires permissions to perform the rekognition:StartProjectVersion action.
*
*
*
* This is a convenience which creates an instance of the {@link StartProjectVersionRequest.Builder} avoiding the
* need to create one manually via {@link StartProjectVersionRequest#builder()}
*
*
* @param startProjectVersionRequest
* A {@link Consumer} that will call methods on {@link StartProjectVersionRequest.Builder} to create a
* request.
* @return Result of the StartProjectVersion operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartProjectVersion
*/
default StartProjectVersionResponse startProjectVersion(
Consumer startProjectVersionRequest) throws ResourceNotFoundException,
ResourceInUseException, LimitExceededException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return startProjectVersion(StartProjectVersionRequest.builder().applyMutation(startProjectVersionRequest).build());
}
/**
*
* 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.
*
*
* @param startSegmentDetectionRequest
* @return Result of the StartSegmentDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartSegmentDetection
*/
default StartSegmentDetectionResponse startSegmentDetection(StartSegmentDetectionRequest startSegmentDetectionRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartSegmentDetectionRequest.Builder} avoiding the
* need to create one manually via {@link StartSegmentDetectionRequest#builder()}
*
*
* @param startSegmentDetectionRequest
* A {@link Consumer} that will call methods on {@link StartSegmentDetectionRequest.Builder} to create a
* request.
* @return Result of the StartSegmentDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartSegmentDetection
*/
default StartSegmentDetectionResponse startSegmentDetection(
Consumer startSegmentDetectionRequest) throws AccessDeniedException,
IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException,
InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException,
ThrottlingException, AwsServiceException, SdkClientException, RekognitionException {
return startSegmentDetection(StartSegmentDetectionRequest.builder().applyMutation(startSegmentDetectionRequest).build());
}
/**
*
* 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.
*
*
* @param startStreamProcessorRequest
* @return Result of the StartStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartStreamProcessor
*/
default StartStreamProcessorResponse startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartStreamProcessorRequest.Builder} avoiding the
* need to create one manually via {@link StartStreamProcessorRequest#builder()}
*
*
* @param startStreamProcessorRequest
* A {@link Consumer} that will call methods on {@link StartStreamProcessorRequest.Builder} to create a
* request.
* @return Result of the StartStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartStreamProcessor
*/
default StartStreamProcessorResponse startStreamProcessor(
Consumer startStreamProcessorRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException,
ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return startStreamProcessor(StartStreamProcessorRequest.builder().applyMutation(startStreamProcessorRequest).build());
}
/**
*
* 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.
*
*
* @param startTextDetectionRequest
* @return Result of the StartTextDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartTextDetection
*/
default StartTextDetectionResponse startTextDetection(StartTextDetectionRequest startTextDetectionRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartTextDetectionRequest.Builder} avoiding the
* need to create one manually via {@link StartTextDetectionRequest#builder()}
*
*
* @param startTextDetectionRequest
* A {@link Consumer} that will call methods on {@link StartTextDetectionRequest.Builder} to create a
* request.
* @return Result of the StartTextDetection operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws IdempotentParameterMismatchException
* A ClientRequestToken input parameter was reused with an operation, but at least one of the
* other input parameters is different from the previous call to the operation.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws InvalidS3ObjectException
* Amazon Rekognition is unable to access the S3 object specified in the request.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws VideoTooLargeException
* The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum
* duration is 6 hours.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StartTextDetection
*/
default StartTextDetectionResponse startTextDetection(Consumer startTextDetectionRequest)
throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException,
InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException,
ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException,
SdkClientException, RekognitionException {
return startTextDetection(StartTextDetectionRequest.builder().applyMutation(startTextDetectionRequest).build());
}
/**
*
* Stops a running model. The operation might take a while to complete. To check the current status, call
* DescribeProjectVersions.
*
*
* This operation requires permissions to perform the rekognition:StopProjectVersion action.
*
*
* @param stopProjectVersionRequest
* @return Result of the StopProjectVersion operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StopProjectVersion
*/
default StopProjectVersionResponse stopProjectVersion(StopProjectVersionRequest stopProjectVersionRequest)
throws ResourceNotFoundException, ResourceInUseException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Stops a running model. The operation might take a while to complete. To check the current status, call
* DescribeProjectVersions.
*
*
* This operation requires permissions to perform the rekognition:StopProjectVersion action.
*
*
*
* This is a convenience which creates an instance of the {@link StopProjectVersionRequest.Builder} avoiding the
* need to create one manually via {@link StopProjectVersionRequest#builder()}
*
*
* @param stopProjectVersionRequest
* A {@link Consumer} that will call methods on {@link StopProjectVersionRequest.Builder} to create a
* request.
* @return Result of the StopProjectVersion operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StopProjectVersion
*/
default StopProjectVersionResponse stopProjectVersion(Consumer stopProjectVersionRequest)
throws ResourceNotFoundException, ResourceInUseException, InvalidParameterException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return stopProjectVersion(StopProjectVersionRequest.builder().applyMutation(stopProjectVersionRequest).build());
}
/**
*
* Stops a running stream processor that was created by CreateStreamProcessor.
*
*
* @param stopStreamProcessorRequest
* @return Result of the StopStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StopStreamProcessor
*/
default StopStreamProcessorResponse stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* Stops a running stream processor that was created by CreateStreamProcessor.
*
*
*
* This is a convenience which creates an instance of the {@link StopStreamProcessorRequest.Builder} avoiding the
* need to create one manually via {@link StopStreamProcessorRequest#builder()}
*
*
* @param stopStreamProcessorRequest
* A {@link Consumer} that will call methods on {@link StopStreamProcessorRequest.Builder} to create a
* request.
* @return Result of the StopStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.StopStreamProcessor
*/
default StopStreamProcessorResponse stopStreamProcessor(
Consumer stopStreamProcessorRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException,
ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return stopStreamProcessor(StopStreamProcessorRequest.builder().applyMutation(stopStreamProcessorRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.TagResource
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException,
InvalidParameterException, ServiceQuotaExceededException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ServiceQuotaExceededException
*
* The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in
* Amazon Rekognition in the Amazon Rekognition Developer Guide.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.TagResource
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws ResourceNotFoundException, InvalidParameterException, ServiceQuotaExceededException, AccessDeniedException,
InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException,
SdkClientException, RekognitionException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.UntagResource
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException,
InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException,
ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.UntagResource
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ResourceNotFoundException, InvalidParameterException, AccessDeniedException, InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException,
RekognitionException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param updateDatasetEntriesRequest
* @return Result of the UpdateDatasetEntries operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.UpdateDatasetEntries
*/
default UpdateDatasetEntriesResponse updateDatasetEntries(UpdateDatasetEntriesRequest updateDatasetEntriesRequest)
throws InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException,
InvalidParameterException, AccessDeniedException, LimitExceededException, ResourceInUseException,
ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateDatasetEntriesRequest.Builder} avoiding the
* need to create one manually via {@link UpdateDatasetEntriesRequest#builder()}
*
*
* @param updateDatasetEntriesRequest
* A {@link Consumer} that will call methods on {@link UpdateDatasetEntriesRequest.Builder} to create a
* request.
* @return Result of the UpdateDatasetEntries operation returned by the service.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws LimitExceededException
* An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
* Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will
* raise a LimitExceededException exception (HTTP status code: 400) until the number of
* concurrently running jobs is below the Amazon Rekognition service limit.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.UpdateDatasetEntries
*/
default UpdateDatasetEntriesResponse updateDatasetEntries(
Consumer updateDatasetEntriesRequest) throws InternalServerErrorException,
ThrottlingException, ProvisionedThroughputExceededException, InvalidParameterException, AccessDeniedException,
LimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException,
RekognitionException {
return updateDatasetEntries(UpdateDatasetEntriesRequest.builder().applyMutation(updateDatasetEntriesRequest).build());
}
/**
*
* Allows you to update a stream processor. You can change some settings and regions of interest and delete certain
* parameters.
*
*
* @param updateStreamProcessorRequest
* @return Result of the UpdateStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.UpdateStreamProcessor
*/
default UpdateStreamProcessorResponse updateStreamProcessor(UpdateStreamProcessorRequest updateStreamProcessorRequest)
throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException,
ResourceNotFoundException, ProvisionedThroughputExceededException, ResourceInUseException, AwsServiceException,
SdkClientException, RekognitionException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateStreamProcessorRequest.Builder} avoiding the
* need to create one manually via {@link UpdateStreamProcessorRequest#builder()}
*
*
* @param updateStreamProcessorRequest
* A {@link Consumer} that will call methods on {@link UpdateStreamProcessorRequest.Builder} to create a
* request.
* @return Result of the UpdateStreamProcessor operation returned by the service.
* @throws AccessDeniedException
* You are not authorized to perform the action.
* @throws InternalServerErrorException
* Amazon Rekognition experienced a service issue. Try your call again.
* @throws ThrottlingException
* Amazon Rekognition is temporarily unable to process the request. Try your call again.
* @throws InvalidParameterException
* Input parameter violated a constraint. Validate your parameter before calling the API operation again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ProvisionedThroughputExceededException
* The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
* Rekognition.
* @throws ResourceInUseException
* The specified resource is already being used.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RekognitionException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RekognitionClient.UpdateStreamProcessor
*/
default UpdateStreamProcessorResponse updateStreamProcessor(
Consumer updateStreamProcessorRequest) throws AccessDeniedException,
InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException,
ProvisionedThroughputExceededException, ResourceInUseException, AwsServiceException, SdkClientException,
RekognitionException {
return updateStreamProcessor(UpdateStreamProcessorRequest.builder().applyMutation(updateStreamProcessorRequest).build());
}
/**
* Create an instance of {@link 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.
*
* @return an instance of {@link RekognitionWaiter}
*/
default RekognitionWaiter waiter() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link RekognitionClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static RekognitionClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link RekognitionClient}.
*/
static RekognitionClientBuilder builder() {
return new DefaultRekognitionClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default RekognitionServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}