AssociateFaces

$result = $client->associateFaces([/* ... */]);
$promise = $client->associateFacesAsync([/* ... */]);

Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each FaceId that are present in the FaceIds list is associated with the provided UserID. The number of FaceIds that can be used as input in a single request is limited to 100.

Note that the total number of faces that can be associated with a single UserID is also limited to 100. Once a UserID has 100 faces associated with it, no additional faces can be added. If more API calls are made after the limit is reached, a ServiceQuotaExceededException will result.

The UserMatchThreshold parameter specifies the minimum user match confidence required for the face to be associated with a UserID that has at least one FaceID already associated. This ensures that the FaceIds are associated with the right UserID. The value ranges from 0-100 and default value is 75.

If successful, an array of AssociatedFace objects containing the associated FaceIds is returned. If a given face is already associated with the given UserID, it will be ignored and will not be returned in the response. If a given face is already associated to a different UserID, isn't found in the collection, doesn’t meet the UserMatchThreshold, or there are already 100 faces associated with the UserID, it will be returned as part of an array of UnsuccessfulFaceAssociations.

The UserStatus reflects the status of an operation which updates a UserID representation with a list of given faces. The UserStatus can be:

• ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.

• CREATED - A UserID has been created, but has no FaceID(s) associated with it.

• UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking place.

Parameter Syntax

$result = $client->associateFaces([
    'ClientRequestToken' => '<string>',
    'CollectionId' => '<string>', // REQUIRED
    'FaceIds' => ['<string>', ...], // REQUIRED
    'UserId' => '<string>', // REQUIRED
    'UserMatchThreshold' => <float>,
]);

Parameter Details

Result Syntax

[
    'AssociatedFaces' => [
        [
            'FaceId' => '<string>',
        ],
        // ...
    ],
    'UnsuccessfulFaceAssociations' => [
        [
            'Confidence' => <float>,
            'FaceId' => '<string>',
            'Reasons' => ['<string>', ...],
            'UserId' => '<string>',
        ],
        // ...
    ],
    'UserStatus' => 'ACTIVE|UPDATING|CREATING|CREATED',
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ConflictException:

A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

Examples

Example 1: AssociateFaces

This operation associates one or more faces with an existing UserID.

$result = $client->associateFaces([
    'ClientRequestToken' => '550e8400-e29b-41d4-a716-446655440002',
    'CollectionId' => 'MyCollection',
    'FaceIds' => [
        'f5817d37-94f6-4335-bfee-6cf79a3d806e',
        '851cb847-dccc-4fea-9309-9f4805967855',
        '35ebbb41-7f67-4263-908d-dd0ecba05ab9',
    ],
    'UserId' => 'DemoUser',
    'UserMatchThreshold' => 70,
]);

Result syntax:

[
    'AssociatedFaces' => [
        [
            'FaceId' => '35ebbb41-7f67-4263-908d-dd0ecba05ab9',
        ],
    ],
    'UnsuccessfulFaceAssociations' => [
        [
            'Confidence' => 0.93753749132156,
            'FaceId' => 'f5817d37-94f6-4335-bfee-6cf79a3d806e',
            'Reasons' => [
                'LOW_MATCH_CONFIDENCE',
            ],
        ],
        [
            'FaceId' => '851cb847-dccc-4fea-9309-9f4805967855',
            'Reasons' => [
                'ASSOCIATED_TO_A_DIFFERENT_USER',
            ],
            'UserId' => 'demoUser2',
        ],
    ],
    'UserStatus' => 'UPDATING',
]

CompareFaces

$result = $client->compareFaces([/* ... */]);
$promise = $client->compareFacesAsync([/* ... */]);

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, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.

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

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.

If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error.

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

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

Parameter Syntax

$result = $client->compareFaces([
    'QualityFilter' => 'NONE|AUTO|LOW|MEDIUM|HIGH',
    'SimilarityThreshold' => <float>,
    'SourceImage' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'TargetImage' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'FaceMatches' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'Emotions' => [
                    [
                        'Confidence' => <float>,
                        'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                    ],
                    // ...
                ],
                'Landmarks' => [
                    [
                        'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
                'Pose' => [
                    'Pitch' => <float>,
                    'Roll' => <float>,
                    'Yaw' => <float>,
                ],
                'Quality' => [
                    'Brightness' => <float>,
                    'Sharpness' => <float>,
                ],
                'Smile' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
            ],
            'Similarity' => <float>,
        ],
        // ...
    ],
    'SourceImageFace' => [
        'BoundingBox' => [
            'Height' => <float>,
            'Left' => <float>,
            'Top' => <float>,
            'Width' => <float>,
        ],
        'Confidence' => <float>,
    ],
    'SourceImageOrientationCorrection' => 'ROTATE_0|ROTATE_90|ROTATE_180|ROTATE_270',
    'TargetImageOrientationCorrection' => 'ROTATE_0|ROTATE_90|ROTATE_180|ROTATE_270',
    'UnmatchedFaces' => [
        [
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Confidence' => <float>,
            'Emotions' => [
                [
                    'Confidence' => <float>,
                    'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                ],
                // ...
            ],
            'Landmarks' => [
                [
                    'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                    'X' => <float>,
                    'Y' => <float>,
                ],
                // ...
            ],
            'Pose' => [
                'Pitch' => <float>,
                'Roll' => <float>,
                'Yaw' => <float>,
            ],
            'Quality' => [
                'Brightness' => <float>,
                'Sharpness' => <float>,
            ],
            'Smile' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

Examples

Example 1: To compare two images

This operation compares the largest face detected in the source image with each face detected in the target image.

$result = $client->compareFaces([
    'SimilarityThreshold' => 90,
    'SourceImage' => [
        'S3Object' => [
            'Bucket' => 'mybucket',
            'Name' => 'mysourceimage',
        ],
    ],
    'TargetImage' => [
        'S3Object' => [
            'Bucket' => 'mybucket',
            'Name' => 'mytargetimage',
        ],
    ],
]);

Result syntax:

[
    'FaceMatches' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.33481481671333,
                    'Left' => 0.31888890266418,
                    'Top' => 0.49333333969116,
                    'Width' => 0.25,
                ],
                'Confidence' => 99.999122619629,
            ],
            'Similarity' => 100,
        ],
    ],
    'SourceImageFace' => [
        'BoundingBox' => [
            'Height' => 0.33481481671333,
            'Left' => 0.31888890266418,
            'Top' => 0.49333333969116,
            'Width' => 0.25,
        ],
        'Confidence' => 99.999122619629,
    ],
]

CopyProjectVersion

$result = $client->copyProjectVersion([/* ... */]);
$promise = $client->copyProjectVersionAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service.

To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account.

For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED.

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

Parameter Syntax

$result = $client->copyProjectVersion([
    'DestinationProjectArn' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>',
    'OutputConfig' => [ // REQUIRED
        'S3Bucket' => '<string>',
        'S3KeyPrefix' => '<string>',
    ],
    'SourceProjectArn' => '<string>', // REQUIRED
    'SourceProjectVersionArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'VersionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProjectVersionArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceInUseException:

The specified resource is already being used.

Examples

Example 1: CopyProjectVersion

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.

$result = $client->copyProjectVersion([
    'DestinationProjectArn' => 'arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765',
    'KmsKeyId' => 'arn:1234abcd-12ab-34cd-56ef-1234567890ab',
    'OutputConfig' => [
        'S3Bucket' => 'bucket-name',
        'S3KeyPrefix' => 'path_to_folder',
    ],
    'SourceProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456',
    'SourceProjectVersionArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456',
    'Tags' => [
        'key1' => 'val1',
    ],
    'VersionName' => 'DestinationVersionName_cross_account',
]);

Result syntax:

[
    'ProjectVersionArn' => 'arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/version/DestinationVersionName_cross_account/16567050987651',
]

CreateCollection

$result = $client->createCollection([/* ... */]);
$promise = $client->createCollectionAsync([/* ... */]);

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.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.

Parameter Syntax

$result = $client->createCollection([
    'CollectionId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CollectionArn' => '<string>',
    'FaceModelVersion' => '<string>',
    'StatusCode' => <integer>,
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceAlreadyExistsException:

A resource with the specified ID already exists.

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

Examples

Example 1: To create a collection

This operation creates a Rekognition collection for storing image data.

$result = $client->createCollection([
    'CollectionId' => 'myphotos',
]);

Result syntax:

[
    'CollectionArn' => 'aws:rekognition:us-west-2:123456789012:collection/myphotos',
    'StatusCode' => 200,
]

CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

To create a training dataset for a project, specify TRAIN for the value of DatasetType. To create the test dataset for a project, specify TEST for the value of DatasetType.

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.

To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information.

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

Parameter Syntax

$result = $client->createDataset([
    'DatasetSource' => [
        'DatasetArn' => '<string>',
        'GroundTruthManifest' => [
            'S3Object' => [
                'Bucket' => '<string>',
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
    ],
    'DatasetType' => 'TRAIN|TEST', // REQUIRED
    'ProjectArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DatasetArn' => '<string>',
]

Result Details

Errors

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

ResourceAlreadyExistsException:

A resource with the specified ID already exists.

ResourceNotFoundException:

The resource specified in the request cannot be found.

Examples

Example 1: To create an Amazon Rekognition Custom Labels dataset

Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket.

$result = $client->createDataset([
    'DatasetSource' => [
        'GroundTruthManifest' => [
            'S3Object' => [
                'Bucket' => 'my-bucket',
                'Name' => 'datasets/flowers_training/manifests/output/output.manifest',
            ],
        ],
    ],
    'DatasetType' => 'TRAIN',
    'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815',
]);

Result syntax:

[
    'DatasetArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535',
]

CreateFaceLivenessSession

$result = $client->createFaceLivenessSession([/* ... */]);
$promise = $client->createFaceLivenessSessionAsync([/* ... */]);

This API operation initiates a Face Liveness session. It returns a SessionId, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session.

You can use the OutputConfig option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead.

You can use AuditImagesLimit to limit the number of audit images returned when GetFaceLivenessSessionResults is called. This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on the duration of the selfie-video.

Parameter Syntax

$result = $client->createFaceLivenessSession([
    'ClientRequestToken' => '<string>',
    'KmsKeyId' => '<string>',
    'Settings' => [
        'AuditImagesLimit' => <integer>,
        'ChallengePreferences' => [
            [
                'Type' => 'FaceMovementAndLightChallenge|FaceMovementChallenge', // REQUIRED
                'Versions' => [
                    'Maximum' => '<string>',
                    'Minimum' => '<string>',
                ],
            ],
            // ...
        ],
        'OutputConfig' => [
            'S3Bucket' => '<string>', // REQUIRED
            'S3KeyPrefix' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'SessionId' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

CreateProject

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions) that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires permissions to perform the rekognition:CreateProject action.

Parameter Syntax

$result = $client->createProject([
    'AutoUpdate' => 'ENABLED|DISABLED',
    'Feature' => 'CONTENT_MODERATION|CUSTOM_LABELS',
    'ProjectName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ProjectArn' => '<string>',
]

Result Details

Errors

ResourceInUseException:

The specified resource is already being used.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

Examples

Example 1: To create an Amazon Rekognition Custom Labels project

Creates an Amazon Rekognition Custom Labels project.

$result = $client->createProject([
    'ProjectName' => 'my-project',
]);

Result syntax:

[
    'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285',
]

CreateProjectVersion

$result = $client->createProjectVersion([/* ... */]);
$promise = $client->createProjectVersionAsync([/* ... */]);

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the project version.

The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

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

Parameter Syntax

$result = $client->createProjectVersion([
    'FeatureConfig' => [
        'ContentModeration' => [
            'ConfidenceThreshold' => <float>,
        ],
    ],
    'KmsKeyId' => '<string>',
    'OutputConfig' => [ // REQUIRED
        'S3Bucket' => '<string>',
        'S3KeyPrefix' => '<string>',
    ],
    'ProjectArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'TestingData' => [
        'Assets' => [
            [
                'GroundTruthManifest' => [
                    'S3Object' => [
                        'Bucket' => '<string>',
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'AutoCreate' => true || false,
    ],
    'TrainingData' => [
        'Assets' => [
            [
                'GroundTruthManifest' => [
                    'S3Object' => [
                        'Bucket' => '<string>',
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
    ],
    'VersionDescription' => '<string>',
    'VersionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProjectVersionArn' => '<string>',
]

Result Details

Errors

ResourceInUseException:

The specified resource is already being used.

ResourceNotFoundException:

The resource specified in the request cannot be found.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

Examples

Example 1: To train an Amazon Rekognition Custom Labels model

Trains a version of an Amazon Rekognition Custom Labels model.

$result = $client->createProjectVersion([
    'OutputConfig' => [
        'S3Bucket' => 'output_bucket',
        'S3KeyPrefix' => 'output_folder',
    ],
    'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815',
    'VersionName' => '1',
]);

Result syntax:

[
    'ProjectVersionArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958',
]

CreateStreamProcessor

$result = $client->createStreamProcessor([/* ... */]);
$promise = $client->createStreamProcessorAsync([/* ... */]);

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

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

• If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream for receiving the output. You must use the FaceSearch option in Settings, specifying the collection that contains the faces you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing.

• If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect by using the ConnectedHome option in settings, and selecting one of the following: PERSON, PET, PACKAGE, ALL You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.

Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

Parameter Syntax

$result = $client->createStreamProcessor([
    'DataSharingPreference' => [
        'OptIn' => true || false, // REQUIRED
    ],
    'Input' => [ // REQUIRED
        'KinesisVideoStream' => [
            'Arn' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NotificationChannel' => [
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'Output' => [ // REQUIRED
        'KinesisDataStream' => [
            'Arn' => '<string>',
        ],
        'S3Destination' => [
            'Bucket' => '<string>',
            'KeyPrefix' => '<string>',
        ],
    ],
    'RegionsOfInterest' => [
        [
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Polygon' => [
                [
                    'X' => <float>,
                    'Y' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Settings' => [ // REQUIRED
        'ConnectedHome' => [
            'Labels' => ['<string>', ...], // REQUIRED
            'MinConfidence' => <float>,
        ],
        'FaceSearch' => [
            'CollectionId' => '<string>',
            'FaceMatchThreshold' => <float>,
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'StreamProcessorArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

ResourceInUseException:

The specified resource is already being used.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a new User within a collection specified by CollectionId. Takes UserId as a parameter, which is a user provided ID which should be unique within the collection. The provided UserId will alias the system generated UUID to make the UserId more user friendly.

Uses a ClientToken, an idempotency token that ensures a call to CreateUser completes only once. If the value is not supplied, the AWS SDK generates an idempotency token for the requests. This prevents retries after a network error results from making multiple CreateUser calls.

Parameter Syntax

$result = $client->createUser([
    'ClientRequestToken' => '<string>',
    'CollectionId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ConflictException:

A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **

ResourceNotFoundException:

The resource specified in the request cannot be found.

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Example 1: CreateUser

Creates a new User within a collection specified by CollectionId.

$result = $client->createUser([
    'CollectionId' => 'MyCollection',
    'UserId' => 'DemoUser',
]);

DeleteCollection

$result = $client->deleteCollection([/* ... */]);
$promise = $client->deleteCollectionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteCollection([
    'CollectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'StatusCode' => <integer>,
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

Examples

Example 1: To delete a collection

This operation deletes a Rekognition collection.

$result = $client->deleteCollection([
    'CollectionId' => 'myphotos',
]);

Result syntax:

[
    'StatusCode' => 200,
]

DeleteDataset

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

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

Parameter Syntax

$result = $client->deleteDataset([
    'DatasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

ResourceInUseException:

The specified resource is already being used.

ResourceNotFoundException:

The resource specified in the request cannot be found.

Examples

Example 1: To delete an Amazon Rekognition Custom Labels dataset

Deletes an Amazon Rekognition Custom Labels dataset.

$result = $client->deleteDataset([
    'DatasetArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321',
]);

Result syntax:

[
]

DeleteFaces

$result = $client->deleteFaces([/* ... */]);
$promise = $client->deleteFacesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteFaces([
    'CollectionId' => '<string>', // REQUIRED
    'FaceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DeletedFaces' => ['<string>', ...],
    'UnsuccessfulFaceDeletions' => [
        [
            'FaceId' => '<string>',
            'Reasons' => ['<string>', ...],
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

Examples

Example 1: To delete a face

This operation deletes one or more faces from a Rekognition collection.

$result = $client->deleteFaces([
    'CollectionId' => 'myphotos',
    'FaceIds' => [
        'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
    ],
]);

Result syntax:

[
    'DeletedFaces' => [
        'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
    ],
]

DeleteProject

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Deletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or adapter, see DeleteProjectVersion.

DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with that project.

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

Parameter Syntax

$result = $client->deleteProject([
    'ProjectArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => 'CREATING|CREATED|DELETING',
]

Result Details

Errors

ResourceInUseException:

The specified resource is already being used.

ResourceNotFoundException:

The resource specified in the request cannot be found.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

Examples

Example 1: To delete an Amazon Rekognition Custom Labels project

Deletes an Amazon Rekognition Custom Labels projects.

$result = $client->deleteProject([
    'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285',
]);

Result syntax:

[
    'Status' => 'DELETING',
]

DeleteProjectPolicy

$result = $client->deleteProjectPolicy([/* ... */]);
$promise = $client->deleteProjectPolicyAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing project policy.

To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.

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

Parameter Syntax

$result = $client->deleteProjectPolicy([
    'PolicyName' => '<string>', // REQUIRED
    'PolicyRevisionId' => '<string>',
    'ProjectArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidPolicyRevisionIdException:

The supplied revision id for the project policy is invalid.

Examples

Example 1: DeleteProjectPolicy

This operation deletes a revision of an existing project policy from an Amazon Rekognition Custom Labels project.

$result = $client->deleteProjectPolicy([
    'PolicyName' => 'testPolicy1',
    'PolicyRevisionId' => '3b274c25e9203a56a99e00e3ff205fbc',
    'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/1656557123456',
]);

Result syntax:

[
]

DeleteProjectVersion

$result = $client->deleteProjectVersion([/* ... */]);
$promise = $client->deleteProjectVersionAsync([/* ... */]);

Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.

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

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

Parameter Syntax

$result = $client->deleteProjectVersion([
    'ProjectVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => 'TRAINING_IN_PROGRESS|TRAINING_COMPLETED|TRAINING_FAILED|STARTING|RUNNING|FAILED|STOPPING|STOPPED|DELETING|COPYING_IN_PROGRESS|COPYING_COMPLETED|COPYING_FAILED|DEPRECATED|EXPIRED',
]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request cannot be found.

ResourceInUseException:

The specified resource is already being used.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

Examples

Example 1: To delete an Amazon Rekognition Custom Labels model

Deletes a version of an Amazon Rekognition Custom Labels model.

$result = $client->deleteProjectVersion([
    'ProjectVersionArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958',
]);

Result syntax:

[
    'Status' => 'DELETING',
]

DeleteStreamProcessor

$result = $client->deleteStreamProcessor([/* ... */]);
$promise = $client->deleteStreamProcessorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteStreamProcessor([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ResourceInUseException:

The specified resource is already being used.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes the specified UserID within the collection. Faces that are associated with the UserID are disassociated from the UserID before deleting the specified UserID. If the specified Collection or UserID is already deleted or not found, a ResourceNotFoundException will be thrown. If the action is successful with a 200 response, an empty HTTP body is returned.

Parameter Syntax

$result = $client->deleteUser([
    'ClientRequestToken' => '<string>',
    'CollectionId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ConflictException:

A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **

ResourceNotFoundException:

The resource specified in the request cannot be found.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Example 1: DeleteUser

Deletes the specified UserID within the collection.

$result = $client->deleteUser([
    'ClientRequestToken' => '550e8400-e29b-41d4-a716-446655440001',
    'CollectionId' => 'MyCollection',
    'UserId' => 'DemoUser',
]);

DescribeCollection

$result = $client->describeCollection([/* ... */]);
$promise = $client->describeCollectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeCollection([
    'CollectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CollectionARN' => '<string>',
    'CreationTimestamp' => <DateTime>,
    'FaceCount' => <integer>,
    'FaceModelVersion' => '<string>',
    'UserCount' => <integer>,
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

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

Parameter Syntax

$result = $client->describeDataset([
    'DatasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DatasetDescription' => [
        'CreationTimestamp' => <DateTime>,
        'DatasetStats' => [
            'ErrorEntries' => <integer>,
            'LabeledEntries' => <integer>,
            'TotalEntries' => <integer>,
            'TotalLabels' => <integer>,
        ],
        'LastUpdatedTimestamp' => <DateTime>,
        'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED|DELETE_IN_PROGRESS',
        'StatusMessage' => '<string>',
        'StatusMessageCode' => 'SUCCESS|SERVICE_ERROR|CLIENT_ERROR',
    ],
]

Result Details

Errors

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

ResourceNotFoundException:

The resource specified in the request cannot be found.

Examples

Example 1: To describe an Amazon Rekognition Custom Labels dataset

Describes an Amazon Rekognition Custom Labels dataset.

$result = $client->describeDataset([
    'DatasetArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535',
]);

Result syntax:

[
    'DatasetDescription' => [
        'CreationTimestamp' => ,
        'DatasetStats' => [
            'ErrorEntries' => 0,
            'LabeledEntries' => 15,
            'TotalEntries' => 15,
            'TotalLabels' => 9,
        ],
        'LastUpdatedTimestamp' => ,
        'Status' => 'UPDATE_FAILED',
        'StatusMessage' => 'The manifest file contains images from multiple S3 buckets.',
        'StatusMessageCode' => 'CLIENT_ERROR',
    ],
]

DescribeProjectVersions

$result = $client->describeProjectVersions([/* ... */]);
$promise = $client->describeProjectVersionsAsync([/* ... */]);

Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or adapter versions in ProjectVersionArns. If you don't specify a value, descriptions for all model/adapter versions in the project are returned.

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

Parameter Syntax

$result = $client->describeProjectVersions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProjectArn' => '<string>', // REQUIRED
    'VersionNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProjectVersionDescriptions' => [
        [
            'BaseModelVersion' => '<string>',
            'BillableTrainingTimeInSeconds' => <integer>,
            'CreationTimestamp' => <DateTime>,
            'EvaluationResult' => [
                'F1Score' => <float>,
                'Summary' => [
                    'S3Object' => [
                        'Bucket' => '<string>',
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                ],
            ],
            'Feature' => 'CONTENT_MODERATION|CUSTOM_LABELS',
            'FeatureConfig' => [
                'ContentModeration' => [
                    'ConfidenceThreshold' => <float>,
                ],
            ],
            'KmsKeyId' => '<string>',
            'ManifestSummary' => [
                'S3Object' => [
                    'Bucket' => '<string>',
                    'Name' => '<string>',
                    'Version' => '<string>',
                ],
            ],
            'MaxInferenceUnits' => <integer>,
            'MinInferenceUnits' => <integer>,
            'OutputConfig' => [
                'S3Bucket' => '<string>',
                'S3KeyPrefix' => '<string>',
            ],
            'ProjectVersionArn' => '<string>',
            'SourceProjectVersionArn' => '<string>',
            'Status' => 'TRAINING_IN_PROGRESS|TRAINING_COMPLETED|TRAINING_FAILED|STARTING|RUNNING|FAILED|STOPPING|STOPPED|DELETING|COPYING_IN_PROGRESS|COPYING_COMPLETED|COPYING_FAILED|DEPRECATED|EXPIRED',
            'StatusMessage' => '<string>',
            'TestingDataResult' => [
                'Input' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'AutoCreate' => true || false,
                ],
                'Output' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'AutoCreate' => true || false,
                ],
                'Validation' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'TrainingDataResult' => [
                'Input' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
                'Output' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
                'Validation' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'TrainingEndTimestamp' => <DateTime>,
            'VersionDescription' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request cannot be found.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

Examples

Example 1: To describe an Amazon Rekognition Custom Labels model

Describes a version of an Amazon Rekognition Custom Labels model.

$result = $client->describeProjectVersions([
    'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815',
    'VersionNames' => [
        '1',
    ],
]);

Result syntax:

[
    'NextToken' => '',
    'ProjectVersionDescriptions' => [
        [
            'BillableTrainingTimeInSeconds' => 1899,
            'CreationTimestamp' => ,
            'EvaluationResult' => [
                'F1Score' => 1,
                'Summary' => [
                    'S3Object' => [
                        'Bucket' => 'custom-labels-console-us-east-1-111111111',
                        'Name' => 'my-model-output/EvaluationResultSummary-my-project-1.json',
                    ],
                ],
            ],
            'ManifestSummary' => [
                'S3Object' => [
                    'Bucket' => 'custom-labels-console-us-east-1-111111111',
                    'Name' => 'my-model-output/ManifestSummary-my-project-1.json',
                ],
            ],
            'OutputConfig' => [
                'S3Bucket' => 'custom-labels-console-us-east-1-111111111',
                'S3KeyPrefix' => 'my-model-output',
            ],
            'ProjectVersionArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958',
            'Status' => 'TRAINING_COMPLETED',
            'StatusMessage' => 'The model is ready to run.',
            'TestingDataResult' => [
                'Input' => [
                    'AutoCreate' => ,
                ],
                'Output' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => 'custom-labels-console-us-east-1-111111111',
                                    'Name' => 'my-model-output/TestingGroundTruth-my-project-1.json',
                                ],
                            ],
                        ],
                    ],
                    'AutoCreate' => ,
                ],
                'Validation' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => 'custom-labels-console-us-east-1-111111111',
                                    'Name' => 'my-model-output/TestingManifestWithValidation-my-project-1.json',
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'TrainingDataResult' => [
                'Input' => [
                ],
                'Output' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => 'custom-labels-console-us-east-1-111111111',
                                    'Name' => 'my-model-output/TrainingGroundTruth-my-project-1.json',
                                ],
                            ],
                        ],
                    ],
                ],
                'Validation' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => 'custom-labels-console-us-east-1-111111111',
                                    'Name' => 'my-model-output/TrainingManifestWithValidation-my-project-1.json',
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'TrainingEndTimestamp' => ,
        ],
    ],
]

DescribeProjects

$result = $client->describeProjects([/* ... */]);
$promise = $client->describeProjectsAsync([/* ... */]);

Gets information about your Rekognition projects.

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

Parameter Syntax

$result = $client->describeProjects([
    'Features' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProjectNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProjectDescriptions' => [
        [
            'AutoUpdate' => 'ENABLED|DISABLED',
            'CreationTimestamp' => <DateTime>,
            'Datasets' => [
                [
                    'CreationTimestamp' => <DateTime>,
                    'DatasetArn' => '<string>',
                    'DatasetType' => 'TRAIN|TEST',
                    'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED|DELETE_IN_PROGRESS',
                    'StatusMessage' => '<string>',
                    'StatusMessageCode' => 'SUCCESS|SERVICE_ERROR|CLIENT_ERROR',
                ],
                // ...
            ],
            'Feature' => 'CONTENT_MODERATION|CUSTOM_LABELS',
            'ProjectArn' => '<string>',
            'Status' => 'CREATING|CREATED|DELETING',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidPaginationTokenException:

Pagination token in the request is not valid.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

Examples

Example 1: To describe an Amazon Rekognition Custom Labels project.

Describes an Amazon Rekognition Custom Labels projects.

$result = $client->describeProjects([
    'ProjectNames' => [
        'my-project',
    ],
]);

Result syntax:

[
    'ProjectDescriptions' => [
        [
            'CreationTimestamp' => ,
            'Datasets' => [
                [
                    'CreationTimestamp' => ,
                    'DatasetArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1655158654491',
                    'DatasetType' => 'TEST',
                    'Status' => 'CREATE_COMPLETE',
                    'StatusMessage' => 'The dataset was successfully created from the manifest file.',
                    'StatusMessageCode' => 'SUCCESS',
                ],
                [
                    'CreationTimestamp' => ,
                    'DatasetArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1655158669954',
                    'DatasetType' => 'TRAIN',
                    'Status' => 'CREATE_COMPLETE',
                    'StatusMessage' => 'The dataset was successfully created from the manifest file.',
                    'StatusMessageCode' => 'SUCCESS',
                ],
            ],
            'ProjectArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/1655158560634',
            'Status' => 'CREATED',
        ],
    ],
]

DescribeStreamProcessor

$result = $client->describeStreamProcessor([/* ... */]);
$promise = $client->describeStreamProcessorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStreamProcessor([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTimestamp' => <DateTime>,
    'DataSharingPreference' => [
        'OptIn' => true || false,
    ],
    'Input' => [
        'KinesisVideoStream' => [
            'Arn' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'LastUpdateTimestamp' => <DateTime>,
    'Name' => '<string>',
    'NotificationChannel' => [
        'SNSTopicArn' => '<string>',
    ],
    'Output' => [
        'KinesisDataStream' => [
            'Arn' => '<string>',
        ],
        'S3Destination' => [
            'Bucket' => '<string>',
            'KeyPrefix' => '<string>',
        ],
    ],
    'RegionsOfInterest' => [
        [
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Polygon' => [
                [
                    'X' => <float>,
                    'Y' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'RoleArn' => '<string>',
    'Settings' => [
        'ConnectedHome' => [
            'Labels' => ['<string>', ...],
            'MinConfidence' => <float>,
        ],
        'FaceSearch' => [
            'CollectionId' => '<string>',
            'FaceMatchThreshold' => <float>,
        ],
    ],
    'Status' => 'STOPPED|STARTING|RUNNING|FAILED|STOPPING|UPDATING',
    'StatusMessage' => '<string>',
    'StreamProcessorArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

DetectCustomLabels

$result = $client->detectCustomLabels([/* ... */]);
$promise = $client->detectCustomLabelsAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

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

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

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

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

To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

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

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

For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

Parameter Syntax

$result = $client->detectCustomLabels([
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'MaxResults' => <integer>,
    'MinConfidence' => <float>,
    'ProjectVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CustomLabels' => [
        [
            'Confidence' => <float>,
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request cannot be found.

ResourceNotReadyException:

The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

LimitExceededException:

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

Examples

Example 1: To detect custom labels in an image with an Amazon Rekognition Custom Labels model

Detects custom labels in an image with an Amazon Rekognition Custom Labels model

$result = $client->detectCustomLabels([
    'Image' => [
        'S3Object' => [
            'Bucket' => 'custom-labels-console-us-east-1-1111111111',
            'Name' => 'assets/flowers_1_test_dataset/camellia4.jpg',
        ],
    ],
    'MaxResults' => 100,
    'MinConfidence' => 50,
    'ProjectVersionArn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/my-project.2023-07-31T11.49.37/1690829378219',
]);

Result syntax:

[
    'CustomLabels' => [
        [
            'Confidence' => 67.563995361328,
            'Name' => 'with_leaves',
        ],
        [
            'Confidence' => 50.656997680664,
            'Name' => 'without_leaves',
        ],
    ],
]

DetectFaces

$result = $client->detectFaces([/* ... */]);
$promise = $client->detectFacesAsync([/* ... */]);

Detects faces within an image that is provided as input.

DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), pose, presence of facial occlusion, and so on.

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

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

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

Parameter Syntax

$result = $client->detectFaces([
    'Attributes' => ['<string>', ...],
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'FaceDetails' => [
        [
            'AgeRange' => [
                'High' => <integer>,
                'Low' => <integer>,
            ],
            'Beard' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Confidence' => <float>,
            'Emotions' => [
                [
                    'Confidence' => <float>,
                    'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                ],
                // ...
            ],
            'EyeDirection' => [
                'Confidence' => <float>,
                'Pitch' => <float>,
                'Yaw' => <float>,
            ],
            'Eyeglasses' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'EyesOpen' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'FaceOccluded' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'Gender' => [
                'Confidence' => <float>,
                'Value' => 'Male|Female',
            ],
            'Landmarks' => [
                [
                    'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                    'X' => <float>,
                    'Y' => <float>,
                ],
                // ...
            ],
            'MouthOpen' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'Mustache' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'Pose' => [
                'Pitch' => <float>,
                'Roll' => <float>,
                'Yaw' => <float>,
            ],
            'Quality' => [
                'Brightness' => <float>,
                'Sharpness' => <float>,
            ],
            'Smile' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'Sunglasses' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
        ],
        // ...
    ],
    'OrientationCorrection' => 'ROTATE_0|ROTATE_90|ROTATE_180|ROTATE_270',
]

Result Details

Errors

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

Examples

Example 1: To detect faces in an image

This operation detects faces in an image stored in an AWS S3 bucket.

$result = $client->detectFaces([
    'Image' => [
        'S3Object' => [
            'Bucket' => 'mybucket',
            'Name' => 'myphoto',
        ],
    ],
]);

Result syntax:

[
    'FaceDetails' => [
        [
            'BoundingBox' => [
                'Height' => 0.18000000715256,
                'Left' => 0.55555558204651,
                'Top' => 0.33666667342186,
                'Width' => 0.23999999463558,
            ],
            'Confidence' => 100,
            'Landmarks' => [
                [
                    'Type' => 'eyeLeft',
                    'X' => 0.63947373628616,
                    'Y' => 0.40819624066353,
                ],
                [
                    'Type' => 'eyeRight',
                    'X' => 0.72666609287262,
                    'Y' => 0.41039225459099,
                ],
                [
                    'Type' => 'eyeRight',
                    'X' => 0.69124621152878,
                    'Y' => 0.44240960478783,
                ],
                [
                    'Type' => 'mouthDown',
                    'X' => 0.63061982393265,
                    'Y' => 0.46700039505959,
                ],
                [
                    'Type' => 'mouthUp',
                    'X' => 0.72156089544296,
                    'Y' => 0.47114261984825,
                ],
            ],
            'Pose' => [
                'Pitch' => 4.0508065223694,
                'Roll' => 0.99507474899292,
                'Yaw' => 13.693790435791,
            ],
            'Quality' => [
                'Brightness' => 37.601699829102,
                'Sharpness' => 80,
            ],
        ],
    ],
    'OrientationCorrection' => 'ROTATE_0',
]

DetectLabels

$result = $client->detectLabels([/* ... */]);
$promise = $client->detectLabelsAsync([/* ... */]);

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

For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.

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

Optional Parameters

You can specify one or both of the GENERAL_LABELS and IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including GENERAL_LABELS will ensure the response includes the labels detected in the input image, while including IMAGE_PROPERTIES will ensure the response includes information about the image quality and color.

When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can provide filtering criteria to the Settings parameter. You can filter with sets of individual labels or with label categories. You can specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive filters. For more information on filtering see Detecting Labels in an Image.

When getting labels, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. The default and upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a feature type.

Response Elements

For each object, scene, and concept the API returns one or more labels. The API returns the following types of information about labels:

• Name - The name of the detected label.

• Confidence - The level of confidence in the label assigned to a detected object.

• Parents - The ancestor labels for a detected label. DetectLabels returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

• Aliases - Possible Aliases for the label.

• Categories - The label categories that the detected label belongs to.

• BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

The API returns the following information regarding the image, as part of the ImageProperties structure:

• Quality - Information about the Sharpness, Brightness, and Contrast of the input image, scored between 0 to 100. Image quality is returned for the entire image, as well as the background and the foreground.

• Dominant Color - An array of the dominant colors in the image.

• Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.

• Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

The list of returned labels will include at least one label for every detected object, along with information about that label. In the following example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object, as well as the confidence in the label:

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

The list of labels can include multiple labels for the same object. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

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

This is a stateless API operation that doesn't return any data.

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

Parameter Syntax

$result = $client->detectLabels([
    'Features' => ['<string>', ...],
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'MaxLabels' => <integer>,
    'MinConfidence' => <float>,
    'Settings' => [
        'GeneralLabels' => [
            'LabelCategoryExclusionFilters' => ['<string>', ...],
            'LabelCategoryInclusionFilters' => ['<string>', ...],
            'LabelExclusionFilters' => ['<string>', ...],
            'LabelInclusionFilters' => ['<string>', ...],
        ],
        'ImageProperties' => [
            'MaxDominantColors' => <integer>,
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ImageProperties' => [
        'Background' => [
            'DominantColors' => [
                [
                    'Blue' => <integer>,
                    'CSSColor' => '<string>',
                    'Green' => <integer>,
                    'HexCode' => '<string>',
                    'PixelPercent' => <float>,
                    'Red' => <integer>,
                    'SimplifiedColor' => '<string>',
                ],
                // ...
            ],
            'Quality' => [
                'Brightness' => <float>,
                'Contrast' => <float>,
                'Sharpness' => <float>,
            ],
        ],
        'DominantColors' => [
            [
                'Blue' => <integer>,
                'CSSColor' => '<string>',
                'Green' => <integer>,
                'HexCode' => '<string>',
                'PixelPercent' => <float>,
                'Red' => <integer>,
                'SimplifiedColor' => '<string>',
            ],
            // ...
        ],
        'Foreground' => [
            'DominantColors' => [
                [
                    'Blue' => <integer>,
                    'CSSColor' => '<string>',
                    'Green' => <integer>,
                    'HexCode' => '<string>',
                    'PixelPercent' => <float>,
                    'Red' => <integer>,
                    'SimplifiedColor' => '<string>',
                ],
                // ...
            ],
            'Quality' => [
                'Brightness' => <float>,
                'Contrast' => <float>,
                'Sharpness' => <float>,
            ],
        ],
        'Quality' => [
            'Brightness' => <float>,
            'Contrast' => <float>,
            'Sharpness' => <float>,
        ],
    ],
    'LabelModelVersion' => '<string>',
    'Labels' => [
        [
            'Aliases' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'Categories' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'Confidence' => <float>,
            'Instances' => [
                [
                    'BoundingBox' => [
                        'Height' => <float>,
                        'Left' => <float>,
                        'Top' => <float>,
                        'Width' => <float>,
                    ],
                    'Confidence' => <float>,
                    'DominantColors' => [
                        [
                            'Blue' => <integer>,
                            'CSSColor' => '<string>',
                            'Green' => <integer>,
                            'HexCode' => '<string>',
                            'PixelPercent' => <float>,
                            'Red' => <integer>,
                            'SimplifiedColor' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Name' => '<string>',
            'Parents' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'OrientationCorrection' => 'ROTATE_0|ROTATE_90|ROTATE_180|ROTATE_270',
]

Result Details

Errors

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

Examples

Example 1: To detect labels

This operation detects labels in the supplied image

$result = $client->detectLabels([
    'Image' => [
        'S3Object' => [
            'Bucket' => 'mybucket',
            'Name' => 'myphoto',
        ],
    ],
    'MaxLabels' => 123,
    'MinConfidence' => 70,
]);

Result syntax:

[
    'Labels' => [
        [
            'Confidence' => 99.25072479248,
            'Name' => 'People',
        ],
        [
            'Confidence' => 99.25074005127,
            'Name' => 'Person',
        ],
    ],
]

DetectModerationLabels

$result = $client->detectModerationLabels([/* ... */]);
$promise = $client->detectModerationLabelsAsync([/* ... */]);

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.

You can specify an adapter to use when retrieving label predictions by providing a ProjectVersionArn to the ProjectVersion argument.

Parameter Syntax

$result = $client->detectModerationLabels([
    'HumanLoopConfig' => [
        'DataAttributes' => [
            'ContentClassifiers' => ['<string>', ...],
        ],
        'FlowDefinitionArn' => '<string>', // REQUIRED
        'HumanLoopName' => '<string>', // REQUIRED
    ],
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'MinConfidence' => <float>,
    'ProjectVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContentTypes' => [
        [
            'Confidence' => <float>,
            'Name' => '<string>',
        ],
        // ...
    ],
    'HumanLoopActivationOutput' => [
        'HumanLoopActivationConditionsEvaluationResults' => '<string>',
        'HumanLoopActivationReasons' => ['<string>', ...],
        'HumanLoopArn' => '<string>',
    ],
    'ModerationLabels' => [
        [
            'Confidence' => <float>,
            'Name' => '<string>',
            'ParentName' => '<string>',
            'TaxonomyLevel' => <integer>,
        ],
        // ...
    ],
    'ModerationModelVersion' => '<string>',
    'ProjectVersion' => '<string>',
]

Result Details

Errors

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

HumanLoopQuotaExceededException:

The number of in-progress human reviews you have has exceeded the number allowed.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ResourceNotReadyException:

The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

DetectProtectiveEquipment

$result = $client->detectProtectiveEquipment([/* ... */]);
$promise = $client->detectProtectiveEquipmentAsync([/* ... */]);

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.

• Face cover

• Hand cover

• Head cover

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.

DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.

• The persons detected as wearing all of the types of PPE that you specify.

• The persons detected as not wearing all of the types PPE that you specify.

• The persons detected where PPE adornment could not be determined.

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

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

Parameter Syntax

$result = $client->detectProtectiveEquipment([
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'SummarizationAttributes' => [
        'MinConfidence' => <float>, // REQUIRED
        'RequiredEquipmentTypes' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Persons' => [
        [
            'BodyParts' => [
                [
                    'Confidence' => <float>,
                    'EquipmentDetections' => [
                        [
                            'BoundingBox' => [
                                'Height' => <float>,
                                'Left' => <float>,
                                'Top' => <float>,
                                'Width' => <float>,
                            ],
                            'Confidence' => <float>,
                            'CoversBodyPart' => [
                                'Confidence' => <float>,
                                'Value' => true || false,
                            ],
                            'Type' => 'FACE_COVER|HAND_COVER|HEAD_COVER',
                        ],
                        // ...
                    ],
                    'Name' => 'FACE|HEAD|LEFT_HAND|RIGHT_HAND',
                ],
                // ...
            ],
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Confidence' => <float>,
            'Id' => <integer>,
        ],
        // ...
    ],
    'ProtectiveEquipmentModelVersion' => '<string>',
    'Summary' => [
        'PersonsIndeterminate' => [<integer>, ...],
        'PersonsWithRequiredEquipment' => [<integer>, ...],
        'PersonsWithoutRequiredEquipment' => [<integer>, ...],
    ],
]

Result Details

Errors

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

DetectText

$result = $client->detectText([/* ... */]);
$promise = $client->detectTextAsync([/* ... */]);

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

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

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

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

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

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

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

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

Parameter Syntax

$result = $client->detectText([
    'Filters' => [
        'RegionsOfInterest' => [
            [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'WordFilter' => [
            'MinBoundingBoxHeight' => <float>,
            'MinBoundingBoxWidth' => <float>,
            'MinConfidence' => <float>,
        ],
    ],
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'TextDetections' => [
        [
            'Confidence' => <float>,
            'DetectedText' => '<string>',
            'Geometry' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Polygon' => [
                    [
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
            ],
            'Id' => <integer>,
            'ParentId' => <integer>,
            'Type' => 'LINE|WORD',
        ],
        // ...
    ],
    'TextModelVersion' => '<string>',
]

Result Details

Errors

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

InvalidImageFormatException:

The provided image format is not supported.

DisassociateFaces

$result = $client->disassociateFaces([/* ... */]);
$promise = $client->disassociateFacesAsync([/* ... */]);

Removes the association between a Face supplied in an array of FaceIds and the User. If the User is not present already, then a ResourceNotFound exception is thrown. If successful, an array of faces that are disassociated from the User is returned. If a given face is already disassociated from the given UserID, it will be ignored and not be returned in the response. If a given face is already associated with a different User or not found in the collection it will be returned as part of UnsuccessfulDisassociations. You can remove 1 - 100 face IDs from a user at one time.

Parameter Syntax

$result = $client->disassociateFaces([
    'ClientRequestToken' => '<string>',
    'CollectionId' => '<string>', // REQUIRED
    'FaceIds' => ['<string>', ...], // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DisassociatedFaces' => [
        [
            'FaceId' => '<string>',
        ],
        // ...
    ],
    'UnsuccessfulFaceDisassociations' => [
        [
            'FaceId' => '<string>',
            'Reasons' => ['<string>', ...],
            'UserId' => '<string>',
        ],
        // ...
    ],
    'UserStatus' => 'ACTIVE|UPDATING|CREATING|CREATED',
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

IdempotentParameterMismatchException:

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ConflictException:

A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **

Examples

Example 1: DisassociateFaces

Removes the association between a Face supplied in an array of FaceIds and the User.

$result = $client->disassociateFaces([
    'ClientRequestToken' => '550e8400-e29b-41d4-a716-446655440003',
    'CollectionId' => 'MyCollection',
    'FaceIds' => [
        'f5817d37-94f6-4335-bfee-6cf79a3d806e',
        'c92265d4-5f9c-43af-a58e-12be0ce02bc3',
    ],
    'UserId' => 'DemoUser',
]);

Result syntax:

[
    'DisassociatedFaces' => [
        [
            'FaceId' => 'c92265d4-5f9c-43af-a58e-12be0ce02bc3',
        ],
    ],
    'UnsuccessfulFaceDisassociations' => [
        [
            'FaceId' => 'f5817d37-94f6-4335-bfee-6cf79a3d806e',
            'Reasons' => [
                'ASSOCIATED_TO_A_DIFFERENT_USER',
            ],
            'UserId' => 'demoUser1',
        ],
    ],
    'UserStatus' => 'UPDATING',
]

DistributeDatasetEntries

$result = $client->distributeDatasetEntries([/* ... */]);
$promise = $client->distributeDatasetEntriesAsync([/* ... */]);

This operation applies only to Amazon Rekognition Custom Labels.

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image.

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.

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

Parameter Syntax

$result = $client->distributeDatasetEntries([
    'Datasets' => [ // REQUIRED
        [
            'Arn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request cannot be found.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotReadyException:

The requested resource isn't ready. For example, this exception occurs when you call DetectCustomLabels with a model version that isn't deployed.

Examples

Example 1: To distribute an Amazon Rekognition Custom Labels dataset

Distributes an Amazon Rekognition Custom Labels training dataset to a test dataset.

$result = $client->distributeDatasetEntries([
    'Datasets' => [
        [
            'Arn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106',
        ],
        [
            'Arn' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/test/1690564858106',
        ],
    ],
]);

Result syntax:

[
]

GetCelebrityInfo

$result = $client->getCelebrityInfo([/* ... */]);
$promise = $client->getCelebrityInfoAsync([/* ... */]);

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Getting information about a celebrity in the Amazon Rekognition Developer Guide.

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

Parameter Syntax

$result = $client->getCelebrityInfo([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'KnownGender' => [
        'Type' => 'Male|Female|Nonbinary|Unlisted',
    ],
    'Name' => '<string>',
    'Urls' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

GetCelebrityRecognition

$result = $client->getCelebrityRecognition([/* ... */]);
$promise = $client->getCelebrityRecognitionAsync([/* ... */]);

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

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

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

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

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

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.

Parameter Syntax

$result = $client->getCelebrityRecognition([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'ID|TIMESTAMP',
]);

Parameter Details

Result Syntax

[
    'Celebrities' => [
        [
            'Celebrity' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'Face' => [
                    'AgeRange' => [
                        'High' => <integer>,
                        'Low' => <integer>,
                    ],
                    'Beard' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'BoundingBox' => [
                        'Height' => <float>,
                        'Left' => <float>,
                        'Top' => <float>,
                        'Width' => <float>,
                    ],
                    'Confidence' => <float>,
                    'Emotions' => [
                        [
                            'Confidence' => <float>,
                            'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                        ],
                        // ...
                    ],
                    'EyeDirection' => [
                        'Confidence' => <float>,
                        'Pitch' => <float>,
                        'Yaw' => <float>,
                    ],
                    'Eyeglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'EyesOpen' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'FaceOccluded' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Gender' => [
                        'Confidence' => <float>,
                        'Value' => 'Male|Female',
                    ],
                    'Landmarks' => [
                        [
                            'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                            'X' => <float>,
                            'Y' => <float>,
                        ],
                        // ...
                    ],
                    'MouthOpen' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Mustache' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Pose' => [
                        'Pitch' => <float>,
                        'Roll' => <float>,
                        'Yaw' => <float>,
                    ],
                    'Quality' => [
                        'Brightness' => <float>,
                        'Sharpness' => <float>,
                    ],
                    'Smile' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Sunglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                ],
                'Id' => '<string>',
                'KnownGender' => [
                    'Type' => 'Male|Female|Nonbinary|Unlisted',
                ],
                'Name' => '<string>',
                'Urls' => ['<string>', ...],
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetContentModeration

$result = $client->getContentModeration([/* ... */]);
$promise = $client->getContentModerationAsync([/* ... */]);

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

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

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.

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

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

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

Parameter Syntax

$result = $client->getContentModeration([
    'AggregateBy' => 'TIMESTAMPS|SEGMENTS',
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'NAME|TIMESTAMP',
]);

Parameter Details

Result Syntax

[
    'GetRequestMetadata' => [
        'AggregateBy' => 'TIMESTAMPS|SEGMENTS',
        'SortBy' => 'NAME|TIMESTAMP',
    ],
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'ModerationLabels' => [
        [
            'ContentTypes' => [
                [
                    'Confidence' => <float>,
                    'Name' => '<string>',
                ],
                // ...
            ],
            'DurationMillis' => <integer>,
            'EndTimestampMillis' => <integer>,
            'ModerationLabel' => [
                'Confidence' => <float>,
                'Name' => '<string>',
                'ParentName' => '<string>',
                'TaxonomyLevel' => <integer>,
            ],
            'StartTimestampMillis' => <integer>,
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'ModerationModelVersion' => '<string>',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetFaceDetection

$result = $client->getFaceDetection([/* ... */]);
$promise = $client->getFaceDetectionAsync([/* ... */]);

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.

Note that for the GetFaceDetection operation, the returned values for FaceOccluded and EyeDirection will always be "null".

Parameter Syntax

$result = $client->getFaceDetection([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Faces' => [
        [
            'Face' => [
                'AgeRange' => [
                    'High' => <integer>,
                    'Low' => <integer>,
                ],
                'Beard' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'Emotions' => [
                    [
                        'Confidence' => <float>,
                        'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                    ],
                    // ...
                ],
                'EyeDirection' => [
                    'Confidence' => <float>,
                    'Pitch' => <float>,
                    'Yaw' => <float>,
                ],
                'Eyeglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'EyesOpen' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'FaceOccluded' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Gender' => [
                    'Confidence' => <float>,
                    'Value' => 'Male|Female',
                ],
                'Landmarks' => [
                    [
                        'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
                'MouthOpen' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Mustache' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Pose' => [
                    'Pitch' => <float>,
                    'Roll' => <float>,
                    'Yaw' => <float>,
                ],
                'Quality' => [
                    'Brightness' => <float>,
                    'Sharpness' => <float>,
                ],
                'Smile' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Sunglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetFaceLivenessSessionResults

$result = $client->getFaceLivenessSessionResults([/* ... */]);
$promise = $client->getFaceLivenessSessionResultsAsync([/* ... */]);

Retrieves the results of a specific Face Liveness session. It requires the sessionId as input, which was created using CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence score, a reference image that includes a face bounding box, and audit images that also contain face bounding boxes. The Face Liveness confidence score ranges from 0 to 100.

The number of audit images returned by GetFaceLivenessSessionResults is defined by the AuditImagesLimit paramater when calling CreateFaceLivenessSession. Reference images are always returned when possible.

Parameter Syntax

$result = $client->getFaceLivenessSessionResults([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuditImages' => [
        [
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
            'S3Object' => [
                'Bucket' => '<string>',
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        // ...
    ],
    'Challenge' => [
        'Type' => 'FaceMovementAndLightChallenge|FaceMovementChallenge',
        'Version' => '<string>',
    ],
    'Confidence' => <float>,
    'ReferenceImage' => [
        'BoundingBox' => [
            'Height' => <float>,
            'Left' => <float>,
            'Top' => <float>,
            'Width' => <float>,
        ],
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'SessionId' => '<string>',
    'Status' => 'CREATED|IN_PROGRESS|SUCCEEDED|FAILED|EXPIRED',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

SessionNotFoundException:

Occurs when a given sessionId is not found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

GetFaceSearch

$result = $client->getFaceSearch([/* ... */]);
$promise = $client->getFaceSearchAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->getFaceSearch([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'INDEX|TIMESTAMP',
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'NextToken' => '<string>',
    'Persons' => [
        [
            'FaceMatches' => [
                [
                    'Face' => [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Confidence' => <float>,
                        'ExternalImageId' => '<string>',
                        'FaceId' => '<string>',
                        'ImageId' => '<string>',
                        'IndexFacesModelVersion' => '<string>',
                        'UserId' => '<string>',
                    ],
                    'Similarity' => <float>,
                ],
                // ...
            ],
            'Person' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Face' => [
                    'AgeRange' => [
                        'High' => <integer>,
                        'Low' => <integer>,
                    ],
                    'Beard' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'BoundingBox' => [
                        'Height' => <float>,
                        'Left' => <float>,
                        'Top' => <float>,
                        'Width' => <float>,
                    ],
                    'Confidence' => <float>,
                    'Emotions' => [
                        [
                            'Confidence' => <float>,
                            'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                        ],
                        // ...
                    ],
                    'EyeDirection' => [
                        'Confidence' => <float>,
                        'Pitch' => <float>,
                        'Yaw' => <float>,
                    ],
                    'Eyeglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'EyesOpen' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'FaceOccluded' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Gender' => [
                        'Confidence' => <float>,
                        'Value' => 'Male|Female',
                    ],
                    'Landmarks' => [
                        [
                            'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                            'X' => <float>,
                            'Y' => <float>,
                        ],
                        // ...
                    ],
                    'MouthOpen' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Mustache' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Pose' => [
                        'Pitch' => <float>,
                        'Roll' => <float>,
                        'Yaw' => <float>,
                    ],
                    'Quality' => [
                        'Brightness' => <float>,
                        'Sharpness' => <float>,
                    ],
                    'Smile' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Sunglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                ],
                'Index' => <integer>,
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetLabelDetection

$result = $client->getLabelDetection([/* ... */]);
$promise = $client->getLabelDetectionAsync([/* ... */]);

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

The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection.

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

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. If there is no NAME specified, the default sort is by timestamp.

You can select how results are aggregated by using the AggregateBy input parameter. The default aggregation method is TIMESTAMPS. You can also aggregate by SEGMENTS, which aggregates all instances of labels detected in a given segment.

The returned Labels array may include the following attributes:

• Name - The name of the detected label.

• Confidence - The level of confidence in the label assigned to a detected object.

• Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

• Aliases - Possible Aliases for the label.

• Categories - The label categories that the detected label belongs to.

• BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

• Timestamp - Time, in milliseconds from the start of the video, that the label was detected. For aggregation by SEGMENTS, the StartTimestampMillis, EndTimestampMillis, and DurationMillis structures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same as StartTimestampMillis.

Timestamp and Bounding box information are returned for detected Instances, only if aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS, information about detected instances isn’t returned.

The version of the label model used for the detection is also returned.

Note DominantColors isn't returned for Instances, although it is shown as part of the response in the sample seen below.

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

If you are retrieving results while using the Amazon Simple Notification Service, note that you will receive an "ERROR" notification if the job encounters an issue.

Parameter Syntax

$result = $client->getLabelDetection([
    'AggregateBy' => 'TIMESTAMPS|SEGMENTS',
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'NAME|TIMESTAMP',
]);

Parameter Details

Result Syntax

[
    'GetRequestMetadata' => [
        'AggregateBy' => 'TIMESTAMPS|SEGMENTS',
        'SortBy' => 'NAME|TIMESTAMP',
    ],
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'LabelModelVersion' => '<string>',
    'Labels' => [
        [
            'DurationMillis' => <integer>,
            'EndTimestampMillis' => <integer>,
            'Label' => [
                'Aliases' => [
                    [
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'Categories' => [
                    [
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'Confidence' => <float>,
                'Instances' => [
                    [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Confidence' => <float>,
                        'DominantColors' => [
                            [
                                'Blue' => <integer>,
                                'CSSColor' => '<string>',
                                'Green' => <integer>,
                                'HexCode' => '<string>',
                                'PixelPercent' => <float>,
                                'Red' => <integer>,
                                'SimplifiedColor' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'Parents' => [
                    [
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'StartTimestampMillis' => <integer>,
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetMediaAnalysisJob

$result = $client->getMediaAnalysisJob([/* ... */]);
$promise = $client->getMediaAnalysisJobAsync([/* ... */]);

Retrieves the results for a given media analysis job. Takes a JobId returned by StartMediaAnalysisJob.

Parameter Syntax

$result = $client->getMediaAnalysisJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompletionTimestamp' => <DateTime>,
    'CreationTimestamp' => <DateTime>,
    'FailureDetails' => [
        'Code' => 'INTERNAL_ERROR|INVALID_S3_OBJECT|INVALID_MANIFEST|INVALID_OUTPUT_CONFIG|INVALID_KMS_KEY|ACCESS_DENIED|RESOURCE_NOT_FOUND|RESOURCE_NOT_READY|THROTTLED',
        'Message' => '<string>',
    ],
    'Input' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'JobId' => '<string>',
    'JobName' => '<string>',
    'KmsKeyId' => '<string>',
    'ManifestSummary' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'OperationsConfig' => [
        'DetectModerationLabels' => [
            'MinConfidence' => <float>,
            'ProjectVersion' => '<string>',
        ],
    ],
    'OutputConfig' => [
        'S3Bucket' => '<string>',
        'S3KeyPrefix' => '<string>',
    ],
    'Results' => [
        'ModelVersions' => [
            'Moderation' => '<string>',
        ],
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'Status' => 'CREATED|QUEUED|IN_PROGRESS|SUCCEEDED|FAILED',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

ResourceNotFoundException:

The resource specified in the request cannot be found.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Example 1: GetMediaAnalysisJob

Retrieves the results for a given media analysis job.

$result = $client->getMediaAnalysisJob([
    'JobId' => '861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537',
]);

Result syntax:

[
    'CompletionTimestamp' => ,
    'CreationTimestamp' => ,
    'Input' => [
        'S3Object' => [
            'Bucket' => 'input-bucket',
            'Name' => 'input-manifest.json',
        ],
    ],
    'JobId' => '861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537',
    'JobName' => 'job-name',
    'ManifestSummary' => [
        'S3Object' => [
            'Bucket' => 'output-bucket',
            'Name' => 'output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-manifest-summary.json',
        ],
    ],
    'OperationsConfig' => [
        'DetectModerationLabels' => [
            'MinConfidence' => 50,
            'ProjectVersion' => 'arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958',
        ],
    ],
    'OutputConfig' => [
        'S3Bucket' => 'output-bucket',
        'S3KeyPrefix' => 'output-location',
    ],
    'Results' => [
        'S3Object' => [
            'Bucket' => 'output-bucket',
            'Name' => 'output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-results.jsonl',
        ],
    ],
    'Status' => 'SUCCEEDED',
]

GetPersonTracking

$result = $client->getPersonTracking([/* ... */]);
$promise = $client->getPersonTrackingAsync([/* ... */]);

End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post.

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.

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.

Parameter Syntax

$result = $client->getPersonTracking([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'INDEX|TIMESTAMP',
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'NextToken' => '<string>',
    'Persons' => [
        [
            'Person' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Face' => [
                    'AgeRange' => [
                        'High' => <integer>,
                        'Low' => <integer>,
                    ],
                    'Beard' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'BoundingBox' => [
                        'Height' => <float>,
                        'Left' => <float>,
                        'Top' => <float>,
                        'Width' => <float>,
                    ],
                    'Confidence' => <float>,
                    'Emotions' => [
                        [
                            'Confidence' => <float>,
                            'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                        ],
                        // ...
                    ],
                    'EyeDirection' => [
                        'Confidence' => <float>,
                        'Pitch' => <float>,
                        'Yaw' => <float>,
                    ],
                    'Eyeglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'EyesOpen' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'FaceOccluded' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Gender' => [
                        'Confidence' => <float>,
                        'Value' => 'Male|Female',
                    ],
                    'Landmarks' => [
                        [
                            'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                            'X' => <float>,
                            'Y' => <float>,
                        ],
                        // ...
                    ],
                    'MouthOpen' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Mustache' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Pose' => [
                        'Pitch' => <float>,
                        'Roll' => <float>,
                        'Yaw' => <float>,
                    ],
                    'Quality' => [
                        'Brightness' => <float>,
                        'Sharpness' => <float>,
                    ],
                    'Smile' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'Sunglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                ],
                'Index' => <integer>,
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetSegmentDetection

$result = $client->getSegmentDetection([/* ... */]);
$promise = $client->getSegmentDetectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSegmentDetection([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AudioMetadata' => [
        [
            'Codec' => '<string>',
            'DurationMillis' => <integer>,
            'NumberOfChannels' => <integer>,
            'SampleRate' => <integer>,
        ],
        // ...
    ],
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'NextToken' => '<string>',
    'Segments' => [
        [
            'DurationFrames' => <integer>,
            'DurationMillis' => <integer>,
            'DurationSMPTE' => '<string>',
            'EndFrameNumber' => <integer>,
            'EndTimecodeSMPTE' => '<string>',
            'EndTimestampMillis' => <integer>,
            'ShotSegment' => [
                'Confidence' => <float>,
                'Index' => <integer>,
            ],
            'StartFrameNumber' => <integer>,
            'StartTimecodeSMPTE' => '<string>',
            'StartTimestampMillis' => <integer>,
            'TechnicalCueSegment' => [
                'Confidence' => <float>,
                'Type' => 'ColorBars|EndCredits|BlackFrames|OpeningCredits|StudioLogo|Slate|Content',
            ],
            'Type' => 'TECHNICAL_CUE|SHOT',
        ],
        // ...
    ],
    'SelectedSegmentTypes' => [
        [
            'ModelVersion' => '<string>',
            'Type' => 'TECHNICAL_CUE|SHOT',
        ],
        // ...
    ],
    'StatusMessage' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        [
            'Codec' => '<string>',
            'ColorRange' => 'FULL|LIMITED',
            'DurationMillis' => <integer>,
            'Format' => '<string>',
            'FrameHeight' => <integer>,
            'FrameRate' => <float>,
            'FrameWidth' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

GetTextDetection

$result = $client->getTextDetection([/* ... */]);
$promise = $client->getTextDetectionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getTextDetection([
    'JobId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'JobTag' => '<string>',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'TextDetections' => [
        [
            'TextDetection' => [
                'Confidence' => <float>,
                'DetectedText' => '<string>',
                'Geometry' => [
                    'BoundingBox' => [
                        'Height' => <float>,
                        'Left' => <float>,
                        'Top' => <float>,
                        'Width' => <float>,
                    ],
                    'Polygon' => [
                        [
                            'X' => <float>,
                            'Y' => <float>,
                        ],
                        // ...
                    ],
                ],
                'Id' => <integer>,
                'ParentId' => <integer>,
                'Type' => 'LINE|WORD',
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'TextModelVersion' => '<string>',
    'Video' => [
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'VideoMetadata' => [
        'Codec' => '<string>',
        'ColorRange' => 'FULL|LIMITED',
        'DurationMillis' => <integer>,
        'Format' => '<string>',
        'FrameHeight' => <integer>,
        'FrameRate' => <float>,
        'FrameWidth' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidPaginationTokenException:

Pagination token in the request is not valid.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

IndexFaces

$result = $client->indexFaces([/* ... */]);
$promise = $client->indexFacesAsync([/* ... */]);

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.

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

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

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

• The face is too blurry.

• The image is too dark.

• The face has an extreme pose.

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

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

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

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

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

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

If you request ALL or specific facial attributes (e.g., FACE_OCCLUDED) by using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth), facial occlusion, and other facial attributes.

If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

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

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

Parameter Syntax

$result = $client->indexFaces([
    'CollectionId' => '<string>', // REQUIRED
    'DetectionAttributes' => ['<string>', ...],
    'ExternalImageId' => '<string>',
    'Image' => [ // REQUIRED
        'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
    'MaxFaces' => <integer>,
    'QualityFilter' => 'NONE|AUTO|LOW|MEDIUM|HIGH',
]);

Parameter Details

Result Syntax

[
    'FaceModelVersion' => '<string>',
    'FaceRecords' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'ExternalImageId' => '<string>',
                'FaceId' => '<string>',
                'ImageId' => '<string>',
                'IndexFacesModelVersion' => '<string>',
                'UserId' => '<string>',
            ],
            'FaceDetail' => [
                'AgeRange' => [
                    'High' => <integer>,
                    'Low' => <integer>,
                ],
                'Beard' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'Emotions' => [
                    [
                        'Confidence' => <float>,
                        'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                    ],
                    // ...
                ],
                'EyeDirection' => [
                    'Confidence' => <float>,
                    'Pitch' => <float>,
                    'Yaw' => <float>,
                ],
                'Eyeglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'EyesOpen' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'FaceOccluded' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Gender' => [
                    'Confidence' => <float>,
                    'Value' => 'Male|Female',
                ],
                'Landmarks' => [
                    [
                        'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
                'MouthOpen' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Mustache' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Pose' => [
                    'Pitch' => <float>,
                    'Roll' => <float>,
                    'Yaw' => <float>,
                ],
                'Quality' => [
                    'Brightness' => <float>,
                    'Sharpness' => <float>,
                ],
                'Smile' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Sunglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
            ],
        ],
        // ...
    ],
    'OrientationCorrection' => 'ROTATE_0|ROTATE_90|ROTATE_180|ROTATE_270',
    'UnindexedFaces' => [
        [
            'FaceDetail' => [
                'AgeRange' => [
                    'High' => <integer>,
                    'Low' => <integer>,
                ],
                'Beard' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'Emotions' => [
                    [
                        'Confidence' => <float>,
                        'Type' => 'HAPPY|SAD|ANGRY|CONFUSED|DISGUSTED|SURPRISED|CALM|UNKNOWN|FEAR',
                    ],
                    // ...
                ],
                'EyeDirection' => [
                    'Confidence' => <float>,
                    'Pitch' => <float>,
                    'Yaw' => <float>,
                ],
                'Eyeglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'EyesOpen' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'FaceOccluded' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Gender' => [
                    'Confidence' => <float>,
                    'Value' => 'Male|Female',
                ],
                'Landmarks' => [
                    [
                        'Type' => 'eyeLeft|eyeRight|nose|mouthLeft|mouthRight|leftEyeBrowLeft|leftEyeBrowRight|leftEyeBrowUp|rightEyeBrowLeft|rightEyeBrowRight|rightEyeBrowUp|leftEyeLeft|leftEyeRight|leftEyeUp|leftEyeDown|rightEyeLeft|rightEyeRight|rightEyeUp|rightEyeDown|noseLeft|noseRight|mouthUp|mouthDown|leftPupil|rightPupil|upperJawlineLeft|midJawlineLeft|chinBottom|midJawlineRight|upperJawlineRight',
                        'X' => <float>,
                        'Y' => <float>,
                    ],
                    // ...
                ],
                'MouthOpen' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Mustache' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Pose' => [
                    'Pitch' => <float>,
                    'Roll' => <float>,
                    'Yaw' => <float>,
                ],
                'Quality' => [
                    'Brightness' => <float>,
                    'Sharpness' => <float>,
                ],
                'Smile' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'Sunglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
            ],
            'Reasons' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidS3ObjectException:

Amazon Rekognition is unable to access the S3 object specified in the request.

InvalidParameterException:

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ImageTooLargeException:

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

AccessDeniedException:

You are not authorized to perform the action.

InternalServerError:

Amazon Rekognition experienced a service issue. Try your call again.

ThrottlingException:

Amazon Rekognition is temporarily unable to process the request. Try your call again.

ProvisionedThroughputExceededException:

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException:

The resource specified in the request cannot be found.

InvalidImageFormatException:

The provided image format is not supported.

ServiceQuotaExceededException:

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.