AWSRekognition

@interface AWSRekognition

This is the Amazon Rekognition API reference.

  • The service configuration used to instantiate this service client.

    Warning

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

    Declaration

    Objective-C

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

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • 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.

    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];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultRekognition;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

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

    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.

    Declaration

    Objective-C

    + (void)registerRekognitionWithConfiguration:(id)configuration
                                          forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

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

    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"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)RekognitionForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

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

    Warning

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

    Declaration

    Objective-C

    + (void)removeRekognitionForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

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

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

    To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

    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.

    See

    AWSRekognitionCompareFacesRequest

    See

    AWSRekognitionCompareFacesResponse

    Declaration

    Objective-C

    - (id)compareFaces:(nonnull AWSRekognitionCompareFacesRequest *)request;

    Swift

    func compareFaces(_ request: AWSRekognitionCompareFacesRequest) -> Any!

    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.

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

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

    To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

    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.

    See

    AWSRekognitionCompareFacesRequest

    See

    AWSRekognitionCompareFacesResponse

    Declaration

    Objective-C

    - (void)compareFaces:(nonnull AWSRekognitionCompareFacesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionCompareFacesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func compareFaces(_ request: AWSRekognitionCompareFacesRequest, completionHandler: ((AWSRekognitionCompareFacesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionCreateCollectionRequest

    See

    AWSRekognitionCreateCollectionResponse

    Declaration

    Objective-C

    - (id)createCollection:(nonnull AWSRekognitionCreateCollectionRequest *)request;

    Swift

    func createCollection(_ request: AWSRekognitionCreateCollectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionCreateCollectionRequest

    See

    AWSRekognitionCreateCollectionResponse

    Declaration

    Objective-C

    - (void)createCollection:
                (nonnull AWSRekognitionCreateCollectionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSRekognitionCreateCollectionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func createCollection(_ request: AWSRekognitionCreateCollectionRequest, completionHandler: ((AWSRekognitionCreateCollectionResponse?, Error?) -> Void)? = nil)

    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.

  • Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) and operations (training, evaluation and detection).

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

    See

    AWSRekognitionCreateProjectRequest

    See

    AWSRekognitionCreateProjectResponse

    Declaration

    Objective-C

    - (id)createProject:(nonnull AWSRekognitionCreateProjectRequest *)request;

    Swift

    func createProject(_ request: AWSRekognitionCreateProjectRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) and operations (training, evaluation and detection).

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

    See

    AWSRekognitionCreateProjectRequest

    See

    AWSRekognitionCreateProjectResponse

    Declaration

    Objective-C

    - (void)createProject:(nonnull AWSRekognitionCreateProjectRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionCreateProjectResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createProject(_ request: AWSRekognitionCreateProjectRequest, completionHandler: ((AWSRekognitionCreateProjectResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateProject 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: AWSRekognitionErrorResourceInUse, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

  • Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify one training dataset and one testing dataset. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

    Training takes a while to complete. You can get the current status by calling DescribeProjectVersions.

    Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

    After evaluating the model, you start the model by calling StartProjectVersion.

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

    See

    AWSRekognitionCreateProjectVersionRequest

    See

    AWSRekognitionCreateProjectVersionResponse

    Declaration

    Objective-C

    - (id)createProjectVersion:
        (nonnull AWSRekognitionCreateProjectVersionRequest *)request;

    Swift

    func createProjectVersion(_ request: AWSRekognitionCreateProjectVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify one training dataset and one testing dataset. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

    Training takes a while to complete. You can get the current status by calling DescribeProjectVersions.

    Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

    After evaluating the model, you start the model by calling StartProjectVersion.

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

    See

    AWSRekognitionCreateProjectVersionRequest

    See

    AWSRekognitionCreateProjectVersionResponse

    Declaration

    Objective-C

    - (void)createProjectVersion:
                (nonnull AWSRekognitionCreateProjectVersionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSRekognitionCreateProjectVersionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func createProjectVersion(_ request: AWSRekognitionCreateProjectVersionRequest, completionHandler: ((AWSRekognitionCreateProjectVersionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateProjectVersion 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: AWSRekognitionErrorResourceInUse, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

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

    See

    AWSRekognitionCreateStreamProcessorRequest

    See

    AWSRekognitionCreateStreamProcessorResponse

    Declaration

    Objective-C

    - (id)createStreamProcessor:
        (nonnull AWSRekognitionCreateStreamProcessorRequest *)request;

    Swift

    func createStreamProcessor(_ request: AWSRekognitionCreateStreamProcessorRequest) -> Any!

    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.

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

    See

    AWSRekognitionCreateStreamProcessorRequest

    See

    AWSRekognitionCreateStreamProcessorResponse

    Declaration

    Objective-C

    - (void)createStreamProcessor:
                (nonnull AWSRekognitionCreateStreamProcessorRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSRekognitionCreateStreamProcessorResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func createStreamProcessor(_ request: AWSRekognitionCreateStreamProcessorRequest, completionHandler: ((AWSRekognitionCreateStreamProcessorResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionDeleteCollectionRequest

    See

    AWSRekognitionDeleteCollectionResponse

    Declaration

    Objective-C

    - (id)deleteCollection:(nonnull AWSRekognitionDeleteCollectionRequest *)request;

    Swift

    func deleteCollection(_ request: AWSRekognitionDeleteCollectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionDeleteCollectionRequest

    See

    AWSRekognitionDeleteCollectionResponse

    Declaration

    Objective-C

    - (void)deleteCollection:
                (nonnull AWSRekognitionDeleteCollectionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSRekognitionDeleteCollectionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func deleteCollection(_ request: AWSRekognitionDeleteCollectionRequest, completionHandler: ((AWSRekognitionDeleteCollectionResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionDeleteFacesRequest

    See

    AWSRekognitionDeleteFacesResponse

    Declaration

    Objective-C

    - (id)deleteFaces:(nonnull AWSRekognitionDeleteFacesRequest *)request;

    Swift

    func deleteFaces(_ request: AWSRekognitionDeleteFacesRequest) -> Any!

    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.

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

    See

    AWSRekognitionDeleteFacesRequest

    See

    AWSRekognitionDeleteFacesResponse

    Declaration

    Objective-C

    - (void)deleteFaces:(nonnull AWSRekognitionDeleteFacesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionDeleteFacesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteFaces(_ request: AWSRekognitionDeleteFacesRequest, completionHandler: ((AWSRekognitionDeleteFacesResponse?, Error?) -> Void)? = nil)

    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.

  • Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.

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

    See

    AWSRekognitionDeleteProjectRequest

    See

    AWSRekognitionDeleteProjectResponse

    Declaration

    Objective-C

    - (id)deleteProject:(nonnull AWSRekognitionDeleteProjectRequest *)request;

    Swift

    func deleteProject(_ request: AWSRekognitionDeleteProjectRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.

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

    See

    AWSRekognitionDeleteProjectRequest

    See

    AWSRekognitionDeleteProjectResponse

    Declaration

    Objective-C

    - (void)deleteProject:(nonnull AWSRekognitionDeleteProjectRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionDeleteProjectResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteProject(_ request: AWSRekognitionDeleteProjectRequest, completionHandler: ((AWSRekognitionDeleteProjectResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteProject 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: AWSRekognitionErrorResourceInUse, AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

  • Deletes an Amazon Rekognition Custom Labels model.

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

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

    See

    AWSRekognitionDeleteProjectVersionRequest

    See

    AWSRekognitionDeleteProjectVersionResponse

    Declaration

    Objective-C

    - (id)deleteProjectVersion:
        (nonnull AWSRekognitionDeleteProjectVersionRequest *)request;

    Swift

    func deleteProjectVersion(_ request: AWSRekognitionDeleteProjectVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes an Amazon Rekognition Custom Labels model.

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

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

    See

    AWSRekognitionDeleteProjectVersionRequest

    See

    AWSRekognitionDeleteProjectVersionResponse

    Declaration

    Objective-C

    - (void)deleteProjectVersion:
                (nonnull AWSRekognitionDeleteProjectVersionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSRekognitionDeleteProjectVersionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func deleteProjectVersion(_ request: AWSRekognitionDeleteProjectVersionRequest, completionHandler: ((AWSRekognitionDeleteProjectVersionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteProjectVersion 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: AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

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

    See

    AWSRekognitionDeleteStreamProcessorRequest

    See

    AWSRekognitionDeleteStreamProcessorResponse

    Declaration

    Objective-C

    - (id)deleteStreamProcessor:
        (nonnull AWSRekognitionDeleteStreamProcessorRequest *)request;

    Swift

    func deleteStreamProcessor(_ request: AWSRekognitionDeleteStreamProcessorRequest) -> Any!

    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.

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

    See

    AWSRekognitionDeleteStreamProcessorRequest

    See

    AWSRekognitionDeleteStreamProcessorResponse

    Declaration

    Objective-C

    - (void)deleteStreamProcessor:
                (nonnull AWSRekognitionDeleteStreamProcessorRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSRekognitionDeleteStreamProcessorResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func deleteStreamProcessor(_ request: AWSRekognitionDeleteStreamProcessorRequest, completionHandler: ((AWSRekognitionDeleteStreamProcessorResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionDescribeCollectionRequest

    See

    AWSRekognitionDescribeCollectionResponse

    Declaration

    Objective-C

    - (id)describeCollection:
        (nonnull AWSRekognitionDescribeCollectionRequest *)request;

    Swift

    func describeCollection(_ request: AWSRekognitionDescribeCollectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionDescribeCollectionRequest

    See

    AWSRekognitionDescribeCollectionResponse

    Declaration

    Objective-C

    - (void)
        describeCollection:
            (nonnull AWSRekognitionDescribeCollectionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSRekognitionDescribeCollectionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeCollection(_ request: AWSRekognitionDescribeCollectionRequest, completionHandler: ((AWSRekognitionDescribeCollectionResponse?, Error?) -> Void)? = nil)

    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.

  • Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don’t specify a value, descriptions for all models are returned.

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

    See

    AWSRekognitionDescribeProjectVersionsRequest

    See

    AWSRekognitionDescribeProjectVersionsResponse

    Declaration

    Objective-C

    - (id)describeProjectVersions:
        (nonnull AWSRekognitionDescribeProjectVersionsRequest *)request;

    Swift

    func describeProjectVersions(_ request: AWSRekognitionDescribeProjectVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don’t specify a value, descriptions for all models are returned.

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

    See

    AWSRekognitionDescribeProjectVersionsRequest

    See

    AWSRekognitionDescribeProjectVersionsResponse

    Declaration

    Objective-C

    - (void)describeProjectVersions:
                (nonnull AWSRekognitionDescribeProjectVersionsRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSRekognitionDescribeProjectVersionsResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeProjectVersions(_ request: AWSRekognitionDescribeProjectVersionsRequest, completionHandler: ((AWSRekognitionDescribeProjectVersionsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeProjectVersions 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: AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

  • Lists and gets information about your Amazon Rekognition Custom Labels projects.

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

    See

    AWSRekognitionDescribeProjectsRequest

    See

    AWSRekognitionDescribeProjectsResponse

    Declaration

    Objective-C

    - (id)describeProjects:(nonnull AWSRekognitionDescribeProjectsRequest *)request;

    Swift

    func describeProjects(_ request: AWSRekognitionDescribeProjectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists and gets information about your Amazon Rekognition Custom Labels projects.

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

    See

    AWSRekognitionDescribeProjectsRequest

    See

    AWSRekognitionDescribeProjectsResponse

    Declaration

    Objective-C

    - (void)describeProjects:
                (nonnull AWSRekognitionDescribeProjectsRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSRekognitionDescribeProjectsResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeProjects(_ request: AWSRekognitionDescribeProjectsRequest, completionHandler: ((AWSRekognitionDescribeProjectsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeProjects 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: AWSRekognitionErrorInvalidPaginationToken, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

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

    See

    AWSRekognitionDescribeStreamProcessorRequest

    See

    AWSRekognitionDescribeStreamProcessorResponse

    Declaration

    Objective-C

    - (id)describeStreamProcessor:
        (nonnull AWSRekognitionDescribeStreamProcessorRequest *)request;

    Swift

    func describeStreamProcessor(_ request: AWSRekognitionDescribeStreamProcessorRequest) -> Any!

    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.

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

    See

    AWSRekognitionDescribeStreamProcessorRequest

    See

    AWSRekognitionDescribeStreamProcessorResponse

    Declaration

    Objective-C

    - (void)describeStreamProcessor:
                (nonnull AWSRekognitionDescribeStreamProcessorRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSRekognitionDescribeStreamProcessorResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeStreamProcessor(_ request: AWSRekognitionDescribeStreamProcessorRequest, completionHandler: ((AWSRekognitionDescribeStreamProcessorResponse?, Error?) -> Void)? = nil)

    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.

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

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

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

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

    During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn’t return labels whose confidence value is below the model’s calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model’s calculated threshold. You can get the model’s calculated threshold from the model’s training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0.

    You can also add the MaxResults parameter to limit the number of labels returned.

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

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

    See

    AWSRekognitionDetectCustomLabelsRequest

    See

    AWSRekognitionDetectCustomLabelsResponse

    Declaration

    Objective-C

    - (id)detectCustomLabels:
        (nonnull AWSRekognitionDetectCustomLabelsRequest *)request;

    Swift

    func detectCustomLabels(_ request: AWSRekognitionDetectCustomLabelsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

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

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

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

    During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn’t return labels whose confidence value is below the model’s calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model’s calculated threshold. You can get the model’s calculated threshold from the model’s training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0.

    You can also add the MaxResults parameter to limit the number of labels returned.

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

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

    See

    AWSRekognitionDetectCustomLabelsRequest

    See

    AWSRekognitionDetectCustomLabelsResponse

    Declaration

    Objective-C

    - (void)
        detectCustomLabels:
            (nonnull AWSRekognitionDetectCustomLabelsRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSRekognitionDetectCustomLabelsResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func detectCustomLabels(_ request: AWSRekognitionDetectCustomLabelsRequest, completionHandler: ((AWSRekognitionDetectCustomLabelsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DetectCustomLabels 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: AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceNotReady, AWSRekognitionErrorInvalidS3Object, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorImageTooLarge, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded, AWSRekognitionErrorInvalidImageFormat.

  • 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), 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 AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

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

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

    See

    AWSRekognitionDetectFacesRequest

    See

    AWSRekognitionDetectFacesResponse

    Declaration

    Objective-C

    - (id)detectFaces:(nonnull AWSRekognitionDetectFacesRequest *)request;

    Swift

    func detectFaces(_ request: AWSRekognitionDetectFacesRequest) -> Any!

    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.

  • 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), 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 AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

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

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

    See

    AWSRekognitionDetectFacesRequest

    See

    AWSRekognitionDetectFacesResponse

    Declaration

    Objective-C

    - (void)detectFaces:(nonnull AWSRekognitionDetectFacesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionDetectFacesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func detectFaces(_ request: AWSRekognitionDetectFacesRequest, completionHandler: ((AWSRekognitionDetectFacesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionDetectLabelsRequest

    See

    AWSRekognitionDetectLabelsResponse

    Declaration

    Objective-C

    - (id)detectLabels:(nonnull AWSRekognitionDetectLabelsRequest *)request;

    Swift

    func detectLabels(_ request: AWSRekognitionDetectLabelsRequest) -> Any!

    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.

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

    See

    AWSRekognitionDetectLabelsRequest

    See

    AWSRekognitionDetectLabelsResponse

    Declaration

    Objective-C

    - (void)detectLabels:(nonnull AWSRekognitionDetectLabelsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionDetectLabelsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func detectLabels(_ request: AWSRekognitionDetectLabelsRequest, completionHandler: ((AWSRekognitionDetectLabelsResponse?, Error?) -> Void)? = nil)

    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.

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

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

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

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

    See

    AWSRekognitionDetectModerationLabelsRequest

    See

    AWSRekognitionDetectModerationLabelsResponse

    Declaration

    Objective-C

    - (id)detectModerationLabels:
        (nonnull AWSRekognitionDetectModerationLabelsRequest *)request;

    Swift

    func detectModerationLabels(_ request: AWSRekognitionDetectModerationLabelsRequest) -> Any!

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

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

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

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

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

    See

    AWSRekognitionDetectModerationLabelsRequest

    See

    AWSRekognitionDetectModerationLabelsResponse

    Declaration

    Objective-C

    - (void)detectModerationLabels:
                (nonnull AWSRekognitionDetectModerationLabelsRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSRekognitionDetectModerationLabelsResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func detectModerationLabels(_ request: AWSRekognitionDetectModerationLabelsRequest, completionHandler: ((AWSRekognitionDetectModerationLabelsResponse?, Error?) -> Void)? = nil)

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

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

    See

    AWSRekognitionDetectTextRequest

    See

    AWSRekognitionDetectTextResponse

    Declaration

    Objective-C

    - (id)detectText:(nonnull AWSRekognitionDetectTextRequest *)request;

    Swift

    func detectText(_ request: AWSRekognitionDetectTextRequest) -> Any!

    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.

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

    See

    AWSRekognitionDetectTextRequest

    See

    AWSRekognitionDetectTextResponse

    Declaration

    Objective-C

    - (void)detectText:(nonnull AWSRekognitionDetectTextRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionDetectTextResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func detectText(_ request: AWSRekognitionDetectTextRequest, completionHandler: ((AWSRekognitionDetectTextResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionGetCelebrityInfoRequest

    See

    AWSRekognitionGetCelebrityInfoResponse

    Declaration

    Objective-C

    - (id)getCelebrityInfo:(nonnull AWSRekognitionGetCelebrityInfoRequest *)request;

    Swift

    func getCelebrityInfo(_ request: AWSRekognitionGetCelebrityInfoRequest) -> Any!

    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.

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

    See

    AWSRekognitionGetCelebrityInfoRequest

    See

    AWSRekognitionGetCelebrityInfoResponse

    Declaration

    Objective-C

    - (void)getCelebrityInfo:
                (nonnull AWSRekognitionGetCelebrityInfoRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSRekognitionGetCelebrityInfoResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getCelebrityInfo(_ request: AWSRekognitionGetCelebrityInfoRequest, completionHandler: ((AWSRekognitionGetCelebrityInfoResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionGetCelebrityRecognitionRequest

    See

    AWSRekognitionGetCelebrityRecognitionResponse

    Declaration

    Objective-C

    - (id)getCelebrityRecognition:
        (nonnull AWSRekognitionGetCelebrityRecognitionRequest *)request;

    Swift

    func getCelebrityRecognition(_ request: AWSRekognitionGetCelebrityRecognitionRequest) -> Any!

    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.

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

    See

    AWSRekognitionGetCelebrityRecognitionRequest

    See

    AWSRekognitionGetCelebrityRecognitionResponse

    Declaration

    Objective-C

    - (void)getCelebrityRecognition:
                (nonnull AWSRekognitionGetCelebrityRecognitionRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSRekognitionGetCelebrityRecognitionResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func getCelebrityRecognition(_ request: AWSRekognitionGetCelebrityRecognitionRequest, completionHandler: ((AWSRekognitionGetCelebrityRecognitionResponse?, Error?) -> Void)? = nil)

    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.

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

    Unsafe content 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 unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

    GetContentModeration returns detected unsafe content 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.

    See

    AWSRekognitionGetContentModerationRequest

    See

    AWSRekognitionGetContentModerationResponse

    Declaration

    Objective-C

    - (id)getContentModeration:
        (nonnull AWSRekognitionGetContentModerationRequest *)request;

    Swift

    func getContentModeration(_ request: AWSRekognitionGetContentModerationRequest) -> Any!

    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.

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

    Unsafe content 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 unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

    GetContentModeration returns detected unsafe content 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.

    See

    AWSRekognitionGetContentModerationRequest

    See

    AWSRekognitionGetContentModerationResponse

    Declaration

    Objective-C

    - (void)getContentModeration:
                (nonnull AWSRekognitionGetContentModerationRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSRekognitionGetContentModerationResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func getContentModeration(_ request: AWSRekognitionGetContentModerationRequest, completionHandler: ((AWSRekognitionGetContentModerationResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionGetFaceDetectionRequest

    See

    AWSRekognitionGetFaceDetectionResponse

    Declaration

    Objective-C

    - (id)getFaceDetection:(nonnull AWSRekognitionGetFaceDetectionRequest *)request;

    Swift

    func getFaceDetection(_ request: AWSRekognitionGetFaceDetectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionGetFaceDetectionRequest

    See

    AWSRekognitionGetFaceDetectionResponse

    Declaration

    Objective-C

    - (void)getFaceDetection:
                (nonnull AWSRekognitionGetFaceDetectionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSRekognitionGetFaceDetectionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getFaceDetection(_ request: AWSRekognitionGetFaceDetectionRequest, completionHandler: ((AWSRekognitionGetFaceDetectionResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionGetFaceSearchRequest

    See

    AWSRekognitionGetFaceSearchResponse

    Declaration

    Objective-C

    - (id)getFaceSearch:(nonnull AWSRekognitionGetFaceSearchRequest *)request;

    Swift

    func getFaceSearch(_ request: AWSRekognitionGetFaceSearchRequest) -> Any!

    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.

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

    See

    AWSRekognitionGetFaceSearchRequest

    See

    AWSRekognitionGetFaceSearchResponse

    Declaration

    Objective-C

    - (void)getFaceSearch:(nonnull AWSRekognitionGetFaceSearchRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionGetFaceSearchResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func getFaceSearch(_ request: AWSRekognitionGetFaceSearchRequest, completionHandler: ((AWSRekognitionGetFaceSearchResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionGetLabelDetectionRequest

    See

    AWSRekognitionGetLabelDetectionResponse

    Declaration

    Objective-C

    - (id)getLabelDetection:
        (nonnull AWSRekognitionGetLabelDetectionRequest *)request;

    Swift

    func getLabelDetection(_ request: AWSRekognitionGetLabelDetectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionGetLabelDetectionRequest

    See

    AWSRekognitionGetLabelDetectionResponse

    Declaration

    Objective-C

    - (void)
        getLabelDetection:(nonnull AWSRekognitionGetLabelDetectionRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionGetLabelDetectionResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func getLabelDetection(_ request: AWSRekognitionGetLabelDetectionRequest, completionHandler: ((AWSRekognitionGetLabelDetectionResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionGetPersonTrackingRequest

    See

    AWSRekognitionGetPersonTrackingResponse

    Declaration

    Objective-C

    - (id)getPersonTracking:
        (nonnull AWSRekognitionGetPersonTrackingRequest *)request;

    Swift

    func getPersonTracking(_ request: AWSRekognitionGetPersonTrackingRequest) -> Any!

    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.

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

    See

    AWSRekognitionGetPersonTrackingRequest

    See

    AWSRekognitionGetPersonTrackingResponse

    Declaration

    Objective-C

    - (void)
        getPersonTracking:(nonnull AWSRekognitionGetPersonTrackingRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionGetPersonTrackingResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func getPersonTracking(_ request: AWSRekognitionGetPersonTrackingRequest, completionHandler: ((AWSRekognitionGetPersonTrackingResponse?, Error?) -> Void)? = nil)

    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.

  • Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

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

    GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

    Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

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

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

    See

    AWSRekognitionGetSegmentDetectionRequest

    See

    AWSRekognitionGetSegmentDetectionResponse

    Declaration

    Objective-C

    - (id)getSegmentDetection:
        (nonnull AWSRekognitionGetSegmentDetectionRequest *)request;

    Swift

    func getSegmentDetection(_ request: AWSRekognitionGetSegmentDetectionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

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

    GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

    Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

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

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

    See

    AWSRekognitionGetSegmentDetectionRequest

    See

    AWSRekognitionGetSegmentDetectionResponse

    Declaration

    Objective-C

    - (void)getSegmentDetection:
                (nonnull AWSRekognitionGetSegmentDetectionRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSRekognitionGetSegmentDetectionResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func getSegmentDetection(_ request: AWSRekognitionGetSegmentDetectionRequest, completionHandler: ((AWSRekognitionGetSegmentDetectionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetSegmentDetection 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.

  • Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

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

    GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.

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

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

    See

    AWSRekognitionGetTextDetectionRequest

    See

    AWSRekognitionGetTextDetectionResponse

    Declaration

    Objective-C

    - (id)getTextDetection:(nonnull AWSRekognitionGetTextDetectionRequest *)request;

    Swift

    func getTextDetection(_ request: AWSRekognitionGetTextDetectionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

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

    GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.

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

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

    See

    AWSRekognitionGetTextDetectionRequest

    See

    AWSRekognitionGetTextDetectionResponse

    Declaration

    Objective-C

    - (void)getTextDetection:
                (nonnull AWSRekognitionGetTextDetectionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSRekognitionGetTextDetectionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getTextDetection(_ request: AWSRekognitionGetTextDetectionRequest, completionHandler: ((AWSRekognitionGetTextDetectionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetTextDetection 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.

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

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

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

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

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

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

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

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

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

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

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

    To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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

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

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

    • The face is too blurry.

    • The image is too dark.

    • The face has an extreme pose.

    • The face doesn’t have enough detail to be suitable for face search.

    In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

    • The bounding box, BoundingBox, of the detected face.

    • A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.

    • A face ID, FaceId, assigned by the service for each face that’s detected and stored.

    • An image ID, ImageId, assigned by the service for the input image.

    If you request all 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. 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.

    See

    AWSRekognitionIndexFacesRequest

    See

    AWSRekognitionIndexFacesResponse

    Declaration

    Objective-C

    - (id)indexFaces:(nonnull AWSRekognitionIndexFacesRequest *)request;

    Swift

    func indexFaces(_ request: AWSRekognitionIndexFacesRequest) -> Any!

    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.

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

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

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

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

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

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

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

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

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

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

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

    To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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

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

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

    • The face is too blurry.

    • The image is too dark.

    • The face has an extreme pose.

    • The face doesn’t have enough detail to be suitable for face search.

    In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

    • The bounding box, BoundingBox, of the detected face.

    • A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.

    • A face ID, FaceId, assigned by the service for each face that’s detected and stored.

    • An image ID, ImageId, assigned by the service for the input image.

    If you request all 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. 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.

    See

    AWSRekognitionIndexFacesRequest

    See

    AWSRekognitionIndexFacesResponse

    Declaration

    Objective-C

    - (void)indexFaces:(nonnull AWSRekognitionIndexFacesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionIndexFacesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func indexFaces(_ request: AWSRekognitionIndexFacesRequest, completionHandler: ((AWSRekognitionIndexFacesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionListCollectionsRequest

    See

    AWSRekognitionListCollectionsResponse

    Declaration

    Objective-C

    - (id)listCollections:(nonnull AWSRekognitionListCollectionsRequest *)request;

    Swift

    func listCollections(_ request: AWSRekognitionListCollectionsRequest) -> Any!

    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.

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

    See

    AWSRekognitionListCollectionsRequest

    See

    AWSRekognitionListCollectionsResponse

    Declaration

    Objective-C

    - (void)listCollections:(nonnull AWSRekognitionListCollectionsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSRekognitionListCollectionsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listCollections(_ request: AWSRekognitionListCollectionsRequest, completionHandler: ((AWSRekognitionListCollectionsResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionListFacesRequest

    See

    AWSRekognitionListFacesResponse

    Declaration

    Objective-C

    - (id)listFaces:(nonnull AWSRekognitionListFacesRequest *)request;

    Swift

    func listFaces(_ request: AWSRekognitionListFacesRequest) -> Any!

    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.

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

    See

    AWSRekognitionListFacesRequest

    See

    AWSRekognitionListFacesResponse

    Declaration

    Objective-C

    - (void)listFaces:(nonnull AWSRekognitionListFacesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionListFacesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listFaces(_ request: AWSRekognitionListFacesRequest, completionHandler: ((AWSRekognitionListFacesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionListStreamProcessorsRequest

    See

    AWSRekognitionListStreamProcessorsResponse

    Declaration

    Objective-C

    - (id)listStreamProcessors:
        (nonnull AWSRekognitionListStreamProcessorsRequest *)request;

    Swift

    func listStreamProcessors(_ request: AWSRekognitionListStreamProcessorsRequest) -> Any!

    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.

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

    See

    AWSRekognitionListStreamProcessorsRequest

    See

    AWSRekognitionListStreamProcessorsResponse

    Declaration

    Objective-C

    - (void)listStreamProcessors:
                (nonnull AWSRekognitionListStreamProcessorsRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSRekognitionListStreamProcessorsResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listStreamProcessors(_ request: AWSRekognitionListStreamProcessorsRequest, completionHandler: ((AWSRekognitionListStreamProcessorsResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionRecognizeCelebritiesRequest

    See

    AWSRekognitionRecognizeCelebritiesResponse

    Declaration

    Objective-C

    - (id)recognizeCelebrities:
        (nonnull AWSRekognitionRecognizeCelebritiesRequest *)request;

    Swift

    func recognizeCelebrities(_ request: AWSRekognitionRecognizeCelebritiesRequest) -> Any!

    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.

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

    See

    AWSRekognitionRecognizeCelebritiesRequest

    See

    AWSRekognitionRecognizeCelebritiesResponse

    Declaration

    Objective-C

    - (void)recognizeCelebrities:
                (nonnull AWSRekognitionRecognizeCelebritiesRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSRekognitionRecognizeCelebritiesResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func recognizeCelebrities(_ request: AWSRekognitionRecognizeCelebritiesRequest, completionHandler: ((AWSRekognitionRecognizeCelebritiesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionSearchFacesRequest

    See

    AWSRekognitionSearchFacesResponse

    Declaration

    Objective-C

    - (id)searchFaces:(nonnull AWSRekognitionSearchFacesRequest *)request;

    Swift

    func searchFaces(_ request: AWSRekognitionSearchFacesRequest) -> Any!

    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.

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

    See

    AWSRekognitionSearchFacesRequest

    See

    AWSRekognitionSearchFacesResponse

    Declaration

    Objective-C

    - (void)searchFaces:(nonnull AWSRekognitionSearchFacesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSRekognitionSearchFacesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func searchFaces(_ request: AWSRekognitionSearchFacesRequest, completionHandler: ((AWSRekognitionSearchFacesResponse?, Error?) -> Void)? = nil)

    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.

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

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

    To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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

    See

    AWSRekognitionSearchFacesByImageRequest

    See

    AWSRekognitionSearchFacesByImageResponse

    Declaration

    Objective-C

    - (id)searchFacesByImage:
        (nonnull AWSRekognitionSearchFacesByImageRequest *)request;

    Swift

    func searchFaces(byImage request: AWSRekognitionSearchFacesByImageRequest) -> Any!

    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.

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

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

    To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

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

    See

    AWSRekognitionSearchFacesByImageRequest

    See

    AWSRekognitionSearchFacesByImageResponse

    Declaration

    Objective-C

    - (void)
        searchFacesByImage:
            (nonnull AWSRekognitionSearchFacesByImageRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSRekognitionSearchFacesByImageResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func searchFaces(byImage request: AWSRekognitionSearchFacesByImageRequest, completionHandler: ((AWSRekognitionSearchFacesByImageResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionStartCelebrityRecognitionRequest

    See

    AWSRekognitionStartCelebrityRecognitionResponse

    Declaration

    Objective-C

    - (id)startCelebrityRecognition:
        (nonnull AWSRekognitionStartCelebrityRecognitionRequest *)request;

    Swift

    func startCelebrityRecognition(_ request: AWSRekognitionStartCelebrityRecognitionRequest) -> Any!

    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.

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

    See

    AWSRekognitionStartCelebrityRecognitionRequest

    See

    AWSRekognitionStartCelebrityRecognitionResponse

    Declaration

    Objective-C

    - (void)
        startCelebrityRecognition:
            (nonnull AWSRekognitionStartCelebrityRecognitionRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSRekognitionStartCelebrityRecognitionResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func startCelebrityRecognition(_ request: AWSRekognitionStartCelebrityRecognitionRequest, completionHandler: ((AWSRekognitionStartCelebrityRecognitionResponse?, Error?) -> Void)? = nil)

    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.

  • Starts asynchronous detection of unsafe 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 unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

    To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

    See

    AWSRekognitionStartContentModerationRequest

    See

    AWSRekognitionStartContentModerationResponse

    Declaration

    Objective-C

    - (id)startContentModeration:
        (nonnull AWSRekognitionStartContentModerationRequest *)request;

    Swift

    func startContentModeration(_ request: AWSRekognitionStartContentModerationRequest) -> Any!

    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.

  • Starts asynchronous detection of unsafe 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 unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

    To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

    See

    AWSRekognitionStartContentModerationRequest

    See

    AWSRekognitionStartContentModerationResponse

    Declaration

    Objective-C

    - (void)startContentModeration:
                (nonnull AWSRekognitionStartContentModerationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSRekognitionStartContentModerationResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func startContentModeration(_ request: AWSRekognitionStartContentModerationRequest, completionHandler: ((AWSRekognitionStartContentModerationResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionStartFaceDetectionRequest

    See

    AWSRekognitionStartFaceDetectionResponse

    Declaration

    Objective-C

    - (id)startFaceDetection:
        (nonnull AWSRekognitionStartFaceDetectionRequest *)request;

    Swift

    func startFaceDetection(_ request: AWSRekognitionStartFaceDetectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionStartFaceDetectionRequest

    See

    AWSRekognitionStartFaceDetectionResponse

    Declaration

    Objective-C

    - (void)
        startFaceDetection:
            (nonnull AWSRekognitionStartFaceDetectionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSRekognitionStartFaceDetectionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func startFaceDetection(_ request: AWSRekognitionStartFaceDetectionRequest, completionHandler: ((AWSRekognitionStartFaceDetectionResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionStartFaceSearchRequest

    See

    AWSRekognitionStartFaceSearchResponse

    Declaration

    Objective-C

    - (id)startFaceSearch:(nonnull AWSRekognitionStartFaceSearchRequest *)request;

    Swift

    func startFaceSearch(_ request: AWSRekognitionStartFaceSearchRequest) -> Any!

    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.

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

    See

    AWSRekognitionStartFaceSearchRequest

    See

    AWSRekognitionStartFaceSearchResponse

    Declaration

    Objective-C

    - (void)startFaceSearch:(nonnull AWSRekognitionStartFaceSearchRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSRekognitionStartFaceSearchResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func startFaceSearch(_ request: AWSRekognitionStartFaceSearchRequest, completionHandler: ((AWSRekognitionStartFaceSearchResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionStartLabelDetectionRequest

    See

    AWSRekognitionStartLabelDetectionResponse

    Declaration

    Objective-C

    - (id)startLabelDetection:
        (nonnull AWSRekognitionStartLabelDetectionRequest *)request;

    Swift

    func startLabelDetection(_ request: AWSRekognitionStartLabelDetectionRequest) -> Any!

    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.

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

    See

    AWSRekognitionStartLabelDetectionRequest

    See

    AWSRekognitionStartLabelDetectionResponse

    Declaration

    Objective-C

    - (void)startLabelDetection:
                (nonnull AWSRekognitionStartLabelDetectionRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSRekognitionStartLabelDetectionResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func startLabelDetection(_ request: AWSRekognitionStartLabelDetectionRequest, completionHandler: ((AWSRekognitionStartLabelDetectionResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSRekognitionStartPersonTrackingRequest

    See

    AWSRekognitionStartPersonTrackingResponse

    Declaration

    Objective-C

    - (id)startPersonTracking:
        (nonnull AWSRekognitionStartPersonTrackingRequest *)request;

    Swift

    func startPersonTracking(_ request: AWSRekognitionStartPersonTrackingRequest) -> Any!

    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.

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

    See

    AWSRekognitionStartPersonTrackingRequest

    See

    AWSRekognitionStartPersonTrackingResponse

    Declaration

    Objective-C

    - (void)startPersonTracking:
                (nonnull AWSRekognitionStartPersonTrackingRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSRekognitionStartPersonTrackingResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func startPersonTracking(_ request: AWSRekognitionStartPersonTrackingRequest, completionHandler: ((AWSRekognitionStartPersonTrackingResponse?, Error?) -> Void)? = nil)

    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.

  • Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

    Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

    You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

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

    See

    AWSRekognitionStartProjectVersionRequest

    See

    AWSRekognitionStartProjectVersionResponse

    Declaration

    Objective-C

    - (id)startProjectVersion:
        (nonnull AWSRekognitionStartProjectVersionRequest *)request;

    Swift

    func startProjectVersion(_ request: AWSRekognitionStartProjectVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

    Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

    You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

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

    See

    AWSRekognitionStartProjectVersionRequest

    See

    AWSRekognitionStartProjectVersionResponse

    Declaration

    Objective-C

    - (void)startProjectVersion:
                (nonnull AWSRekognitionStartProjectVersionRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSRekognitionStartProjectVersionResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func startProjectVersion(_ request: AWSRekognitionStartProjectVersionRequest, completionHandler: ((AWSRekognitionStartProjectVersionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StartProjectVersion 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: AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorLimitExceeded, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

  • Starts asynchronous detection of segment detection in a stored video.

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

    You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

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

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

    See

    AWSRekognitionStartSegmentDetectionRequest

    See

    AWSRekognitionStartSegmentDetectionResponse

    Declaration

    Objective-C

    - (id)startSegmentDetection:
        (nonnull AWSRekognitionStartSegmentDetectionRequest *)request;

    Swift

    func startSegmentDetection(_ request: AWSRekognitionStartSegmentDetectionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartSegmentDetectionResponse. 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.

  • Starts asynchronous detection of segment detection in a stored video.

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

    You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

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

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

    See

    AWSRekognitionStartSegmentDetectionRequest

    See

    AWSRekognitionStartSegmentDetectionResponse

    Declaration

    Objective-C

    - (void)startSegmentDetection:
                (nonnull AWSRekognitionStartSegmentDetectionRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSRekognitionStartSegmentDetectionResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func startSegmentDetection(_ request: AWSRekognitionStartSegmentDetectionRequest, completionHandler: ((AWSRekognitionStartSegmentDetectionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StartSegmentDetection 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.

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

    See

    AWSRekognitionStartStreamProcessorRequest

    See

    AWSRekognitionStartStreamProcessorResponse

    Declaration

    Objective-C

    - (id)startStreamProcessor:
        (nonnull AWSRekognitionStartStreamProcessorRequest *)request;

    Swift

    func startStreamProcessor(_ request: AWSRekognitionStartStreamProcessorRequest) -> Any!

    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.

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

    See

    AWSRekognitionStartStreamProcessorRequest

    See

    AWSRekognitionStartStreamProcessorResponse

    Declaration

    Objective-C

    - (void)startStreamProcessor:
                (nonnull AWSRekognitionStartStreamProcessorRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSRekognitionStartStreamProcessorResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func startStreamProcessor(_ request: AWSRekognitionStartStreamProcessorRequest, completionHandler: ((AWSRekognitionStartStreamProcessorResponse?, Error?) -> Void)? = nil)

    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.

  • Starts asynchronous detection of text in a stored video.

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

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

    See

    AWSRekognitionStartTextDetectionRequest

    See

    AWSRekognitionStartTextDetectionResponse

    Declaration

    Objective-C

    - (id)startTextDetection:
        (nonnull AWSRekognitionStartTextDetectionRequest *)request;

    Swift

    func startTextDetection(_ request: AWSRekognitionStartTextDetectionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSRekognitionStartTextDetectionResponse. 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.

  • Starts asynchronous detection of text in a stored video.

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

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

    See

    AWSRekognitionStartTextDetectionRequest

    See

    AWSRekognitionStartTextDetectionResponse

    Declaration

    Objective-C

    - (void)
        startTextDetection:
            (nonnull AWSRekognitionStartTextDetectionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSRekognitionStartTextDetectionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func startTextDetection(_ request: AWSRekognitionStartTextDetectionRequest, completionHandler: ((AWSRekognitionStartTextDetectionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StartTextDetection 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.

  • Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.

    See

    AWSRekognitionStopProjectVersionRequest

    See

    AWSRekognitionStopProjectVersionResponse

    Declaration

    Objective-C

    - (id)stopProjectVersion:
        (nonnull AWSRekognitionStopProjectVersionRequest *)request;

    Swift

    func stopProjectVersion(_ request: AWSRekognitionStopProjectVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.

    See

    AWSRekognitionStopProjectVersionRequest

    See

    AWSRekognitionStopProjectVersionResponse

    Declaration

    Objective-C

    - (void)
        stopProjectVersion:
            (nonnull AWSRekognitionStopProjectVersionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSRekognitionStopProjectVersionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func stopProjectVersion(_ request: AWSRekognitionStopProjectVersionRequest, completionHandler: ((AWSRekognitionStopProjectVersionResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StopProjectVersion 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: AWSRekognitionErrorResourceNotFound, AWSRekognitionErrorResourceInUse, AWSRekognitionErrorInvalidParameter, AWSRekognitionErrorAccessDenied, AWSRekognitionErrorInternalServer, AWSRekognitionErrorThrottling, AWSRekognitionErrorProvisionedThroughputExceeded.

  • Stops a running stream processor that was created by CreateStreamProcessor.

    See

    AWSRekognitionStopStreamProcessorRequest

    See

    AWSRekognitionStopStreamProcessorResponse

    Declaration

    Objective-C

    - (id)stopStreamProcessor:
        (nonnull AWSRekognitionStopStreamProcessorRequest *)request;

    Swift

    func stopStreamProcessor(_ request: AWSRekognitionStopStreamProcessorRequest) -> Any!

    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.

  • Stops a running stream processor that was created by CreateStreamProcessor.

    See

    AWSRekognitionStopStreamProcessorRequest

    See

    AWSRekognitionStopStreamProcessorResponse

    Declaration

    Objective-C

    - (void)stopStreamProcessor:
                (nonnull AWSRekognitionStopStreamProcessorRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSRekognitionStopStreamProcessorResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func stopStreamProcessor(_ request: AWSRekognitionStopStreamProcessorRequest, completionHandler: ((AWSRekognitionStopStreamProcessorResponse?, Error?) -> Void)? = nil)

    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.