Amazon Rekognition 2016-06-27

CompareFaces

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

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>,
                '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>,
                ],
            ],
            '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>,
            '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>,
            ],
        ],
        // ...
    ],
]

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. For more information, see Limits 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,
    ],
]

CreateCollection

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

Parameter Syntax

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

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 collection with the specified ID already exists.

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

CreateProject

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceInUseException:

• LimitExceededException:

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

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

CreateProjectVersion

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceInUseException:

• ResourceNotFoundException:

  The collection specified in the request cannot be found.

• LimitExceededException:

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

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

CreateStreamProcessor

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

Parameter Syntax

$result = $client->createStreamProcessor([
    'Input' => [ // REQUIRED
        'KinesisVideoStream' => [
            'Arn' => '<string>',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'Output' => [ // REQUIRED
        'KinesisDataStream' => [
            'Arn' => '<string>',
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Settings' => [ // REQUIRED
        'FaceSearch' => [
            'CollectionId' => '<string>',
            'FaceMatchThreshold' => <float>,
        ],
    ],
]);

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 Amazon Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

• ResourceInUseException:

• ProvisionedThroughputExceededException:

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

DeleteCollection

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

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 collection 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,
]

DeleteFaces

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DeletedFaces' => ['<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 collection 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',
    ],
]

DeleteStreamProcessor

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

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 collection specified in the request cannot be found.

• ResourceInUseException:

• ProvisionedThroughputExceededException:

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

DescribeCollection

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CollectionARN' => '<string>',
    'CreationTimestamp' => <DateTime>,
    'FaceCount' => <integer>,
    'FaceModelVersion' => '<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 collection specified in the request cannot be found.

DescribeProjectVersions

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProjectVersionDescriptions' => [
        [
            'BillableTrainingTimeInSeconds' => <integer>,
            'CreationTimestamp' => <DateTime>,
            'EvaluationResult' => [
                'F1Score' => <float>,
                'Summary' => [
                    'S3Object' => [
                        'Bucket' => '<string>',
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                ],
            ],
            'MinInferenceUnits' => <integer>,
            'OutputConfig' => [
                'S3Bucket' => '<string>',
                'S3KeyPrefix' => '<string>',
            ],
            'ProjectVersionArn' => '<string>',
            'Status' => 'TRAINING_IN_PROGRESS|TRAINING_COMPLETED|TRAINING_FAILED|STARTING|RUNNING|FAILED|STOPPING|STOPPED|DELETING',
            '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,
                ],
            ],
            'TrainingDataResult' => [
                'Input' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
                'Output' => [
                    'Assets' => [
                        [
                            'GroundTruthManifest' => [
                                'S3Object' => [
                                    'Bucket' => '<string>',
                                    'Name' => '<string>',
                                    'Version' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'TrainingEndTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceNotFoundException:

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

DescribeProjects

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProjectDescriptions' => [
        [
            'CreationTimestamp' => <DateTime>,
            '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.

DescribeStreamProcessor

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreationTimestamp' => <DateTime>,
    'Input' => [
        'KinesisVideoStream' => [
            'Arn' => '<string>',
        ],
    ],
    'LastUpdateTimestamp' => <DateTime>,
    'Name' => '<string>',
    'Output' => [
        'KinesisDataStream' => [
            'Arn' => '<string>',
        ],
    ],
    'RoleArn' => '<string>',
    'Settings' => [
        'FaceSearch' => [
            'CollectionId' => '<string>',
            'FaceMatchThreshold' => <float>,
        ],
    ],
    'Status' => 'STOPPED|STARTING|RUNNING|FAILED|STOPPING',
    '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 collection specified in the request cannot be found.

• ProvisionedThroughputExceededException:

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

DetectCustomLabels

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

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 collection 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. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

• LimitExceededException:

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

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

DetectFaces

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

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',
                ],
                // ...
            ],
            'Eyeglasses' => [
                'Confidence' => <float>,
                'Value' => true || false,
            ],
            'EyesOpen' => [
                '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. For more information, see Limits 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'LabelModelVersion' => '<string>',
    'Labels' => [
        [
            'Confidence' => <float>,
            'Instances' => [
                [
                    'BoundingBox' => [
                        'Height' => <float>,
                        'Left' => <float>,
                        'Top' => <float>,
                        'Width' => <float>,
                    ],
                    'Confidence' => <float>,
                ],
                // ...
            ],
            '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. For more information, see Limits 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([/* ... */]);

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

Parameter Details

Result Syntax

[
    'HumanLoopActivationOutput' => [
        'HumanLoopActivationConditionsEvaluationResults' => '<string>',
        'HumanLoopActivationReasons' => ['<string>', ...],
        'HumanLoopArn' => '<string>',
    ],
    'ModerationLabels' => [
        [
            'Confidence' => <float>,
            'Name' => '<string>',
            'ParentName' => '<string>',
        ],
        // ...
    ],
    'ModerationModelVersion' => '<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. For more information, see Limits 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.

DetectText

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

Parameter Syntax

$result = $client->detectText([
    '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',
        ],
        // ...
    ],
]

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. For more information, see Limits 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.

GetCelebrityInfo

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    '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 collection specified in the request cannot be found.

GetCelebrityRecognition

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

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',
                        ],
                        // ...
                    ],
                    'Eyeglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'EyesOpen' => [
                        '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>',
                'Name' => '<string>',
                'Urls' => ['<string>', ...],
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'VideoMetadata' => [
        'Codec' => '<string>',
        '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 collection 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'ModerationLabels' => [
        [
            'ModerationLabel' => [
                'Confidence' => <float>,
                'Name' => '<string>',
                'ParentName' => '<string>',
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'ModerationModelVersion' => '<string>',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'VideoMetadata' => [
        'Codec' => '<string>',
        '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 collection 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([/* ... */]);

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',
                    ],
                    // ...
                ],
                'Eyeglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'EyesOpen' => [
                    '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>,
        ],
        // ...
    ],
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'VideoMetadata' => [
        'Codec' => '<string>',
        '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 collection specified in the request cannot be found.

• ThrottlingException:

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

GetFaceSearch

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'NextToken' => '<string>',
    'Persons' => [
        [
            'FaceMatches' => [
                [
                    'Face' => [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Confidence' => <float>,
                        'ExternalImageId' => '<string>',
                        'FaceId' => '<string>',
                        'ImageId' => '<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',
                        ],
                        // ...
                    ],
                    'Eyeglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'EyesOpen' => [
                        '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>',
    'VideoMetadata' => [
        'Codec' => '<string>',
        '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 collection 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'LabelModelVersion' => '<string>',
    'Labels' => [
        [
            'Label' => [
                'Confidence' => <float>,
                'Instances' => [
                    [
                        'BoundingBox' => [
                            'Height' => <float>,
                            'Left' => <float>,
                            'Top' => <float>,
                            'Width' => <float>,
                        ],
                        'Confidence' => <float>,
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'Parents' => [
                    [
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Timestamp' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'StatusMessage' => '<string>',
    'VideoMetadata' => [
        'Codec' => '<string>',
        '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 collection specified in the request cannot be found.

• ThrottlingException:

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

GetPersonTracking

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    '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',
                        ],
                        // ...
                    ],
                    'Eyeglasses' => [
                        'Confidence' => <float>,
                        'Value' => true || false,
                    ],
                    'EyesOpen' => [
                        '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>',
    'VideoMetadata' => [
        'Codec' => '<string>',
        '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 collection 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([/* ... */]);

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>',
            ],
            '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',
                    ],
                    // ...
                ],
                'Eyeglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'EyesOpen' => [
                    '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',
                    ],
                    // ...
                ],
                'Eyeglasses' => [
                    'Confidence' => <float>,
                    'Value' => true || false,
                ],
                'EyesOpen' => [
                    '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. For more information, see Limits 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 collection specified in the request cannot be found.

• InvalidImageFormatException:

  The provided image format is not supported.

Examples

Example 1: To add a face to a collection

This operation detects faces in an image and adds them to the specified Rekognition collection.

$result = $client->indexFaces([
    'CollectionId' => 'myphotos',
    'DetectionAttributes' => [
    ],
    'ExternalImageId' => 'myphotoid',
    'Image' => [
        'S3Object' => [
            'Bucket' => 'mybucket',
            'Name' => 'myphoto',
        ],
    ],
]);

Result syntax:

[
    'FaceRecords' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.33481481671333,
                    'Left' => 0.31888890266418,
                    'Top' => 0.49333333969116,
                    'Width' => 0.25,
                ],
                'Confidence' => 99.999122619629,
                'FaceId' => 'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
                'ImageId' => '465f4e93-763e-51d0-b030-b9667a2d94b1',
            ],
            'FaceDetail' => [
                'BoundingBox' => [
                    'Height' => 0.33481481671333,
                    'Left' => 0.31888890266418,
                    'Top' => 0.49333333969116,
                    'Width' => 0.25,
                ],
                'Confidence' => 99.999122619629,
                'Landmarks' => [
                    [
                        'Type' => 'eyeLeft',
                        'X' => 0.39767646789551,
                        'Y' => 0.62483459711075,
                    ],
                    [
                        'Type' => 'eyeRight',
                        'X' => 0.48109364509583,
                        'Y' => 0.63171172142029,
                    ],
                    [
                        'Type' => 'noseLeft',
                        'X' => 0.41986238956451,
                        'Y' => 0.71119403839111,
                    ],
                    [
                        'Type' => 'mouthDown',
                        'X' => 0.40525302290916,
                        'Y' => 0.7497701048851,
                    ],
                    [
                        'Type' => 'mouthUp',
                        'X' => 0.47532489895821,
                        'Y' => 0.75585496425629,
                    ],
                ],
                'Pose' => [
                    'Pitch' => -9.7136459350586,
                    'Roll' => 4.7072811126709,
                    'Yaw' => -24.438663482666,
                ],
                'Quality' => [
                    'Brightness' => 29.233589172363,
                    'Sharpness' => 80,
                ],
            ],
        ],
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.32592591643333,
                    'Left' => 0.51444447040558,
                    'Top' => 0.15111111104488,
                    'Width' => 0.24444444477558,
                ],
                'Confidence' => 99.999504089355,
                'FaceId' => '8be04dba-4e58-520d-850e-9eae4af70eb2',
                'ImageId' => '465f4e93-763e-51d0-b030-b9667a2d94b1',
            ],
            'FaceDetail' => [
                'BoundingBox' => [
                    'Height' => 0.32592591643333,
                    'Left' => 0.51444447040558,
                    'Top' => 0.15111111104488,
                    'Width' => 0.24444444477558,
                ],
                'Confidence' => 99.999504089355,
                'Landmarks' => [
                    [
                        'Type' => 'eyeLeft',
                        'X' => 0.6006892323494,
                        'Y' => 0.29084220528603,
                    ],
                    [
                        'Type' => 'eyeRight',
                        'X' => 0.68081414699554,
                        'Y' => 0.29609042406082,
                    ],
                    [
                        'Type' => 'noseLeft',
                        'X' => 0.63953322172165,
                        'Y' => 0.35225957632065,
                    ],
                    [
                        'Type' => 'mouthDown',
                        'X' => 0.58920830488205,
                        'Y' => 0.38689887523651,
                    ],
                    [
                        'Type' => 'mouthUp',
                        'X' => 0.6745600104332,
                        'Y' => 0.39412575960159,
                    ],
                ],
                'Pose' => [
                    'Pitch' => -4.6831383705139,
                    'Roll' => 2.1029529571533,
                    'Yaw' => 6.716655254364,
                ],
                'Quality' => [
                    'Brightness' => 34.951698303223,
                    'Sharpness' => 160,
                ],
            ],
        ],
    ],
    'OrientationCorrection' => 'ROTATE_0',
]

ListCollections

$result = $client->listCollections([/* ... */]);
$promise = $client->listCollectionsAsync([/* ... */]);

Parameter Syntax

$result = $client->listCollections([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CollectionIds' => ['<string>', ...],
    'FaceModelVersions' => ['<string>', ...],
    'NextToken' => '<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.

• InvalidPaginationTokenException:

  Pagination token in the request is not valid.

• ResourceNotFoundException:

  The collection specified in the request cannot be found.

Examples

Example 1: To list the collections

This operation returns a list of Rekognition collections.

$result = $client->listCollections([
]);

Result syntax:

[
    'CollectionIds' => [
        'myphotos',
    ],
]

ListFaces

$result = $client->listFaces([/* ... */]);
$promise = $client->listFacesAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FaceModelVersion' => '<string>',
    'Faces' => [
        [
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Confidence' => <float>,
            'ExternalImageId' => '<string>',
            'FaceId' => '<string>',
            'ImageId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<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.

• InvalidPaginationTokenException:

  Pagination token in the request is not valid.

• ResourceNotFoundException:

  The collection specified in the request cannot be found.

Examples

Example 1: To list the faces in a collection

This operation lists the faces in a Rekognition collection.

$result = $client->listFaces([
    'CollectionId' => 'myphotos',
    'MaxResults' => 20,
]);

Result syntax:

[
    'Faces' => [
        [
            'BoundingBox' => [
                'Height' => 0.18000000715256,
                'Left' => 0.55555599927902,
                'Top' => 0.33666700124741,
                'Width' => 0.23999999463558,
            ],
            'Confidence' => 100,
            'FaceId' => '1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7',
            'ImageId' => '147fdf82-7a71-52cf-819b-e786c7b9746e',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.16555599868298,
                'Left' => 0.30963000655174,
                'Top' => 0.70666700601578,
                'Width' => 0.22074100375175,
            ],
            'Confidence' => 100,
            'FaceId' => '29a75abe-397b-5101-ba4f-706783b2246c',
            'ImageId' => '147fdf82-7a71-52cf-819b-e786c7b9746e',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.32344201207161,
                'Left' => 0.32333299517632,
                'Top' => 0.5,
                'Width' => 0.24222199618816,
            ],
            'Confidence' => 99.99829864502,
            'FaceId' => '38271d79-7bc2-5efb-b752-398a8d575b85',
            'ImageId' => 'd5631190-d039-54e4-b267-abd22c8647c5',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.035555601119995,
                'Left' => 0.37388700246811,
                'Top' => 0.24777799844742,
                'Width' => 0.047477699816227,
            ],
            'Confidence' => 99.99210357666,
            'FaceId' => '3b01bef0-c883-5654-ba42-d5ad28b720b3',
            'ImageId' => '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.053333301097155,
                'Left' => 0.29376900196075,
                'Top' => 0.35666701197624,
                'Width' => 0.071216598153114,
            ],
            'Confidence' => 99.999198913574,
            'FaceId' => '4839a608-49d0-566c-8301-509d71b534d1',
            'ImageId' => '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.32492598891258,
                'Left' => 0.51555597782135,
                'Top' => 0.15133500099182,
                'Width' => 0.24333299696445,
            ],
            'Confidence' => 99.999496459961,
            'FaceId' => '70008e50-75e4-55d0-8e80-363fb73b3a14',
            'ImageId' => 'd5631190-d039-54e4-b267-abd22c8647c5',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.037777800112963,
                'Left' => 0.70029699802399,
                'Top' => 0.18777799606323,
                'Width' => 0.050445098429918,
            ],
            'Confidence' => 99.926399230957,
            'FaceId' => '7f5f88ed-d684-5a88-b0df-01e4a521552b',
            'ImageId' => '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.05555560067296,
                'Left' => 0.1394660025835,
                'Top' => 0.46333301067352,
                'Width' => 0.072700299322605,
            ],
            'Confidence' => 99.994697570801,
            'FaceId' => '895b4e2c-81de-5902-a4bd-d1792bda00b2',
            'ImageId' => '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.3259260058403,
                'Left' => 0.51444399356842,
                'Top' => 0.15111100673676,
                'Width' => 0.24444399774075,
            ],
            'Confidence' => 99.999496459961,
            'FaceId' => '8be04dba-4e58-520d-850e-9eae4af70eb2',
            'ImageId' => '465f4e93-763e-51d0-b030-b9667a2d94b1',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.18888899683952,
                'Left' => 0.37833800911903,
                'Top' => 0.23555600643158,
                'Width' => 0.25222599506378,
            ],
            'Confidence' => 99.999900817871,
            'FaceId' => '908544ad-edc3-59df-8faf-6a87cc256cf5',
            'ImageId' => '3c731605-d772-541a-a5e7-0375dbc68a07',
        ],
        [
            'BoundingBox' => [
                'Height' => 0.33481499552727,
                'Left' => 0.31888899207115,
                'Top' => 0.49333301186562,
                'Width' => 0.25,
            ],
            'Confidence' => 99.999099731445,
            'FaceId' => 'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
            'ImageId' => '465f4e93-763e-51d0-b030-b9667a2d94b1',
        ],
    ],
]

ListStreamProcessors

$result = $client->listStreamProcessors([/* ... */]);
$promise = $client->listStreamProcessorsAsync([/* ... */]);

Parameter Syntax

$result = $client->listStreamProcessors([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'StreamProcessors' => [
        [
            'Name' => '<string>',
            'Status' => 'STOPPED|STARTING|RUNNING|FAILED|STOPPING',
        ],
        // ...
    ],
]

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.

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

RecognizeCelebrities

$result = $client->recognizeCelebrities([/* ... */]);
$promise = $client->recognizeCelebritiesAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CelebrityFaces' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                '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>,
                ],
            ],
            'Id' => '<string>',
            'MatchConfidence' => <float>,
            'Name' => '<string>',
            'Urls' => ['<string>', ...],
        ],
        // ...
    ],
    'OrientationCorrection' => 'ROTATE_0|ROTATE_90|ROTATE_180|ROTATE_270',
    'UnrecognizedFaces' => [
        [
            'BoundingBox' => [
                'Height' => <float>,
                'Left' => <float>,
                'Top' => <float>,
                'Width' => <float>,
            ],
            'Confidence' => <float>,
            '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>,
            ],
        ],
        // ...
    ],
]

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.

• InvalidImageFormatException:

  The provided image format is not supported.

• ImageTooLargeException:

  The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

• AccessDeniedException:

  You are not authorized to perform the action.

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

SearchFaces

$result = $client->searchFaces([/* ... */]);
$promise = $client->searchFacesAsync([/* ... */]);

Parameter Syntax

$result = $client->searchFaces([
    'CollectionId' => '<string>', // REQUIRED
    'FaceId' => '<string>', // REQUIRED
    'FaceMatchThreshold' => <float>,
    'MaxFaces' => <integer>,
]);

Parameter Details

Result Syntax

[
    'FaceMatches' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'ExternalImageId' => '<string>',
                'FaceId' => '<string>',
                'ImageId' => '<string>',
            ],
            'Similarity' => <float>,
        ],
        // ...
    ],
    'FaceModelVersion' => '<string>',
    'SearchedFaceId' => '<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 collection specified in the request cannot be found.

Examples

Example 1: To delete a face

This operation searches for matching faces in the collection the supplied face belongs to.

$result = $client->searchFaces([
    'CollectionId' => 'myphotos',
    'FaceId' => '70008e50-75e4-55d0-8e80-363fb73b3a14',
    'FaceMatchThreshold' => 90,
    'MaxFaces' => 10,
]);

Result syntax:

[
    'FaceMatches' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.3259260058403,
                    'Left' => 0.51444399356842,
                    'Top' => 0.15111100673676,
                    'Width' => 0.24444399774075,
                ],
                'Confidence' => 99.999496459961,
                'FaceId' => '8be04dba-4e58-520d-850e-9eae4af70eb2',
                'ImageId' => '465f4e93-763e-51d0-b030-b9667a2d94b1',
            ],
            'Similarity' => 99.972221374512,
        ],
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.16555599868298,
                    'Left' => 0.30963000655174,
                    'Top' => 0.70666700601578,
                    'Width' => 0.22074100375175,
                ],
                'Confidence' => 100,
                'FaceId' => '29a75abe-397b-5101-ba4f-706783b2246c',
                'ImageId' => '147fdf82-7a71-52cf-819b-e786c7b9746e',
            ],
            'Similarity' => 97.041549682617,
        ],
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.18888899683952,
                    'Left' => 0.37833800911903,
                    'Top' => 0.23555600643158,
                    'Width' => 0.25222599506378,
                ],
                'Confidence' => 99.999900817871,
                'FaceId' => '908544ad-edc3-59df-8faf-6a87cc256cf5',
                'ImageId' => '3c731605-d772-541a-a5e7-0375dbc68a07',
            ],
            'Similarity' => 95.945205688477,
        ],
    ],
    'SearchedFaceId' => '70008e50-75e4-55d0-8e80-363fb73b3a14',
]

SearchFacesByImage

$result = $client->searchFacesByImage([/* ... */]);
$promise = $client->searchFacesByImageAsync([/* ... */]);

Parameter Syntax

$result = $client->searchFacesByImage([
    'CollectionId' => '<string>', // REQUIRED
    'FaceMatchThreshold' => <float>,
    '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

[
    'FaceMatches' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => <float>,
                    'Left' => <float>,
                    'Top' => <float>,
                    'Width' => <float>,
                ],
                'Confidence' => <float>,
                'ExternalImageId' => '<string>',
                'FaceId' => '<string>',
                'ImageId' => '<string>',
            ],
            'Similarity' => <float>,
        ],
        // ...
    ],
    'FaceModelVersion' => '<string>',
    'SearchedFaceBoundingBox' => [
        'Height' => <float>,
        'Left' => <float>,
        'Top' => <float>,
        'Width' => <float>,
    ],
    'SearchedFaceConfidence' => <float>,
]

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. For more information, see Limits 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 collection specified in the request cannot be found.

• InvalidImageFormatException:

  The provided image format is not supported.

Examples

Example 1: To search for faces matching a supplied image

This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.

$result = $client->searchFacesByImage([
    'CollectionId' => 'myphotos',
    'FaceMatchThreshold' => 95,
    'Image' => [
        'S3Object' => [
            'Bucket' => 'mybucket',
            'Name' => 'myphoto',
        ],
    ],
    'MaxFaces' => 5,
]);

Result syntax:

[
    'FaceMatches' => [
        [
            'Face' => [
                'BoundingBox' => [
                    'Height' => 0.32344201207161,
                    'Left' => 0.32333299517632,
                    'Top' => 0.5,
                    'Width' => 0.24222199618816,
                ],
                'Confidence' => 99.99829864502,
                'FaceId' => '38271d79-7bc2-5efb-b752-398a8d575b85',
                'ImageId' => 'd5631190-d039-54e4-b267-abd22c8647c5',
            ],
            'Similarity' => 99.970367431641,
        ],
    ],
    'SearchedFaceBoundingBox' => [
        'Height' => 0.33481481671333,
        'Left' => 0.31888890266418,
        'Top' => 0.49333333969116,
        'Width' => 0.25,
    ],
    'SearchedFaceConfidence' => 99.999122619629,
]

StartCelebrityRecognition

$result = $client->startCelebrityRecognition([/* ... */]);
$promise = $client->startCelebrityRecognitionAsync([/* ... */]);

Parameter Syntax

$result = $client->startCelebrityRecognition([
    'ClientRequestToken' => '<string>',
    'JobTag' => '<string>',
    'NotificationChannel' => [
        'RoleArn' => '<string>', // REQUIRED
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'Video' => [ // REQUIRED
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• AccessDeniedException:

  You are not authorized to perform the action.

• IdempotentParameterMismatchException:

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

• InvalidParameterException:

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

• InvalidS3ObjectException:

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

• InternalServerError:

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

• VideoTooLargeException:

  The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

• ProvisionedThroughputExceededException:

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

• LimitExceededException:

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

• ThrottlingException:

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

StartContentModeration

$result = $client->startContentModeration([/* ... */]);
$promise = $client->startContentModerationAsync([/* ... */]);

Parameter Syntax

$result = $client->startContentModeration([
    'ClientRequestToken' => '<string>',
    'JobTag' => '<string>',
    'MinConfidence' => <float>,
    'NotificationChannel' => [
        'RoleArn' => '<string>', // REQUIRED
        'SNSTopicArn' => '<string>', // REQUIRED
    ],
    'Video' => [ // REQUIRED
        'S3Object' => [
            'Bucket' => '<string>',
            'Name' => '<string>',
            'Version' => '<string>',
        ],
    ],
]);

Parameter Details