AWSRekognition Class Reference

Inherits from AWSService : NSObject
Declared in AWSRekognitionService.h
AWSRekognitionService.m

Overview

This is the Amazon Rekognition API reference.

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSRekognitionService.h

+ defaultRekognition

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

+ (instancetype)defaultRekognition

Return Value

The default service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
    AWSServiceManager.default().defaultServiceConfiguration = configuration

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                      identityPoolId:@"YourIdentityPoolId"];
      AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                           credentialsProvider:credentialsProvider];
      [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

      return YES;
  }

Then call the following to get the default service client:

Swift

 let Rekognition = AWSRekognition.default()

Objective-C

 AWSRekognition *Rekognition = [AWSRekognition defaultRekognition];

Declared In

AWSRekognitionService.h

+ registerRekognitionWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerRekognitionWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSRekognition.register(with: configuration!, forKey: "USWest2Rekognition")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSRekognition registerRekognitionWithConfiguration:configuration forKey:@"USWest2Rekognition"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let Rekognition = AWSRekognition(forKey: "USWest2Rekognition")

Objective-C

 AWSRekognition *Rekognition = [AWSRekognition RekognitionForKey:@"USWest2Rekognition"];

Warning: After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSRekognitionService.h

+ RekognitionForKey:

Retrieves the service client associated with the key. You need to call + registerRekognitionWithConfiguration:forKey: before invoking this method.

+ (instancetype)RekognitionForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSRekognition.register(with: configuration!, forKey: "USWest2Rekognition")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSRekognition registerRekognitionWithConfiguration:configuration forKey:@"USWest2Rekognition"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let Rekognition = AWSRekognition(forKey: "USWest2Rekognition")

Objective-C

 AWSRekognition *Rekognition = [AWSRekognition RekognitionForKey:@"USWest2Rekognition"];

Declared In

AWSRekognitionService.h

+ removeRekognitionForKey:

Removes the service client associated with the key and release it.

+ (void)removeRekognitionForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSRekognitionService.h

– compareFaces:

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.

- (AWSTask<AWSRekognitionCompareFacesResponse*> *)compareFaces:(AWSRekognitionCompareFacesRequest *)request

Parameters

request

A container for the necessary parameters to execute the CompareFaces service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionCompareFacesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– compareFaces:completionHandler:

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.

- (void)compareFaces:(AWSRekognitionCompareFacesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionCompareFacesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CompareFaces service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– createCollection:

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

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

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

Collection names are case-sensitive.

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

- (AWSTask<AWSRekognitionCreateCollectionResponse*> *)createCollection:(AWSRekognitionCreateCollectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateCollection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionCreateCollectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceAlreadyExists.

Declared In

AWSRekognitionService.h

– createCollection:completionHandler:

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

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

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

Collection names are case-sensitive.

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

- (void)createCollection:(AWSRekognitionCreateCollectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionCreateCollectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateCollection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceAlreadyExists.

Declared In

AWSRekognitionService.h

– createStreamProcessor:

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

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

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

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

- (AWSTask<AWSRekognitionCreateStreamProcessorResponse*> *)createStreamProcessor:(AWSRekognitionCreateStreamProcessorRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateStreamProcessor service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionCreateStreamProcessorResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– createStreamProcessor:completionHandler:

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

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

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

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

- (void)createStreamProcessor:(AWSRekognitionCreateStreamProcessorRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionCreateStreamProcessorResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateStreamProcessor service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– deleteCollection:

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.

- (AWSTask<AWSRekognitionDeleteCollectionResponse*> *)deleteCollection:(AWSRekognitionDeleteCollectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteCollection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDeleteCollectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– deleteCollection:completionHandler:

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.

- (void)deleteCollection:(AWSRekognitionDeleteCollectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDeleteCollectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteCollection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– deleteFaces:

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.

- (AWSTask<AWSRekognitionDeleteFacesResponse*> *)deleteFaces:(AWSRekognitionDeleteFacesRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteFaces service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDeleteFacesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– deleteFaces:completionHandler:

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.

- (void)deleteFaces:(AWSRekognitionDeleteFacesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDeleteFacesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteFaces service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– deleteStreamProcessor:

Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.

- (AWSTask<AWSRekognitionDeleteStreamProcessorResponse*> *)deleteStreamProcessor:(AWSRekognitionDeleteStreamProcessorRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteStreamProcessor service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDeleteStreamProcessorResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– deleteStreamProcessor:completionHandler:

Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.

- (void)deleteStreamProcessor:(AWSRekognitionDeleteStreamProcessorRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDeleteStreamProcessorResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteStreamProcessor service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– describeCollection:

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.

- (AWSTask<AWSRekognitionDescribeCollectionResponse*> *)describeCollection:(AWSRekognitionDescribeCollectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeCollection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDescribeCollectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– describeCollection:completionHandler:

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.

- (void)describeCollection:(AWSRekognitionDescribeCollectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDescribeCollectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeCollection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– describeStreamProcessor:

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

- (AWSTask<AWSRekognitionDescribeStreamProcessorResponse*> *)describeStreamProcessor:(AWSRekognitionDescribeStreamProcessorRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeStreamProcessor service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDescribeStreamProcessorResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– describeStreamProcessor:completionHandler:

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

- (void)describeStreamProcessor:(AWSRekognitionDescribeStreamProcessorRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDescribeStreamProcessorResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeStreamProcessor service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– detectFaces:

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.

- (AWSTask<AWSRekognitionDetectFacesResponse*> *)detectFaces:(AWSRekognitionDetectFacesRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectFaces service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDetectFacesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectFaces:completionHandler:

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.

- (void)detectFaces:(AWSRekognitionDetectFacesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDetectFacesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectFaces service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectLabels:

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

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

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

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

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

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

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

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

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

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

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

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

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

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

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

- (AWSTask<AWSRekognitionDetectLabelsResponse*> *)detectLabels:(AWSRekognitionDetectLabelsRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectLabels service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDetectLabelsResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectLabels:completionHandler:

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

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

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

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

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

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

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

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

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

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

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

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

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

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

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

- (void)detectLabels:(AWSRekognitionDetectLabelsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDetectLabelsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectLabels service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectModerationLabels:

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.

- (AWSTask<AWSRekognitionDetectModerationLabelsResponse*> *)detectModerationLabels:(AWSRekognitionDetectModerationLabelsRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectModerationLabels service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDetectModerationLabelsResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectModerationLabels:completionHandler:

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.

- (void)detectModerationLabels:(AWSRekognitionDetectModerationLabelsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDetectModerationLabelsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectModerationLabels service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectText:

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

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

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

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

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

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

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

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

- (AWSTask<AWSRekognitionDetectTextResponse*> *)detectText:(AWSRekognitionDetectTextRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectText service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionDetectTextResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– detectText:completionHandler:

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

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

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

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

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

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

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

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

- (void)detectText:(AWSRekognitionDetectTextRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionDetectTextResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectText service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– getCelebrityInfo:

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.

- (AWSTask<AWSRekognitionGetCelebrityInfoResponse*> *)getCelebrityInfo:(AWSRekognitionGetCelebrityInfoRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetCelebrityInfo service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetCelebrityInfoResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– getCelebrityInfo:completionHandler:

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.

- (void)getCelebrityInfo:(AWSRekognitionGetCelebrityInfoRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetCelebrityInfoResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetCelebrityInfo service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– getCelebrityRecognition:

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

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

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

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

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

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

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

No information is returned for faces not recognized as celebrities.

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

- (AWSTask<AWSRekognitionGetCelebrityRecognitionResponse*> *)getCelebrityRecognition:(AWSRekognitionGetCelebrityRecognitionRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetCelebrityRecognition service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetCelebrityRecognitionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getCelebrityRecognition:completionHandler:

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

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

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

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

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

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

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

No information is returned for faces not recognized as celebrities.

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

- (void)getCelebrityRecognition:(AWSRekognitionGetCelebrityRecognitionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetCelebrityRecognitionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetCelebrityRecognition service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getContentModeration:

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

Content moderation analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration. which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the 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 ContentModerationDetection objects.

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

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

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

- (AWSTask<AWSRekognitionGetContentModerationResponse*> *)getContentModeration:(AWSRekognitionGetContentModerationRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetContentModeration service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetContentModerationResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getContentModeration:completionHandler:

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

Content moderation analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration. which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the 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 ContentModerationDetection objects.

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

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

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

- (void)getContentModeration:(AWSRekognitionGetContentModerationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetContentModerationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetContentModeration service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getFaceDetection:

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

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

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

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

- (AWSTask<AWSRekognitionGetFaceDetectionResponse*> *)getFaceDetection:(AWSRekognitionGetFaceDetectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetFaceDetection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetFaceDetectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getFaceDetection:completionHandler:

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

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

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

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

- (void)getFaceDetection:(AWSRekognitionGetFaceDetectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetFaceDetectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetFaceDetection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getFaceSearch:

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

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

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

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

- (AWSTask<AWSRekognitionGetFaceSearchResponse*> *)getFaceSearch:(AWSRekognitionGetFaceSearchRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetFaceSearch service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetFaceSearchResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getFaceSearch:completionHandler:

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

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

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

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

- (void)getFaceSearch:(AWSRekognitionGetFaceSearchRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetFaceSearchResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetFaceSearch service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getLabelDetection:

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

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

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

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

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

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

- (AWSTask<AWSRekognitionGetLabelDetectionResponse*> *)getLabelDetection:(AWSRekognitionGetLabelDetectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetLabelDetection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetLabelDetectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getLabelDetection:completionHandler:

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

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

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

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

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

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

- (void)getLabelDetection:(AWSRekognitionGetLabelDetectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetLabelDetectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetLabelDetection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getPersonTracking:

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

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

GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video.

GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned.

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

By default, the array is sorted by the time(s) a person’s path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

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

- (AWSTask<AWSRekognitionGetPersonTrackingResponse*> *)getPersonTracking:(AWSRekognitionGetPersonTrackingRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetPersonTracking service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionGetPersonTrackingResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– getPersonTracking:completionHandler:

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

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

GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video.

GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned.

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

By default, the array is sorted by the time(s) a person’s path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

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

- (void)getPersonTracking:(AWSRekognitionGetPersonTrackingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionGetPersonTrackingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetPersonTracking service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– indexFaces:

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

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

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

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

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

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

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

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

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

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

The QualityFilter input parameter allows you to filter out detected faces that don’t meet 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 DescribeCollection.

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

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

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

  • The face is too blurry.

  • The image is too dark.

  • The face has an extreme pose.

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.

- (AWSTask<AWSRekognitionIndexFacesResponse*> *)indexFaces:(AWSRekognitionIndexFacesRequest *)request

Parameters

request

A container for the necessary parameters to execute the IndexFaces service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionIndexFacesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– indexFaces:completionHandler:

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

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

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

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

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

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

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

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

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

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

The QualityFilter input parameter allows you to filter out detected faces that don’t meet 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 DescribeCollection.

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

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

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

  • The face is too blurry.

  • The image is too dark.

  • The face has an extreme pose.

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.

- (void)indexFaces:(AWSRekognitionIndexFacesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionIndexFacesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the IndexFaces service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– listCollections:

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.

- (AWSTask<AWSRekognitionListCollectionsResponse*> *)listCollections:(AWSRekognitionListCollectionsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListCollections service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionListCollectionsResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– listCollections:completionHandler:

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.

- (void)listCollections:(AWSRekognitionListCollectionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionListCollectionsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListCollections service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– listFaces:

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.

- (AWSTask<AWSRekognitionListFacesResponse*> *)listFaces:(AWSRekognitionListFacesRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListFaces service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionListFacesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– listFaces:completionHandler:

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.

- (void)listFaces:(AWSRekognitionListFacesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionListFacesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListFaces service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– listStreamProcessors:

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

- (AWSTask<AWSRekognitionListStreamProcessorsResponse*> *)listStreamProcessors:(AWSRekognitionListStreamProcessorsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListStreamProcessors service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionListStreamProcessorsResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– listStreamProcessors:completionHandler:

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

- (void)listStreamProcessors:(AWSRekognitionListStreamProcessorsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionListStreamProcessorsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListStreamProcessors service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– recognizeCelebrities:

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 GetCelebrityInfo operation.

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

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

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

- (AWSTask<AWSRekognitionRecognizeCelebritiesResponse*> *)recognizeCelebrities:(AWSRekognitionRecognizeCelebritiesRequest *)request

Parameters

request

A container for the necessary parameters to execute the RecognizeCelebrities service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionRecognizeCelebritiesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidImageFormat, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– recognizeCelebrities:completionHandler:

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 GetCelebrityInfo operation.

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

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

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

- (void)recognizeCelebrities:(AWSRekognitionRecognizeCelebritiesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionRecognizeCelebritiesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RecognizeCelebrities service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidImageFormat, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– searchFaces:

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.

- (AWSTask<AWSRekognitionSearchFacesResponse*> *)searchFaces:(AWSRekognitionSearchFacesRequest *)request

Parameters

request

A container for the necessary parameters to execute the SearchFaces service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionSearchFacesResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– searchFaces:completionHandler:

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.

- (void)searchFaces:(AWSRekognitionSearchFacesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionSearchFacesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SearchFaces service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound.

Declared In

AWSRekognitionService.h

– searchFacesByImage:

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

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

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

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

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

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

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

- (AWSTask<AWSRekognitionSearchFacesByImageResponse*> *)searchFacesByImage:(AWSRekognitionSearchFacesByImageRequest *)request

Parameters

request

A container for the necessary parameters to execute the SearchFacesByImage service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionSearchFacesByImageResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– searchFacesByImage:completionHandler:

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

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

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

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

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

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

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

- (void)searchFacesByImage:(AWSRekognitionSearchFacesByImageRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionSearchFacesByImageResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SearchFacesByImage service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorInvalidImageFormat.

Declared In

AWSRekognitionService.h

– startCelebrityRecognition:

Starts asynchronous recognition of celebrities in a stored video.

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

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

- (AWSTask<AWSRekognitionStartCelebrityRecognitionResponse*> *)startCelebrityRecognition:(AWSRekognitionStartCelebrityRecognitionRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartCelebrityRecognition service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartCelebrityRecognitionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startCelebrityRecognition:completionHandler:

Starts asynchronous recognition of celebrities in a stored video.

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

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

- (void)startCelebrityRecognition:(AWSRekognitionStartCelebrityRecognitionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartCelebrityRecognitionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartCelebrityRecognition service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startContentModeration:

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 GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

- (AWSTask<AWSRekognitionStartContentModerationResponse*> *)startContentModeration:(AWSRekognitionStartContentModerationRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartContentModeration service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartContentModerationResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startContentModeration:completionHandler:

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 GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

- (void)startContentModeration:(AWSRekognitionStartContentModerationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartContentModerationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartContentModeration service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startFaceDetection:

Starts asynchronous detection of faces in a stored video.

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

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

- (AWSTask<AWSRekognitionStartFaceDetectionResponse*> *)startFaceDetection:(AWSRekognitionStartFaceDetectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartFaceDetection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartFaceDetectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startFaceDetection:completionHandler:

Starts asynchronous detection of faces in a stored video.

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

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

- (void)startFaceDetection:(AWSRekognitionStartFaceDetectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartFaceDetectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartFaceDetection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startFaceSearch:

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

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

- (AWSTask<AWSRekognitionStartFaceSearchResponse*> *)startFaceSearch:(AWSRekognitionStartFaceSearchRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartFaceSearch service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartFaceSearchResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startFaceSearch:completionHandler:

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

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

- (void)startFaceSearch:(AWSRekognitionStartFaceSearchRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartFaceSearchResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartFaceSearch service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startLabelDetection:

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

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

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

- (AWSTask<AWSRekognitionStartLabelDetectionResponse*> *)startLabelDetection:(AWSRekognitionStartLabelDetectionRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartLabelDetection service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartLabelDetectionResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startLabelDetection:completionHandler:

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

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

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

- (void)startLabelDetection:(AWSRekognitionStartLabelDetectionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartLabelDetectionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartLabelDetection service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startPersonTracking:

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

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

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

- (AWSTask<AWSRekognitionStartPersonTrackingResponse*> *)startPersonTracking:(AWSRekognitionStartPersonTrackingRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartPersonTracking service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartPersonTrackingResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startPersonTracking:completionHandler:

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

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

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

- (void)startPersonTracking:(AWSRekognitionStartPersonTrackingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartPersonTrackingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartPersonTracking service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorIdempotentParameterMismatch, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInternalServer, AWSRekognitionErrorVideoTooLarge, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorThrottling.

Declared In

AWSRekognitionService.h

– startStreamProcessor:

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

- (AWSTask<AWSRekognitionStartStreamProcessorResponse*> *)startStreamProcessor:(AWSRekognitionStartStreamProcessorRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartStreamProcessor service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartStreamProcessorResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– startStreamProcessor:completionHandler:

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

- (void)startStreamProcessor:(AWSRekognitionStartStreamProcessorRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStartStreamProcessorResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartStreamProcessor service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– stopStreamProcessor:

Stops a running stream processor that was created by CreateStreamProcessor.

- (AWSTask<AWSRekognitionStopStreamProcessorResponse*> *)stopStreamProcessor:(AWSRekognitionStopStreamProcessorRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopStreamProcessor service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStopStreamProcessorResponse. On failed execution, task.error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h

– stopStreamProcessor:completionHandler:

Stops a running stream processor that was created by CreateStreamProcessor.

- (void)stopStreamProcessor:(AWSRekognitionStopStreamProcessorRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSRekognitionStopStreamProcessorResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopStreamProcessor service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSRekognitionErrorDomain domain and the following error code: AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorProvisionedThroughputExceeded.

Declared In

AWSRekognitionService.h