Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DetectProtectiveEquipment

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

Face cover
Hand cover
Head cover

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

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

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

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

The persons detected as wearing all of the types of PPE that you specify.
The persons detected as not wearing all of the types PPE that you specify.
The persons detected where PPE adornment could not be determined.

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

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

Request Syntax


{
   "Image": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "SummarizationAttributes": { 
      "MinConfidence": number,
      "RequiredEquipmentTypes": [ "string" ]
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Image

The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can reference an image stored in an Amazon S3 bucket.

Type: Image object

Required: Yes

SummarizationAttributes

An array of PPE types that you want to summarize.

Type: ProtectiveEquipmentSummarizationAttributes object

Required: No

Response Syntax


{
   "Persons": [ 
      { 
         "BodyParts": [ 
            { 
               "Confidence": number,
               "EquipmentDetections": [ 
                  { 
                     "BoundingBox": { 
                        "Height": number,
                        "Left": number,
                        "Top": number,
                        "Width": number
                     },
                     "Confidence": number,
                     "CoversBodyPart": { 
                        "Confidence": number,
                        "Value": boolean
                     },
                     "Type": "string"
                  }
               ],
               "Name": "string"
            }
         ],
         "BoundingBox": { 
            "Height": number,
            "Left": number,
            "Top": number,
            "Width": number
         },
         "Confidence": number,
         "Id": number
      }
   ],
   "ProtectiveEquipmentModelVersion": "string",
   "Summary": { 
      "PersonsIndeterminate": [ number ],
      "PersonsWithoutRequiredEquipment": [ number ],
      "PersonsWithRequiredEquipment": [ number ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Persons

An array of persons detected in the image (including persons not wearing PPE).

Type: Array of ProtectiveEquipmentPerson objects

ProtectiveEquipmentModelVersion

The version number of the PPE detection model used to detect PPE in the image.

Type: String

Summary

Summary information for the types of PPE specified in the SummarizationAttributes input parameter.

Type: ProtectiveEquipmentSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You are not authorized to perform the action.

HTTP Status Code: 400

ImageTooLargeException

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

HTTP Status Code: 400

InternalServerError

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

HTTP Status Code: 500

InvalidImageFormatException

The provided image format is not supported.

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

InvalidS3ObjectException

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

HTTP Status Code: 400

ProvisionedThroughputExceededException

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

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 500