@Generated(value="software.amazon.awssdk:codegen") public interface RekognitionClient extends SdkClient
builder()
method.
This is the Amazon Rekognition API reference.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static RekognitionClientBuilder |
builder()
Create a builder that can be used to configure and create a
RekognitionClient . |
default CompareFacesResponse |
compareFaces(CompareFacesRequest compareFacesRequest)
Compares a face in the source input image with each of the 100 largest faces detected in the target
input image.
|
default CompareFacesResponse |
compareFaces(Consumer<CompareFacesRequest.Builder> compareFacesRequest)
Compares a face in the source input image with each of the 100 largest faces detected in the target
input image.
|
static RekognitionClient |
create()
Create a
RekognitionClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateCollectionResponse |
createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)
Creates a collection in an AWS Region.
|
default CreateCollectionResponse |
createCollection(CreateCollectionRequest createCollectionRequest)
Creates a collection in an AWS Region.
|
default CreateStreamProcessorResponse |
createStreamProcessor(Consumer<CreateStreamProcessorRequest.Builder> createStreamProcessorRequest)
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming
video.
|
default CreateStreamProcessorResponse |
createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest)
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming
video.
|
default DeleteCollectionResponse |
deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)
Deletes the specified collection.
|
default DeleteCollectionResponse |
deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
Deletes the specified collection.
|
default DeleteFacesResponse |
deleteFaces(Consumer<DeleteFacesRequest.Builder> deleteFacesRequest)
Deletes faces from a collection.
|
default DeleteFacesResponse |
deleteFaces(DeleteFacesRequest deleteFacesRequest)
Deletes faces from a collection.
|
default DeleteStreamProcessorResponse |
deleteStreamProcessor(Consumer<DeleteStreamProcessorRequest.Builder> deleteStreamProcessorRequest)
Deletes the stream processor identified by
Name . |
default DeleteStreamProcessorResponse |
deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest)
Deletes the stream processor identified by
Name . |
default DescribeCollectionResponse |
describeCollection(Consumer<DescribeCollectionRequest.Builder> describeCollectionRequest)
Describes the specified collection.
|
default DescribeCollectionResponse |
describeCollection(DescribeCollectionRequest describeCollectionRequest)
Describes the specified collection.
|
default DescribeStreamProcessorResponse |
describeStreamProcessor(Consumer<DescribeStreamProcessorRequest.Builder> describeStreamProcessorRequest)
Provides information about a stream processor created by .
|
default DescribeStreamProcessorResponse |
describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest)
Provides information about a stream processor created by .
|
default DetectFacesResponse |
detectFaces(Consumer<DetectFacesRequest.Builder> detectFacesRequest)
Detects faces within an image that is provided as input.
|
default DetectFacesResponse |
detectFaces(DetectFacesRequest detectFacesRequest)
Detects faces within an image that is provided as input.
|
default DetectLabelsResponse |
detectLabels(Consumer<DetectLabelsRequest.Builder> detectLabelsRequest)
Detects instances of real-world entities within an image (JPEG or PNG) provided as input.
|
default DetectLabelsResponse |
detectLabels(DetectLabelsRequest detectLabelsRequest)
Detects instances of real-world entities within an image (JPEG or PNG) provided as input.
|
default DetectModerationLabelsResponse |
detectModerationLabels(Consumer<DetectModerationLabelsRequest.Builder> detectModerationLabelsRequest)
Detects explicit or suggestive adult content in a specified JPEG or PNG format image.
|
default DetectModerationLabelsResponse |
detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest)
Detects explicit or suggestive adult content in a specified JPEG or PNG format image.
|
default DetectTextResponse |
detectText(Consumer<DetectTextRequest.Builder> detectTextRequest)
Detects text in the input image and converts it into machine-readable text.
|
default DetectTextResponse |
detectText(DetectTextRequest detectTextRequest)
Detects text in the input image and converts it into machine-readable text.
|
default GetCelebrityInfoResponse |
getCelebrityInfo(Consumer<GetCelebrityInfoRequest.Builder> getCelebrityInfoRequest)
Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID.
|
default GetCelebrityInfoResponse |
getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest)
Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID.
|
default GetCelebrityRecognitionResponse |
getCelebrityRecognition(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest)
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
|
default GetCelebrityRecognitionResponse |
getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
|
default GetCelebrityRecognitionIterable |
getCelebrityRecognitionPaginator(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest)
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
|
default GetCelebrityRecognitionIterable |
getCelebrityRecognitionPaginator(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest)
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
|
default GetContentModerationResponse |
getContentModeration(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest)
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
|
default GetContentModerationResponse |
getContentModeration(GetContentModerationRequest getContentModerationRequest)
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
|
default GetContentModerationIterable |
getContentModerationPaginator(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest)
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
|
default GetContentModerationIterable |
getContentModerationPaginator(GetContentModerationRequest getContentModerationRequest)
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
|
default GetFaceDetectionResponse |
getFaceDetection(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest)
Gets face detection results for a Amazon Rekognition Video analysis started by .
|
default GetFaceDetectionResponse |
getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest)
Gets face detection results for a Amazon Rekognition Video analysis started by .
|
default GetFaceDetectionIterable |
getFaceDetectionPaginator(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest)
Gets face detection results for a Amazon Rekognition Video analysis started by .
|
default GetFaceDetectionIterable |
getFaceDetectionPaginator(GetFaceDetectionRequest getFaceDetectionRequest)
Gets face detection results for a Amazon Rekognition Video analysis started by .
|
default GetFaceSearchResponse |
getFaceSearch(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest)
Gets the face search results for Amazon Rekognition Video face search started by .
|
default GetFaceSearchResponse |
getFaceSearch(GetFaceSearchRequest getFaceSearchRequest)
Gets the face search results for Amazon Rekognition Video face search started by .
|
default GetFaceSearchIterable |
getFaceSearchPaginator(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest)
Gets the face search results for Amazon Rekognition Video face search started by .
|
default GetFaceSearchIterable |
getFaceSearchPaginator(GetFaceSearchRequest getFaceSearchRequest)
Gets the face search results for Amazon Rekognition Video face search started by .
|
default GetLabelDetectionResponse |
getLabelDetection(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest)
Gets the label detection results of a Amazon Rekognition Video analysis started by .
|
default GetLabelDetectionResponse |
getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest)
Gets the label detection results of a Amazon Rekognition Video analysis started by .
|
default GetLabelDetectionIterable |
getLabelDetectionPaginator(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest)
Gets the label detection results of a Amazon Rekognition Video analysis started by .
|
default GetLabelDetectionIterable |
getLabelDetectionPaginator(GetLabelDetectionRequest getLabelDetectionRequest)
Gets the label detection results of a Amazon Rekognition Video analysis started by .
|
default GetPersonTrackingResponse |
getPersonTracking(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest)
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
|
default GetPersonTrackingResponse |
getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest)
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
|
default GetPersonTrackingIterable |
getPersonTrackingPaginator(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest)
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
|
default GetPersonTrackingIterable |
getPersonTrackingPaginator(GetPersonTrackingRequest getPersonTrackingRequest)
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
|
default IndexFacesResponse |
indexFaces(Consumer<IndexFacesRequest.Builder> indexFacesRequest)
Detects faces in the input image and adds them to the specified collection.
|
default IndexFacesResponse |
indexFaces(IndexFacesRequest indexFacesRequest)
Detects faces in the input image and adds them to the specified collection.
|
default ListCollectionsResponse |
listCollections()
Returns list of collection IDs in your account.
|
default ListCollectionsResponse |
listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
Returns list of collection IDs in your account.
|
default ListCollectionsResponse |
listCollections(ListCollectionsRequest listCollectionsRequest)
Returns list of collection IDs in your account.
|
default ListCollectionsIterable |
listCollectionsPaginator()
Returns list of collection IDs in your account.
|
default ListCollectionsIterable |
listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
Returns list of collection IDs in your account.
|
default ListCollectionsIterable |
listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
Returns list of collection IDs in your account.
|
default ListFacesResponse |
listFaces(Consumer<ListFacesRequest.Builder> listFacesRequest)
Returns metadata for faces in the specified collection.
|
default ListFacesResponse |
listFaces(ListFacesRequest listFacesRequest)
Returns metadata for faces in the specified collection.
|
default ListFacesIterable |
listFacesPaginator(Consumer<ListFacesRequest.Builder> listFacesRequest)
Returns metadata for faces in the specified collection.
|
default ListFacesIterable |
listFacesPaginator(ListFacesRequest listFacesRequest)
Returns metadata for faces in the specified collection.
|
default ListStreamProcessorsResponse |
listStreamProcessors()
Gets a list of stream processors that you have created with .
|
default ListStreamProcessorsResponse |
listStreamProcessors(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest)
Gets a list of stream processors that you have created with .
|
default ListStreamProcessorsResponse |
listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest)
Gets a list of stream processors that you have created with .
|
default ListStreamProcessorsIterable |
listStreamProcessorsPaginator()
Gets a list of stream processors that you have created with .
|
default ListStreamProcessorsIterable |
listStreamProcessorsPaginator(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest)
Gets a list of stream processors that you have created with .
|
default ListStreamProcessorsIterable |
listStreamProcessorsPaginator(ListStreamProcessorsRequest listStreamProcessorsRequest)
Gets a list of stream processors that you have created with .
|
default RecognizeCelebritiesResponse |
recognizeCelebrities(Consumer<RecognizeCelebritiesRequest.Builder> recognizeCelebritiesRequest)
Returns an array of celebrities recognized in the input image.
|
default RecognizeCelebritiesResponse |
recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest)
Returns an array of celebrities recognized in the input image.
|
default SearchFacesResponse |
searchFaces(Consumer<SearchFacesRequest.Builder> searchFacesRequest)
For a given input face ID, searches for matching faces in the collection the face belongs to.
|
default SearchFacesResponse |
searchFaces(SearchFacesRequest searchFacesRequest)
For a given input face ID, searches for matching faces in the collection the face belongs to.
|
default SearchFacesByImageResponse |
searchFacesByImage(Consumer<SearchFacesByImageRequest.Builder> searchFacesByImageRequest)
For a given input image, first detects the largest face in the image, and then searches the specified collection
for matching faces.
|
default SearchFacesByImageResponse |
searchFacesByImage(SearchFacesByImageRequest searchFacesByImageRequest)
For a given input image, first detects the largest face in the image, and then searches the specified collection
for matching faces.
|
static ServiceMetadata |
serviceMetadata() |
default StartCelebrityRecognitionResponse |
startCelebrityRecognition(Consumer<StartCelebrityRecognitionRequest.Builder> startCelebrityRecognitionRequest)
Starts asynchronous recognition of celebrities in a stored video.
|
default StartCelebrityRecognitionResponse |
startCelebrityRecognition(StartCelebrityRecognitionRequest startCelebrityRecognitionRequest)
Starts asynchronous recognition of celebrities in a stored video.
|
default StartContentModerationResponse |
startContentModeration(Consumer<StartContentModerationRequest.Builder> startContentModerationRequest)
Starts asynchronous detection of explicit or suggestive adult content in a stored video.
|
default StartContentModerationResponse |
startContentModeration(StartContentModerationRequest startContentModerationRequest)
Starts asynchronous detection of explicit or suggestive adult content in a stored video.
|
default StartFaceDetectionResponse |
startFaceDetection(Consumer<StartFaceDetectionRequest.Builder> startFaceDetectionRequest)
Starts asynchronous detection of faces in a stored video.
|
default StartFaceDetectionResponse |
startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest)
Starts asynchronous detection of faces in a stored video.
|
default StartFaceSearchResponse |
startFaceSearch(Consumer<StartFaceSearchRequest.Builder> startFaceSearchRequest)
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored
video.
|
default StartFaceSearchResponse |
startFaceSearch(StartFaceSearchRequest startFaceSearchRequest)
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored
video.
|
default StartLabelDetectionResponse |
startLabelDetection(Consumer<StartLabelDetectionRequest.Builder> startLabelDetectionRequest)
Starts asynchronous detection of labels in a stored video.
|
default StartLabelDetectionResponse |
startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest)
Starts asynchronous detection of labels in a stored video.
|
default StartPersonTrackingResponse |
startPersonTracking(Consumer<StartPersonTrackingRequest.Builder> startPersonTrackingRequest)
Starts the asynchronous tracking of a person's path in a stored video.
|
default StartPersonTrackingResponse |
startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest)
Starts the asynchronous tracking of a person's path in a stored video.
|
default StartStreamProcessorResponse |
startStreamProcessor(Consumer<StartStreamProcessorRequest.Builder> startStreamProcessorRequest)
Starts processing a stream processor.
|
default StartStreamProcessorResponse |
startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest)
Starts processing a stream processor.
|
default StopStreamProcessorResponse |
stopStreamProcessor(Consumer<StopStreamProcessorRequest.Builder> stopStreamProcessorRequest)
Stops a running stream processor that was created by .
|
default StopStreamProcessorResponse |
stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest)
Stops a running stream processor that was created by .
|
serviceName
close
static final String SERVICE_NAME
static RekognitionClient create()
RekognitionClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static RekognitionClientBuilder builder()
RekognitionClient
.default CompareFacesResponse compareFaces(CompareFacesRequest compareFacesRequest) throws InvalidParameterException, InvalidS3ObjectException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.
You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.
By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You
can change this value by specifying the SimilarityThreshold
parameter.
CompareFaces
also returns an array of faces that don't match the source image. For each face, it
returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns
information about the face in the source image, including the bounding box of the face and confidence value.
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.
compareFacesRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CompareFacesResponse compareFaces(Consumer<CompareFacesRequest.Builder> compareFacesRequest) throws InvalidParameterException, InvalidS3ObjectException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.
You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.
By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You
can change this value by specifying the SimilarityThreshold
parameter.
CompareFaces
also returns an array of faces that don't match the source image. For each face, it
returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns
information about the face in the source image, including the bounding box of the face and confidence value.
If the image doesn't contain Exif metadata, CompareFaces
returns orientation information for the
source and target images. Use these values to display the images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces
returns an
InvalidParameterException
error.
This is a stateless API operation. That is, data returned by this operation doesn't persist.
For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:CompareFaces
action.
This is a convenience which creates an instance of the CompareFacesRequest.Builder
avoiding the need to
create one manually via CompareFacesRequest.builder()
compareFacesRequest
- A Consumer
that will call methods on CompareFacesRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCollectionResponse createCollection(CreateCollectionRequest createCollectionRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, RekognitionException
Creates a collection in an AWS Region. You can add faces to the collection using the 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.
createCollectionRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceAlreadyExistsException
- A collection with the specified ID already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCollectionResponse createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, RekognitionException
Creates a collection in an AWS Region. You can add faces to the collection using the 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.
This is a convenience which creates an instance of the CreateCollectionRequest.Builder
avoiding the need
to create one manually via CreateCollectionRequest.builder()
createCollectionRequest
- A Consumer
that will call methods on CreateCollectionRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceAlreadyExistsException
- A collection with the specified ID already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStreamProcessorResponse createStreamProcessor(CreateStreamProcessorRequest createStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, LimitExceededException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input
) and a Kinesis data stream (Output
)
stream. You also specify the face recognition criteria in Settings
. For example, the collection
containing faces that you want to recognize. Use Name
to assign an identifier for the stream
processor. You use Name
to manage the stream processor. For example, you can start processing the
source video by calling with the Name
field.
After you have finished analyzing a streaming video, use to stop processing. You can delete the stream processor by calling .
createStreamProcessorRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStreamProcessorResponse createStreamProcessor(Consumer<CreateStreamProcessorRequest.Builder> createStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, LimitExceededException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input
) and a Kinesis data stream (Output
)
stream. You also specify the face recognition criteria in Settings
. For example, the collection
containing faces that you want to recognize. Use Name
to assign an identifier for the stream
processor. You use Name
to manage the stream processor. For example, you can start processing the
source video by calling with the Name
field.
After you have finished analyzing a streaming video, use to stop processing. You can delete the stream processor by calling .
This is a convenience which creates an instance of the CreateStreamProcessorRequest.Builder
avoiding the
need to create one manually via CreateStreamProcessorRequest.builder()
createStreamProcessorRequest
- A Consumer
that will call methods on CreateStreamProcessorRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCollectionResponse deleteCollection(DeleteCollectionRequest deleteCollectionRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.
This operation requires permissions to perform the rekognition:DeleteCollection
action.
deleteCollectionRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCollectionResponse deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.
This operation requires permissions to perform the rekognition:DeleteCollection
action.
This is a convenience which creates an instance of the DeleteCollectionRequest.Builder
avoiding the need
to create one manually via DeleteCollectionRequest.builder()
deleteCollectionRequest
- A Consumer
that will call methods on DeleteCollectionRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteFacesResponse deleteFaces(DeleteFacesRequest deleteFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces
action.
deleteFacesRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteFacesResponse deleteFaces(Consumer<DeleteFacesRequest.Builder> deleteFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces
action.
This is a convenience which creates an instance of the DeleteFacesRequest.Builder
avoiding the need to
create one manually via DeleteFacesRequest.builder()
deleteFacesRequest
- A Consumer
that will call methods on DeleteFacesRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteStreamProcessorResponse deleteStreamProcessor(DeleteStreamProcessorRequest deleteStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Deletes the stream processor identified by Name
. You assign the value for Name
when you
create the stream processor with . You might not be able to use the same name for a stream processor for a few
seconds after calling DeleteStreamProcessor
.
deleteStreamProcessorRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteStreamProcessorResponse deleteStreamProcessor(Consumer<DeleteStreamProcessorRequest.Builder> deleteStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Deletes the stream processor identified by Name
. You assign the value for Name
when you
create the stream processor with . You might not be able to use the same name for a stream processor for a few
seconds after calling DeleteStreamProcessor
.
This is a convenience which creates an instance of the DeleteStreamProcessorRequest.Builder
avoiding the
need to create one manually via DeleteStreamProcessorRequest.builder()
deleteStreamProcessorRequest
- A Consumer
that will call methods on DeleteStreamProcessorRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCollectionResponse describeCollection(DescribeCollectionRequest describeCollectionRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Describes the specified collection. You can use DescribeCollection
to get information, such as the
number of faces indexed into a collection and the version of the model used by the collection for face detection.
For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
describeCollectionRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCollectionResponse describeCollection(Consumer<DescribeCollectionRequest.Builder> describeCollectionRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Describes the specified collection. You can use DescribeCollection
to get information, such as the
number of faces indexed into a collection and the version of the model used by the collection for face detection.
For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
This is a convenience which creates an instance of the DescribeCollectionRequest.Builder
avoiding the
need to create one manually via DescribeCollectionRequest.builder()
describeCollectionRequest
- A Consumer
that will call methods on DescribeCollectionRequest.Builder
to create a
request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeStreamProcessorResponse describeStreamProcessor(DescribeStreamProcessorRequest describeStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Provides information about a stream processor created by . 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.
describeStreamProcessorRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeStreamProcessorResponse describeStreamProcessor(Consumer<DescribeStreamProcessorRequest.Builder> describeStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Provides information about a stream processor created by . You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
This is a convenience which creates an instance of the DescribeStreamProcessorRequest.Builder
avoiding
the need to create one manually via DescribeStreamProcessorRequest.builder()
describeStreamProcessorRequest
- A Consumer
that will call methods on DescribeStreamProcessorRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectFacesResponse detectFaces(DetectFacesRequest detectFacesRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects faces within an image that is provided as input.
DetectFaces
detects the 100 largest faces in the image. For each face detected, the operation
returns face details. These details include a bounding box of the face, a confidence value (that the bounding box
contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and
mouth), gender, presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the 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.
detectFacesRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectFacesResponse detectFaces(Consumer<DetectFacesRequest.Builder> detectFacesRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects faces within an image that is provided as input.
DetectFaces
detects the 100 largest faces in the image. For each face detected, the operation
returns face details. These details include a bounding box of the face, a confidence value (that the bounding box
contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and
mouth), gender, presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectFaces
action.
This is a convenience which creates an instance of the DetectFacesRequest.Builder
avoiding the need to
create one manually via DetectFacesRequest.builder()
detectFacesRequest
- A Consumer
that will call methods on DetectFacesRequest.Builder
to create a request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectLabelsResponse detectLabels(DetectLabelsRequest detectLabelsRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels
does not support the detection of activities. However, activity detection is supported
for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer
Guide.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation
correction. Optionally, you can specify MinConfidence
to control the confidence threshold for the
labels returned. The default is 50%. You can also add the MaxLabels
parameter to limit the number of
labels returned.
If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.
DetectLabels
returns bounding boxes for instances of common object labels in an array of objects. An
Instance
object contains a object, for the location of the label on the image. It also includes the
confidence by which the bounding box was detected.
DetectLabels
also returns a hierarchical taxonomy of detected labels. For example, a detected car
might be assigned the label car. The label car has two parent labels: Vehicle (its parent)
and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each
ancestor is a unique label in the response. In the previous example, Car, Vehicle, and
Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels
action.
detectLabelsRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectLabelsResponse detectLabels(Consumer<DetectLabelsRequest.Builder> detectLabelsRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels
does not support the detection of activities. However, activity detection is supported
for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer
Guide.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation
correction. Optionally, you can specify MinConfidence
to control the confidence threshold for the
labels returned. The default is 50%. You can also add the MaxLabels
parameter to limit the number of
labels returned.
If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.
DetectLabels
returns bounding boxes for instances of common object labels in an array of objects. An
Instance
object contains a object, for the location of the label on the image. It also includes the
confidence by which the bounding box was detected.
DetectLabels
also returns a hierarchical taxonomy of detected labels. For example, a detected car
might be assigned the label car. The label car has two parent labels: Vehicle (its parent)
and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each
ancestor is a unique label in the response. In the previous example, Car, Vehicle, and
Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels
action.
This is a convenience which creates an instance of the DetectLabelsRequest.Builder
avoiding the need to
create one manually via DetectLabelsRequest.builder()
detectLabelsRequest
- A Consumer
that will call methods on DetectLabelsRequest.Builder
to create a request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectModerationLabelsResponse detectModerationLabels(DetectModerationLabelsRequest detectModerationLabelsRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects explicit or suggestive adult 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.
detectModerationLabelsRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectModerationLabelsResponse detectModerationLabels(Consumer<DetectModerationLabelsRequest.Builder> detectModerationLabelsRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects explicit or suggestive adult 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 DetectModerationLabelsRequest.Builder
avoiding the
need to create one manually via DetectModerationLabelsRequest.builder()
detectModerationLabelsRequest
- A Consumer
that will call methods on DetectModerationLabelsRequest.Builder
to create a
request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectTextResponse detectText(DetectTextRequest detectTextRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects text in the input image and converts it into machine-readable text.
Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.
The DetectText
operation returns text in an array of elements, TextDetections
. Each
TextDetection
element provides information about a single word or line of text that was detected in
the image.
A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText
can detect up to 50 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's
license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when
there is a large gap between words, relative to the length of the words. This means, depending on the gap between
words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't
represent the end of a line. If a sentence spans multiple lines, the DetectText
operation returns
multiple lines.
To determine whether a TextDetection
element is a line of text or a word, use the
TextDetection
object Type
field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.
For more information, see DetectText in the Amazon Rekognition Developer Guide.
detectTextRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectTextResponse detectText(Consumer<DetectTextRequest.Builder> detectTextRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects text in the input image and converts it into machine-readable text.
Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.
The DetectText
operation returns text in an array of elements, TextDetections
. Each
TextDetection
element provides information about a single word or line of text that was detected in
the image.
A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText
can detect up to 50 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's
license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when
there is a large gap between words, relative to the length of the words. This means, depending on the gap between
words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't
represent the end of a line. If a sentence spans multiple lines, the DetectText
operation returns
multiple lines.
To determine whether a TextDetection
element is a line of text or a word, use the
TextDetection
object Type
field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.
For more information, see DetectText in the Amazon Rekognition Developer Guide.
This is a convenience which creates an instance of the DetectTextRequest.Builder
avoiding the need to
create one manually via DetectTextRequest.builder()
detectTextRequest
- A Consumer
that will call methods on DetectTextRequest.Builder
to create a request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCelebrityInfoResponse getCelebrityInfo(GetCelebrityInfoRequest getCelebrityInfoRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo
action.
getCelebrityInfoRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCelebrityInfoResponse getCelebrityInfo(Consumer<GetCelebrityInfoRequest.Builder> getCelebrityInfoRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo
action.
This is a convenience which creates an instance of the GetCelebrityInfoRequest.Builder
avoiding the need
to create one manually via GetCelebrityInfoRequest.builder()
getCelebrityInfoRequest
- A Consumer
that will call methods on GetCelebrityInfoRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCelebrityRecognitionResponse getCelebrityRecognition(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to 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 objects. Each CelebrityRecognition
contains information about the
celebrity in a object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You
can also sort the array by celebrity by specifying the value ID
in the SortBy
input
parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you
don't store the additional information urls, you can get them later by calling 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
.
getCelebrityRecognitionRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCelebrityRecognitionResponse getCelebrityRecognition(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to 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 objects. Each CelebrityRecognition
contains information about the
celebrity in a object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You
can also sort the array by celebrity by specifying the value ID
in the SortBy
input
parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you
don't store the additional information urls, you can get them later by calling with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in
MaxResults
, the value of NextToken
in the operation response contains a pagination
token for getting the next set of results. To get the next page of results, call
GetCelebrityDetection
and populate the NextToken
request parameter with the token value
returned from the previous call to GetCelebrityRecognition
.
This is a convenience which creates an instance of the GetCelebrityRecognitionRequest.Builder
avoiding
the need to create one manually via GetCelebrityRecognitionRequest.builder()
getCelebrityRecognitionRequest
- A Consumer
that will call methods on GetCelebrityRecognitionRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCelebrityRecognitionIterable getCelebrityRecognitionPaginator(GetCelebrityRecognitionRequest getCelebrityRecognitionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to 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 objects. Each CelebrityRecognition
contains information about the
celebrity in a object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You
can also sort the array by celebrity by specifying the value ID
in the SortBy
input
parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you
don't store the additional information urls, you can get them later by calling 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
getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client .getCelebrityRecognitionPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest)
operation.
getCelebrityRecognitionRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCelebrityRecognitionIterable getCelebrityRecognitionPaginator(Consumer<GetCelebrityRecognitionRequest.Builder> getCelebrityRecognitionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to 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 objects. Each CelebrityRecognition
contains information about the
celebrity in a object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You
can also sort the array by celebrity by specifying the value ID
in the SortBy
input
parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you
don't store the additional information urls, you can get them later by calling 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
getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client .getCelebrityRecognitionPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetCelebrityRecognitionIterable responses = client.getCelebrityRecognitionPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getCelebrityRecognition(software.amazon.awssdk.services.rekognition.model.GetCelebrityRecognitionRequest)
operation.
This is a convenience which creates an instance of the GetCelebrityRecognitionRequest.Builder
avoiding
the need to create one manually via GetCelebrityRecognitionRequest.builder()
getCelebrityRecognitionRequest
- A Consumer
that will call methods on GetCelebrityRecognitionRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContentModerationResponse getContentModeration(GetContentModerationRequest getContentModerationRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . 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 moderation 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 Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in
an array, ModerationLabels
, of objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You
can also sort them by moderated label by specifying NAME
for the SortBy
input
parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the
number of labels returned in a single call to GetContentModeration
. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetContentModeration
and populate the NextToken
request parameter with the value of
NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
getContentModerationRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContentModerationResponse getContentModeration(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . 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 moderation 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 Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in
an array, ModerationLabels
, of objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You
can also sort them by moderated label by specifying NAME
for the SortBy
input
parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the
number of labels returned in a single call to GetContentModeration
. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetContentModeration
and populate the NextToken
request parameter with the value of
NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
This is a convenience which creates an instance of the GetContentModerationRequest.Builder
avoiding the
need to create one manually via GetContentModerationRequest.builder()
getContentModerationRequest
- A Consumer
that will call methods on GetContentModerationRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContentModerationIterable getContentModerationPaginator(GetContentModerationRequest getContentModerationRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . 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 moderation 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 Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in
an array, ModerationLabels
, of objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You
can also sort them by moderated label by specifying NAME
for the SortBy
input
parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the
number of labels returned in a single call to GetContentModeration
. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetContentModeration
and populate the NextToken
request parameter with the value of
NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
This is a variant of
getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client .getContentModerationPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetContentModerationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest)
operation.
getContentModerationRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContentModerationIterable getContentModerationPaginator(Consumer<GetContentModerationRequest.Builder> getContentModerationRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . 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 moderation 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 Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in
an array, ModerationLabels
, of objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You
can also sort them by moderated label by specifying NAME
for the SortBy
input
parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the
number of labels returned in a single call to GetContentModeration
. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetContentModeration
and populate the NextToken
request parameter with the value of
NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
This is a variant of
getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client .getContentModerationPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetContentModerationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetContentModerationIterable responses = client.getContentModerationPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getContentModeration(software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest)
operation.
This is a convenience which creates an instance of the GetContentModerationRequest.Builder
avoiding the
need to create one manually via GetContentModerationRequest.builder()
getContentModerationRequest
- A Consumer
that will call methods on GetContentModerationRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceDetectionResponse getFaceDetection(GetFaceDetectionRequest getFaceDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets face detection results for a Amazon Rekognition Video analysis started by .
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling
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 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
.
getFaceDetectionRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceDetectionResponse getFaceDetection(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets face detection results for a Amazon Rekognition Video analysis started by .
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling
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 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 GetFaceDetectionRequest.Builder
avoiding the need
to create one manually via GetFaceDetectionRequest.builder()
getFaceDetectionRequest
- A Consumer
that will call methods on GetFaceDetectionRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceDetectionIterable getFaceDetectionPaginator(GetFaceDetectionRequest getFaceDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets face detection results for a Amazon Rekognition Video analysis started by .
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling
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 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
getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client .getFaceDetectionPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetFaceDetectionResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest)
operation.
getFaceDetectionRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceDetectionIterable getFaceDetectionPaginator(Consumer<GetFaceDetectionRequest.Builder> getFaceDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets face detection results for a Amazon Rekognition Video analysis started by .
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling
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 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
getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client .getFaceDetectionPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetFaceDetectionResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetFaceDetectionIterable responses = client.getFaceDetectionPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getFaceDetection(software.amazon.awssdk.services.rekognition.model.GetFaceDetectionRequest)
operation.
This is a convenience which creates an instance of the GetFaceDetectionRequest.Builder
avoiding the need
to create one manually via GetFaceDetectionRequest.builder()
getFaceDetectionRequest
- A Consumer
that will call methods on GetFaceDetectionRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceSearchResponse getFaceSearch(GetFaceSearchRequest getFaceSearchRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the face search results for Amazon Rekognition Video face search started by . 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 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 objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes,
bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video,
persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
getFaceSearchRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceSearchResponse getFaceSearch(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the face search results for Amazon Rekognition Video face search started by . 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 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 objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes,
bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video,
persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
This is a convenience which creates an instance of the GetFaceSearchRequest.Builder
avoiding the need to
create one manually via GetFaceSearchRequest.builder()
getFaceSearchRequest
- A Consumer
that will call methods on GetFaceSearchRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceSearchIterable getFaceSearchPaginator(GetFaceSearchRequest getFaceSearchRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the face search results for Amazon Rekognition Video face search started by . 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 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 objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes,
bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video,
persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
This is a variant of
getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client .getFaceSearchPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetFaceSearchResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest)
operation.
getFaceSearchRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFaceSearchIterable getFaceSearchPaginator(Consumer<GetFaceSearchRequest.Builder> getFaceSearchRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the face search results for Amazon Rekognition Video face search started by . 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 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 objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes,
bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned. For more
information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video,
persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
This is a variant of
getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client .getFaceSearchPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetFaceSearchResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetFaceSearchIterable responses = client.getFaceSearchPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getFaceSearch(software.amazon.awssdk.services.rekognition.model.GetFaceSearchRequest)
operation.
This is a convenience which creates an instance of the GetFaceSearchRequest.Builder
avoiding the need to
create one manually via GetFaceSearchRequest.builder()
getFaceSearchRequest
- A Consumer
that will call methods on GetFaceSearchRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLabelDetectionResponse getLabelDetection(GetLabelDetectionRequest getLabelDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the label detection results of a Amazon Rekognition Video analysis started by .
The label detection operation is started by a call to 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 and pass the job identifier (JobId
) from the initial call to
StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the
labels were detected. You can also sort by the label name by specifying NAME
for the
SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
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
.
GetLabelDetection
doesn't return a hierarchical taxonomy, or bounding box information, for detected
labels. GetLabelDetection
returns null
for the Parents
and
Instances
attributes of the object which is returned in the Labels
array.
getLabelDetectionRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLabelDetectionResponse getLabelDetection(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the label detection results of a Amazon Rekognition Video analysis started by .
The label detection operation is started by a call to 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 and pass the job identifier (JobId
) from the initial call to
StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the
labels were detected. You can also sort by the label name by specifying NAME
for the
SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
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
.
GetLabelDetection
doesn't return a hierarchical taxonomy, or bounding box information, for detected
labels. GetLabelDetection
returns null
for the Parents
and
Instances
attributes of the object which is returned in the Labels
array.
This is a convenience which creates an instance of the GetLabelDetectionRequest.Builder
avoiding the need
to create one manually via GetLabelDetectionRequest.builder()
getLabelDetectionRequest
- A Consumer
that will call methods on GetLabelDetectionRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLabelDetectionIterable getLabelDetectionPaginator(GetLabelDetectionRequest getLabelDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the label detection results of a Amazon Rekognition Video analysis started by .
The label detection operation is started by a call to 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 and pass the job identifier (JobId
) from the initial call to
StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the
labels were detected. You can also sort by the label name by specifying NAME
for the
SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
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
.
GetLabelDetection
doesn't return a hierarchical taxonomy, or bounding box information, for detected
labels. GetLabelDetection
returns null
for the Parents
and
Instances
attributes of the object which is returned in the Labels
array.
This is a variant of
getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client .getLabelDetectionPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetLabelDetectionResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest)
operation.
getLabelDetectionRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLabelDetectionIterable getLabelDetectionPaginator(Consumer<GetLabelDetectionRequest.Builder> getLabelDetectionRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the label detection results of a Amazon Rekognition Video analysis started by .
The label detection operation is started by a call to 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 and pass the job identifier (JobId
) from the initial call to
StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the
labels were detected. You can also sort by the label name by specifying NAME
for the
SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
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
.
GetLabelDetection
doesn't return a hierarchical taxonomy, or bounding box information, for detected
labels. GetLabelDetection
returns null
for the Parents
and
Instances
attributes of the object which is returned in the Labels
array.
This is a variant of
getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client .getLabelDetectionPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetLabelDetectionResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetLabelDetectionIterable responses = client.getLabelDetectionPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getLabelDetection(software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest)
operation.
This is a convenience which creates an instance of the GetLabelDetectionRequest.Builder
avoiding the need
to create one manually via GetLabelDetectionRequest.builder()
getLabelDetectionRequest
- A Consumer
that will call methods on GetLabelDetectionRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPersonTrackingResponse getPersonTracking(GetPersonTrackingRequest getPersonTrackingRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
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 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
.
getPersonTrackingRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPersonTrackingResponse getPersonTracking(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
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 and pass the job identifier (JobId
) from the
initial call to StartPersonTracking
.
GetPersonTracking
returns an array, Persons
, of tracked persons and the time(s) their
paths were tracked in the video.
GetPersonTracking
only returns the default facial attributes (BoundingBox
,
Confidence
, Landmarks
, Pose
, and Quality
). The other facial
attributes listed in the Face
object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked
persons by specifying INDEX
for the SortBy
input parameter.
Use the MaxResults
parameter to limit the number of items returned. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetPersonTracking
and populate the NextToken
request parameter with the token value
returned from the previous call to GetPersonTracking
.
This is a convenience which creates an instance of the GetPersonTrackingRequest.Builder
avoiding the need
to create one manually via GetPersonTrackingRequest.builder()
getPersonTrackingRequest
- A Consumer
that will call methods on GetPersonTrackingRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPersonTrackingIterable getPersonTrackingPaginator(GetPersonTrackingRequest getPersonTrackingRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
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 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
getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client .getPersonTrackingPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetPersonTrackingResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest)
operation.
getPersonTrackingRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPersonTrackingIterable getPersonTrackingPaginator(Consumer<GetPersonTrackingRequest.Builder> getPersonTrackingRequest) throws AccessDeniedException, InternalServerErrorException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
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 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
getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client .getPersonTrackingPaginator(request); for (software.amazon.awssdk.services.rekognition.model.GetPersonTrackingResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.GetPersonTrackingIterable responses = client.getPersonTrackingPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getPersonTracking(software.amazon.awssdk.services.rekognition.model.GetPersonTrackingRequest)
operation.
This is a convenience which creates an instance of the GetPersonTrackingRequest.Builder
avoiding the need
to create one manually via GetPersonTrackingRequest.builder()
getPersonTrackingRequest
- A Consumer
that will call methods on GetPersonTrackingRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default IndexFacesResponse indexFaces(IndexFacesRequest indexFacesRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the and 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 .
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 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 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 the
required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By
default, IndexFaces
filters detected faces. You can also explicitly filter detected faces by
specifying AUTO
for the value of QualityFilter
. 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. To get the version of the face model associated with a collection, call .
Information about faces detected in an image, but not indexed, is returned in an array of 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.
In response, the IndexFaces
operation returns an array of metadata for all detected faces,
FaceRecords
. This includes:
The bounding box, BoundingBox
, of the detected face.
A confidence value, Confidence
, which indicates the confidence that the bounding box contains a
face.
A face ID, faceId
, assigned by the service for each face that's detected and stored.
An image ID, ImageId
, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes
parameter), Amazon
Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth)
and other facial attributes like gender. 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.
indexFacesRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default IndexFacesResponse indexFaces(Consumer<IndexFacesRequest.Builder> indexFacesRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the and 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 .
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 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 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 the
required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By
default, IndexFaces
filters detected faces. You can also explicitly filter detected faces by
specifying AUTO
for the value of QualityFilter
. 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. To get the version of the face model associated with a collection, call .
Information about faces detected in an image, but not indexed, is returned in an array of 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.
In response, the IndexFaces
operation returns an array of metadata for all detected faces,
FaceRecords
. This includes:
The bounding box, BoundingBox
, of the detected face.
A confidence value, Confidence
, which indicates the confidence that the bounding box contains a
face.
A face ID, faceId
, assigned by the service for each face that's detected and stored.
An image ID, ImageId
, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes
parameter), Amazon
Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth)
and other facial attributes like gender. If you provide the same image, specify the same collection, and use the
same external ID in the IndexFaces
operation, Amazon Rekognition doesn't save duplicate face
metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces
action.
This is a convenience which creates an instance of the IndexFacesRequest.Builder
avoiding the need to
create one manually via IndexFacesRequest.builder()
indexFacesRequest
- A Consumer
that will call methods on IndexFacesRequest.Builder
to create a request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCollectionsResponse listCollections() throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns list of collection IDs in your account. If the result is truncated, the response also provides a
NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCollections(ListCollectionsRequest)
default ListCollectionsResponse listCollections(ListCollectionsRequest listCollectionsRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns list of collection IDs in your account. If the result is truncated, the response also provides a
NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
listCollectionsRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCollectionsResponse listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns list of collection IDs in your account. If the result is truncated, the response also provides a
NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
This is a convenience which creates an instance of the ListCollectionsRequest.Builder
avoiding the need
to create one manually via ListCollectionsRequest.builder()
listCollectionsRequest
- A Consumer
that will call methods on ListCollectionsRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCollectionsIterable listCollectionsPaginator() throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns list of collection IDs in your account. If the result is truncated, the response also provides a
NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
This is a variant of
listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client .listCollectionsPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)
operation.
InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCollectionsPaginator(ListCollectionsRequest)
default ListCollectionsIterable listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns list of collection IDs in your account. If the result is truncated, the response also provides a
NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
This is a variant of
listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client .listCollectionsPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)
operation.
listCollectionsRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCollectionsIterable listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns list of collection IDs in your account. If the result is truncated, the response also provides a
NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
This is a variant of
listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client .listCollectionsPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listCollections(software.amazon.awssdk.services.rekognition.model.ListCollectionsRequest)
operation.
This is a convenience which creates an instance of the ListCollectionsRequest.Builder
avoiding the need
to create one manually via ListCollectionsRequest.builder()
listCollectionsRequest
- A Consumer
that will call methods on ListCollectionsRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacesResponse listFaces(ListFacesRequest listFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
listFacesRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacesResponse listFaces(Consumer<ListFacesRequest.Builder> listFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
This is a convenience which creates an instance of the ListFacesRequest.Builder
avoiding the need to
create one manually via ListFacesRequest.builder()
listFacesRequest
- A Consumer
that will call methods on ListFacesRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacesIterable listFacesPaginator(ListFacesRequest listFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
This is a variant of listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListFacesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest)
operation.
listFacesRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacesIterable listFacesPaginator(Consumer<ListFacesRequest.Builder> listFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, InvalidPaginationTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
This is a variant of listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListFacesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListFacesIterable responses = client.listFacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listFaces(software.amazon.awssdk.services.rekognition.model.ListFacesRequest)
operation.
This is a convenience which creates an instance of the ListFacesRequest.Builder
avoiding the need to
create one manually via ListFacesRequest.builder()
listFacesRequest
- A Consumer
that will call methods on ListFacesRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidPaginationTokenException
- Pagination token in the request is not valid.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStreamProcessorsResponse listStreamProcessors() throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Gets a list of stream processors that you have created with .
AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listStreamProcessors(ListStreamProcessorsRequest)
default ListStreamProcessorsResponse listStreamProcessors(ListStreamProcessorsRequest listStreamProcessorsRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Gets a list of stream processors that you have created with .
listStreamProcessorsRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStreamProcessorsResponse listStreamProcessors(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Gets a list of stream processors that you have created with .
This is a convenience which creates an instance of the ListStreamProcessorsRequest.Builder
avoiding the
need to create one manually via ListStreamProcessorsRequest.builder()
listStreamProcessorsRequest
- A Consumer
that will call methods on ListStreamProcessorsRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStreamProcessorsIterable listStreamProcessorsPaginator() throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Gets a list of stream processors that you have created with .
This is a variant of
listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client .listStreamProcessorsPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)
operation.
AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listStreamProcessorsPaginator(ListStreamProcessorsRequest)
default ListStreamProcessorsIterable listStreamProcessorsPaginator(ListStreamProcessorsRequest listStreamProcessorsRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Gets a list of stream processors that you have created with .
This is a variant of
listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client .listStreamProcessorsPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)
operation.
listStreamProcessorsRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStreamProcessorsIterable listStreamProcessorsPaginator(Consumer<ListStreamProcessorsRequest.Builder> listStreamProcessorsRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, InvalidPaginationTokenException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Gets a list of stream processors that you have created with .
This is a variant of
listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client .listStreamProcessorsPaginator(request); for (software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.rekognition.paginators.ListStreamProcessorsIterable responses = client.listStreamProcessorsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStreamProcessors(software.amazon.awssdk.services.rekognition.model.ListStreamProcessorsRequest)
operation.
This is a convenience which creates an instance of the ListStreamProcessorsRequest.Builder
avoiding the
need to create one manually via ListStreamProcessorsRequest.builder()
listStreamProcessorsRequest
- A Consumer
that will call methods on ListStreamProcessorsRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidPaginationTokenException
- Pagination token in the request is not valid.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RecognizeCelebritiesResponse recognizeCelebrities(RecognizeCelebritiesRequest recognizeCelebritiesRequest) throws InvalidS3ObjectException, InvalidParameterException, InvalidImageFormatException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
RecognizeCelebrities
returns the 100 largest faces in the image. It lists recognized celebrities in
the CelebrityFaces
array and unrecognized faces in the UnrecognizedFaces
array.
RecognizeCelebrities
doesn't return celebrities whose faces aren't among the largest 100 faces in
the image.
For each celebrity recognized, RecognizeCelebrities
returns a Celebrity
object. The
Celebrity
object contains the celebrity name, ID, URL links to additional information, match
confidence, and a ComparedFace
object that you can use to locate the celebrity's face on the image.
Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your
application must store this information and use the Celebrity
ID property as a unique identifier for
the celebrity. If you don't store the celebrity name or additional information URLs returned by
RecognizeCelebrities
, you will need the ID to identify the celebrity in a call to the 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.
recognizeCelebritiesRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidImageFormatException
- The provided image format is not supported.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RecognizeCelebritiesResponse recognizeCelebrities(Consumer<RecognizeCelebritiesRequest.Builder> recognizeCelebritiesRequest) throws InvalidS3ObjectException, InvalidParameterException, InvalidImageFormatException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
RecognizeCelebrities
returns the 100 largest faces in the image. It lists recognized celebrities in
the CelebrityFaces
array and unrecognized faces in the UnrecognizedFaces
array.
RecognizeCelebrities
doesn't return celebrities whose faces aren't among the largest 100 faces in
the image.
For each celebrity recognized, RecognizeCelebrities
returns a Celebrity
object. The
Celebrity
object contains the celebrity name, ID, URL links to additional information, match
confidence, and a ComparedFace
object that you can use to locate the celebrity's face on the image.
Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your
application must store this information and use the Celebrity
ID property as a unique identifier for
the celebrity. If you don't store the celebrity name or additional information URLs returned by
RecognizeCelebrities
, you will need the ID to identify the celebrity in a call to the operation.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:RecognizeCelebrities
operation.
This is a convenience which creates an instance of the RecognizeCelebritiesRequest.Builder
avoiding the
need to create one manually via RecognizeCelebritiesRequest.builder()
recognizeCelebritiesRequest
- A Consumer
that will call methods on RecognizeCelebritiesRequest.Builder
to create a
request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidImageFormatException
- The provided image format is not supported.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchFacesResponse searchFaces(SearchFacesRequest searchFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.
You can also search faces without indexing faces by using the SearchFacesByImage
operation.
The operation response returns an array of faces that match, ordered by similarity score with the highest
similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the
metadata, the response also includes a confidence
value for each face match, indicating the
confidence that the specific face matches the input face.
For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
searchFacesRequest
- InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchFacesResponse searchFaces(Consumer<SearchFacesRequest.Builder> searchFacesRequest) throws InvalidParameterException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, RekognitionException
For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.
You can also search faces without indexing faces by using the SearchFacesByImage
operation.
The operation response returns an array of faces that match, ordered by similarity score with the highest
similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the
metadata, the response also includes a confidence
value for each face match, indicating the
confidence that the specific face matches the input face.
For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
This is a convenience which creates an instance of the SearchFacesRequest.Builder
avoiding the need to
create one manually via SearchFacesRequest.builder()
searchFacesRequest
- A Consumer
that will call methods on SearchFacesRequest.Builder
to create a request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchFacesByImageResponse searchFacesByImage(SearchFacesByImageRequest searchFacesByImageRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation.
You can also call the DetectFaces
operation and use the bounding boxes in the response to make face
crops, which then you can pass in to the SearchFacesByImage
operation.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
The response returns an array of faces that match, ordered by similarity score with the highest similarity first.
More specifically, it is an array of metadata for each face match found. Along with the metadata, the response
also includes a similarity
indicating how similar the face is to the input face. In the response,
the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the
face that Amazon Rekognition used for the input image.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFacesByImage
action.
searchFacesByImageRequest
- InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchFacesByImageResponse searchFacesByImage(Consumer<SearchFacesByImageRequest.Builder> searchFacesByImageRequest) throws InvalidS3ObjectException, InvalidParameterException, ImageTooLargeException, AccessDeniedException, InternalServerErrorException, ThrottlingException, ProvisionedThroughputExceededException, ResourceNotFoundException, InvalidImageFormatException, AwsServiceException, SdkClientException, RekognitionException
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation.
You can also call the DetectFaces
operation and use the bounding boxes in the response to make face
crops, which then you can pass in to the SearchFacesByImage
operation.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
The response returns an array of faces that match, ordered by similarity score with the highest similarity first.
More specifically, it is an array of metadata for each face match found. Along with the metadata, the response
also includes a similarity
indicating how similar the face is to the input face. In the response,
the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the
face that Amazon Rekognition used for the input image.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFacesByImage
action.
This is a convenience which creates an instance of the SearchFacesByImageRequest.Builder
avoiding the
need to create one manually via SearchFacesByImageRequest.builder()
searchFacesByImageRequest
- A Consumer
that will call methods on SearchFacesByImageRequest.Builder
to create a
request.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ImageTooLargeException
- The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in
the Amazon Rekognition Developer Guide.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.ResourceNotFoundException
- The collection specified in the request cannot be found.InvalidImageFormatException
- The provided image format is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartCelebrityRecognitionResponse startCelebrityRecognition(StartCelebrityRecognitionRequest startCelebrityRecognitionRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous recognition of celebrities in a stored video.
Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use
Video to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity
recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple
Notification Service topic that you specify in NotificationChannel
. To get the results of the
celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is
SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to
StartCelebrityRecognition
.
For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
startCelebrityRecognitionRequest
- AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartCelebrityRecognitionResponse startCelebrityRecognition(Consumer<StartCelebrityRecognitionRequest.Builder> startCelebrityRecognitionRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous recognition of celebrities in a stored video.
Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use
Video to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity
recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple
Notification Service topic that you specify in NotificationChannel
. To get the results of the
celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is
SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to
StartCelebrityRecognition
.
For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
This is a convenience which creates an instance of the StartCelebrityRecognitionRequest.Builder
avoiding
the need to create one manually via StartCelebrityRecognitionRequest.builder()
startCelebrityRecognitionRequest
- A Consumer
that will call methods on StartCelebrityRecognitionRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartContentModerationResponse startContentModeration(StartContentModerationRequest startContentModerationRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous detection of explicit or suggestive adult content in a stored video.
Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to
specify the bucket name and the filename of the video. StartContentModeration
returns a job
identifier (JobId
) which you use to get the results of the analysis. When content moderation
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 moderation analysis, first check that the status value published to the Amazon
SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the
initial call to StartContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
startContentModerationRequest
- AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartContentModerationResponse startContentModeration(Consumer<StartContentModerationRequest.Builder> startContentModerationRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous detection of explicit or suggestive adult content in a stored video.
Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to
specify the bucket name and the filename of the video. StartContentModeration
returns a job
identifier (JobId
) which you use to get the results of the analysis. When content moderation
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 moderation analysis, first check that the status value published to the Amazon
SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the
initial call to StartContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
This is a convenience which creates an instance of the StartContentModerationRequest.Builder
avoiding the
need to create one manually via StartContentModerationRequest.builder()
startContentModerationRequest
- A Consumer
that will call methods on StartContentModerationRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartFaceDetectionResponse startFaceDetection(StartFaceDetectionRequest startFaceDetectionRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous detection of faces in a stored video.
Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify
the bucket name and the filename of the video. StartFaceDetection
returns a job identifier (
JobId
) that you use to get the results of the operation. When face detection is finished, Amazon
Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify
in NotificationChannel
. To get the results of the face detection operation, first check that the
status value published to the Amazon SNS topic is SUCCEEDED
. If so, call 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.
startFaceDetectionRequest
- AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartFaceDetectionResponse startFaceDetection(Consumer<StartFaceDetectionRequest.Builder> startFaceDetectionRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous detection of faces in a stored video.
Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify
the bucket name and the filename of the video. StartFaceDetection
returns a job identifier (
JobId
) that you use to get the results of the operation. When face detection is finished, Amazon
Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify
in NotificationChannel
. To get the results of the face detection operation, first check that the
status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier
(JobId
) from the initial call to StartFaceDetection
.
For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
This is a convenience which creates an instance of the StartFaceDetectionRequest.Builder
avoiding the
need to create one manually via StartFaceDetectionRequest.builder()
startFaceDetectionRequest
- A Consumer
that will call methods on StartFaceDetectionRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartFaceSearchResponse startFaceSearch(StartFaceSearchRequest startFaceSearchRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of
the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the
search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a
completion status to the Amazon Simple Notification Service topic that you specify in
NotificationChannel
. To get the search results, first check that the status value published to the
Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the
initial call to StartFaceSearch
. For more information, see procedure-person-search-videos.
startFaceSearchRequest
- AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartFaceSearchResponse startFaceSearch(Consumer<StartFaceSearchRequest.Builder> startFaceSearchRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of
the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the
search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a
completion status to the Amazon Simple Notification Service topic that you specify in
NotificationChannel
. To get the search results, first check that the status value published to the
Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the
initial call to StartFaceSearch
. For more information, see procedure-person-search-videos.
This is a convenience which creates an instance of the StartFaceSearchRequest.Builder
avoiding the need
to create one manually via StartFaceSearchRequest.builder()
startFaceSearchRequest
- A Consumer
that will call methods on StartFaceSearchRequest.Builder
to create a request.AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ResourceNotFoundException
- The collection specified in the request cannot be found.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartLabelDetectionResponse startLabelDetection(StartLabelDetectionRequest startLabelDetectionRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of
the video. StartLabelDetection
returns a job identifier (JobId
) which you use to get
the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion
status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the label detection operation, first check that the status value published to the Amazon
SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the
initial call to StartLabelDetection
.
startLabelDetectionRequest
- AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartLabelDetectionResponse startLabelDetection(Consumer<StartLabelDetectionRequest.Builder> startLabelDetectionRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of
the video. StartLabelDetection
returns a job identifier (JobId
) which you use to get
the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion
status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the label detection operation, first check that the status value published to the Amazon
SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the
initial call to StartLabelDetection
.
This is a convenience which creates an instance of the StartLabelDetectionRequest.Builder
avoiding the
need to create one manually via StartLabelDetectionRequest.builder()
startLabelDetectionRequest
- A Consumer
that will call methods on StartLabelDetectionRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartPersonTrackingResponse startPersonTracking(StartPersonTrackingRequest startPersonTrackingRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
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 and pass the job identifier (JobId
) from the
initial call to StartPersonTracking
.
startPersonTrackingRequest
- AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartPersonTrackingResponse startPersonTracking(Consumer<StartPersonTrackingRequest.Builder> startPersonTrackingRequest) throws AccessDeniedException, IdempotentParameterMismatchException, InvalidParameterException, InvalidS3ObjectException, InternalServerErrorException, VideoTooLargeException, ProvisionedThroughputExceededException, LimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, RekognitionException
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 and pass the job identifier (JobId
) from the
initial call to StartPersonTracking
.
This is a convenience which creates an instance of the StartPersonTrackingRequest.Builder
avoiding the
need to create one manually via StartPersonTrackingRequest.builder()
startPersonTrackingRequest
- A Consumer
that will call methods on StartPersonTrackingRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.IdempotentParameterMismatchException
- A ClientRequestToken
input parameter was reused with an operation, but at least one of the
other input parameters is different from the previous call to the operation.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.InvalidS3ObjectException
- Amazon Rekognition is unable to access the S3 object specified in the request.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.VideoTooLargeException
- The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum
duration is 2 hours.ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.LimitExceededException
- An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition
Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will
raise a LimitExceededException
exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Rekognition service limit.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartStreamProcessorResponse startStreamProcessor(StartStreamProcessorRequest startStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Starts processing a stream processor. You create a stream processor by calling . To tell
StartStreamProcessor
which stream processor to start, use the value of the Name
field
specified in the call to CreateStreamProcessor
.
startStreamProcessorRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartStreamProcessorResponse startStreamProcessor(Consumer<StartStreamProcessorRequest.Builder> startStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Starts processing a stream processor. You create a stream processor by calling . To tell
StartStreamProcessor
which stream processor to start, use the value of the Name
field
specified in the call to CreateStreamProcessor
.
This is a convenience which creates an instance of the StartStreamProcessorRequest.Builder
avoiding the
need to create one manually via StartStreamProcessorRequest.builder()
startStreamProcessorRequest
- A Consumer
that will call methods on StartStreamProcessorRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopStreamProcessorResponse stopStreamProcessor(StopStreamProcessorRequest stopStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Stops a running stream processor that was created by .
stopStreamProcessorRequest
- AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopStreamProcessorResponse stopStreamProcessor(Consumer<StopStreamProcessorRequest.Builder> stopStreamProcessorRequest) throws AccessDeniedException, InternalServerErrorException, ThrottlingException, InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ProvisionedThroughputExceededException, AwsServiceException, SdkClientException, RekognitionException
Stops a running stream processor that was created by .
This is a convenience which creates an instance of the StopStreamProcessorRequest.Builder
avoiding the
need to create one manually via StopStreamProcessorRequest.builder()
stopStreamProcessorRequest
- A Consumer
that will call methods on StopStreamProcessorRequest.Builder
to create a
request.AccessDeniedException
- You are not authorized to perform the action.InternalServerErrorException
- Amazon Rekognition experienced a service issue. Try your call again.ThrottlingException
- Amazon Rekognition is temporarily unable to process the request. Try your call again.InvalidParameterException
- Input parameter violated a constraint. Validate your parameter before calling the API operation again.ResourceNotFoundException
- The collection specified in the request cannot be found.ResourceInUseException
ProvisionedThroughputExceededException
- The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon
Rekognition.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RekognitionException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.