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 face detected in the target input image.

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

In response, the operation returns an array of face matches ordered by similarity score with the highest similarity scores first. For each face match, the response provides a bounding box of the face 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 the similarity score of greater than or equal to 80% are returned in the response. You can change this value.

In addition to the face matches, the response returns information about the face in the source image, including the bounding box of the face and confidence value.

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

For an example, see get-started-exercise-compare-faces

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 face detected in the target input image.

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

In response, the operation returns an array of face matches ordered by similarity score with the highest similarity scores first. For each face match, the response provides a bounding box of the face 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 the similarity score of greater than or equal to 80% are returned in the response. You can change this value.

In addition to the face matches, the response returns information about the face in the source image, including the bounding box of the face and confidence value.

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

For an example, see get-started-exercise-compare-faces

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

For an example, see example1.

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

For an example, see example1.

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

– deleteCollection:

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

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 example1.

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

– detectFaces:

Detects faces within an image (JPEG or PNG) that is provided as input.

For each face detected, the operation returns face details including 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, etc.

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

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

For an example, see get-started-exercise-detect-faces.

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 (JPEG or PNG) that is provided as input.

For each face detected, the operation returns face details including 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, etc.

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

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

For an example, see get-started-exercise-detect-faces.

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 labels 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 get-started-exercise-detect-labels.

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 will include 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.

You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels parameter to limit the number of labels returned.

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

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 labels 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 get-started-exercise-detect-labels.

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 will include 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.

You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels parameter to limit the number of labels returned.

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

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 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 howitworks-moderateimage.

- (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.

Declared In

AWSRekognitionService.h

– detectModerationLabels:completionHandler:

Detects explicit or suggestive adult content in a specified .jpeg or .png 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 howitworks-moderateimage.

- (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.

Declared In

AWSRekognitionService.h

– indexFaces:

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

Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.

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

In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such 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.

For an example, see example2.

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 does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.

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

In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such 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.

For an example, see example2.

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 example1.

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 example1.

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 example3.

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 example3.

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

– 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 example3.

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 example3.

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 operation, and then use the face IDs returned in subsequent calls to the operation.

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

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, see example3.

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 operation, and then use the face IDs returned in subsequent calls to the operation.

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

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, see example3.

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