aws-sdk-rekognition 1.46.0 → 1.51.0

data/lib/aws-sdk-rekognition/errors.rb

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -42,6 +42,7 @@ module Aws::Rekognition
   # * {ResourceInUseException}
   # * {ResourceNotFoundException}
   # * {ResourceNotReadyException}
+  # * {ServiceQuotaExceededException}
   # * {ThrottlingException}
   # * {VideoTooLargeException}
   #
@@ -216,6 +217,16 @@ module Aws::Rekognition
       end
     end
 
+    class ServiceQuotaExceededException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::Rekognition::Types::ServiceQuotaExceededException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
     class ThrottlingException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

data/lib/aws-sdk-rekognition/resource.rb

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 

data/lib/aws-sdk-rekognition/types.rb

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -111,10 +111,11 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Identifies the bounding box around the label, face, or text. The
-    # `left` (x-coordinate) and `top` (y-coordinate) are coordinates
-    # representing the top and left sides of the bounding box. Note that the
-    # upper-left corner of the image is the origin (0,0).
+    # Identifies the bounding box around the label, face, text or personal
+    # protective equipment. The `left` (x-coordinate) and `top`
+    # (y-coordinate) are coordinates representing the top and left sides of
+    # the bounding box. Note that the upper-left corner of the image is the
+    # origin (0,0).
     #
     # The `top` and `left` values returned are ratios of the overall image
     # size. For example, if the input image is 700x200 pixels, and the
@@ -500,19 +501,47 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # Information about an item of Personal Protective Equipment covering a
+    # corresponding body part. For more information, see
+    # DetectProtectiveEquipment.
+    #
+    # @!attribute [rw] confidence
+    #   The confidence that Amazon Rekognition has in the value of `Value`.
+    #   @return [Float]
+    #
+    # @!attribute [rw] value
+    #   True if the PPE covers the corresponding body part, otherwise false.
+    #   @return [Boolean]
+    #
+    class CoversBodyPart < Struct.new(
+      :confidence,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateCollectionRequest
     #   data as a hash:
     #
     #       {
     #         collection_id: "CollectionId", # required
+    #         tags: {
+    #           "TagKey" => "TagValue",
+    #         },
     #       }
     #
     # @!attribute [rw] collection_id
     #   ID for the collection that you are creating.
     #   @return [String]
     #
+    # @!attribute [rw] tags
+    #   A set of tags (key-value pairs) that you want to attach to the
+    #   collection.
+    #   @return [Hash<String,String>]
+    #
     class CreateCollectionRequest < Struct.new(
-      :collection_id)
+      :collection_id,
+      :tags)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -604,6 +633,10 @@ module Aws::Rekognition
     #           ],
     #           auto_create: false,
     #         },
+    #         tags: {
+    #           "TagKey" => "TagValue",
+    #         },
+    #         kms_key_id: "KmsKeyId",
     #       }
     #
     # @!attribute [rw] project_arn
@@ -627,12 +660,32 @@ module Aws::Rekognition
     #   The dataset to use for testing.
     #   @return [Types::TestingData]
     #
+    # @!attribute [rw] tags
+    #   A set of tags (key-value pairs) that you want to attach to the
+    #   model.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] kms_key_id
+    #   The identifier for your AWS Key Management Service (AWS KMS)
+    #   customer master key (CMK). You can supply the Amazon Resource Name
+    #   (ARN) of your CMK, the ID of your CMK, or an alias for your CMK. The
+    #   key is used to encrypt training and test images copied into the
+    #   service for model training. Your source images are unaffected. The
+    #   key is also used to encrypt training results and manifest files
+    #   written to the output Amazon S3 bucket (`OutputConfig`).
+    #
+    #   If you don't specify a value for `KmsKeyId`, images copied into the
+    #   service are encrypted using a key that AWS owns and manages.
+    #   @return [String]
+    #
     class CreateProjectVersionRequest < Struct.new(
       :project_arn,
       :version_name,
       :output_config,
       :training_data,
-      :testing_data)
+      :testing_data,
+      :tags,
+      :kms_key_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -671,6 +724,9 @@ module Aws::Rekognition
     #           },
     #         },
     #         role_arn: "RoleArn", # required
+    #         tags: {
+    #           "TagKey" => "TagValue",
+    #         },
     #       }
     #
     # @!attribute [rw] input
@@ -702,12 +758,18 @@ module Aws::Rekognition
     #   ARN of the IAM role that allows access to the stream processor.
     #   @return [String]
     #
+    # @!attribute [rw] tags
+    #   A set of tags (key-value pairs) that you want to attach to the
+    #   stream processor.
+    #   @return [Hash<String,String>]
+    #
     class CreateStreamProcessorRequest < Struct.new(
       :input,
       :output,
       :name,
       :settings,
-      :role_arn)
+      :role_arn,
+      :tags)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1446,6 +1508,64 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DetectProtectiveEquipmentRequest
+    #   data as a hash:
+    #
+    #       {
+    #         image: { # required
+    #           bytes: "data",
+    #           s3_object: {
+    #             bucket: "S3Bucket",
+    #             name: "S3ObjectName",
+    #             version: "S3ObjectVersion",
+    #           },
+    #         },
+    #         summarization_attributes: {
+    #           min_confidence: 1.0, # required
+    #           required_equipment_types: ["FACE_COVER"], # required, accepts FACE_COVER, HAND_COVER, HEAD_COVER
+    #         },
+    #       }
+    #
+    # @!attribute [rw] 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.
+    #   @return [Types::Image]
+    #
+    # @!attribute [rw] summarization_attributes
+    #   An array of PPE types that you want to summarize.
+    #   @return [Types::ProtectiveEquipmentSummarizationAttributes]
+    #
+    class DetectProtectiveEquipmentRequest < Struct.new(
+      :image,
+      :summarization_attributes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] protective_equipment_model_version
+    #   The version number of the PPE detection model used to detect PPE in
+    #   the image.
+    #   @return [String]
+    #
+    # @!attribute [rw] persons
+    #   An array of persons detected in the image (including persons not
+    #   wearing PPE).
+    #   @return [Array<Types::ProtectiveEquipmentPerson>]
+    #
+    # @!attribute [rw] summary
+    #   Summary information for the types of PPE specified in the
+    #   `SummarizationAttributes` input parameter.
+    #   @return [Types::ProtectiveEquipmentSummary]
+    #
+    class DetectProtectiveEquipmentResponse < Struct.new(
+      :protective_equipment_model_version,
+      :persons,
+      :summary)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A set of optional parameters that you can use to set the criteria that
     # the text must meet to be included in your response. `WordFilter` looks
     # at a word’s height, width, and minimum confidence. `RegionOfInterest`
@@ -1571,10 +1691,10 @@ module Aws::Rekognition
     #       }
     #
     # @!attribute [rw] min_confidence
-    #   Sets confidence of word detection. Words with detection confidence
-    #   below this will be excluded from the result. Values should be
-    #   between 0.5 and 1 as Text in Video will not return any result below
-    #   0.5.
+    #   Sets the confidence of word detection. Words with detection
+    #   confidence below this will be excluded from the result. Values
+    #   should be between 50 and 100 as Text in Video will not return any
+    #   result below 50.
     #   @return [Float]
     #
     # @!attribute [rw] min_bounding_box_height
@@ -1619,6 +1739,36 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # Information about an item of Personal Protective Equipment (PPE)
+    # detected by DetectProtectiveEquipment. For more information, see
+    # DetectProtectiveEquipment.
+    #
+    # @!attribute [rw] bounding_box
+    #   A bounding box surrounding the item of detected PPE.
+    #   @return [Types::BoundingBox]
+    #
+    # @!attribute [rw] confidence
+    #   The confidence that Amazon Rekognition has that the bounding box
+    #   (`BoundingBox`) contains an item of PPE.
+    #   @return [Float]
+    #
+    # @!attribute [rw] type
+    #   The type of detected PPE.
+    #   @return [String]
+    #
+    # @!attribute [rw] covers_body_part
+    #   Information about the body part covered by the detected PPE.
+    #   @return [Types::CoversBodyPart]
+    #
+    class EquipmentDetection < Struct.new(
+      :bounding_box,
+      :confidence,
+      :type,
+      :covers_body_part)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The evaluation results for the training of a model.
     #
     # @!attribute [rw] f1_score
@@ -2903,9 +3053,10 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # The input image size exceeds the allowed limit. For more information,
-    # see Limits in Amazon Rekognition in the Amazon Rekognition Developer
-    # Guide.
+    # 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 Limits in Amazon Rekognition
+    # in the Amazon Rekognition Developer Guide.
     #
     class ImageTooLargeException < Aws::EmptyStructure; end
 
@@ -3387,6 +3538,34 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListTagsForResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "ResourceArn", # required
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   Amazon Resource Name (ARN) of the model, collection, or stream
+    #   processor that contains the tags that you want a list of.
+    #   @return [String]
+    #
+    class ListTagsForResourceRequest < Struct.new(
+      :resource_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] tags
+    #   A list of key-value tags assigned to the resource.
+    #   @return [Hash<String,String>]
+    #
+    class ListTagsForResourceResponse < Struct.new(
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides information about a single type of unsafe content found in an
     # image or video. Each type of moderated content has a label within a
     # hierarchical taxonomy. For more information, see Detecting Unsafe
@@ -3725,6 +3904,11 @@ module Aws::Rekognition
     #   datasets.
     #   @return [Types::GroundTruthManifest]
     #
+    # @!attribute [rw] kms_key_id
+    #   The identifer for the AWS Key Management Service (AWS KMS) customer
+    #   master key that was used to encrypt the model during training.
+    #   @return [String]
+    #
     class ProjectVersionDescription < Struct.new(
       :project_version_arn,
       :creation_timestamp,
@@ -3737,7 +3921,158 @@ module Aws::Rekognition
       :training_data_result,
       :testing_data_result,
       :evaluation_result,
-      :manifest_summary)
+      :manifest_summary,
+      :kms_key_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Information about a body part detected by DetectProtectiveEquipment
+    # that contains PPE. An array of `ProtectiveEquipmentBodyPart` objects
+    # is returned for each person detected by `DetectProtectiveEquipment`.
+    #
+    # @!attribute [rw] name
+    #   The detected body part.
+    #   @return [String]
+    #
+    # @!attribute [rw] confidence
+    #   The confidence that Amazon Rekognition has in the detection accuracy
+    #   of the detected body part.
+    #   @return [Float]
+    #
+    # @!attribute [rw] equipment_detections
+    #   An array of Personal Protective Equipment items detected around a
+    #   body part.
+    #   @return [Array<Types::EquipmentDetection>]
+    #
+    class ProtectiveEquipmentBodyPart < Struct.new(
+      :name,
+      :confidence,
+      :equipment_detections)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A person detected by a call to DetectProtectiveEquipment. The API
+    # returns all persons detected in the input image in an array of
+    # `ProtectiveEquipmentPerson` objects.
+    #
+    # @!attribute [rw] body_parts
+    #   An array of body parts detected on a person's body (including body
+    #   parts without PPE).
+    #   @return [Array<Types::ProtectiveEquipmentBodyPart>]
+    #
+    # @!attribute [rw] bounding_box
+    #   A bounding box around the detected person.
+    #   @return [Types::BoundingBox]
+    #
+    # @!attribute [rw] confidence
+    #   The confidence that Amazon Rekognition has that the bounding box
+    #   contains a person.
+    #   @return [Float]
+    #
+    # @!attribute [rw] id
+    #   The identifier for the detected person. The identifier is only
+    #   unique for a single call to `DetectProtectiveEquipment`.
+    #   @return [Integer]
+    #
+    class ProtectiveEquipmentPerson < Struct.new(
+      :body_parts,
+      :bounding_box,
+      :confidence,
+      :id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specifies summary attributes to return from a call to
+    # DetectProtectiveEquipment. You can specify which types of PPE to
+    # summarize. You can also specify a minimum confidence value for
+    # detections. Summary information is returned in the `Summary`
+    # (ProtectiveEquipmentSummary) field of the response from
+    # `DetectProtectiveEquipment`. The summary includes which persons in an
+    # image were detected wearing the requested types of person protective
+    # equipment (PPE), which persons were detected as not wearing PPE, and
+    # the persons in which a determination could not be made. For more
+    # information, see ProtectiveEquipmentSummary.
+    #
+    # @note When making an API call, you may pass ProtectiveEquipmentSummarizationAttributes
+    #   data as a hash:
+    #
+    #       {
+    #         min_confidence: 1.0, # required
+    #         required_equipment_types: ["FACE_COVER"], # required, accepts FACE_COVER, HAND_COVER, HEAD_COVER
+    #       }
+    #
+    # @!attribute [rw] min_confidence
+    #   The minimum confidence level for which you want summary information.
+    #   The confidence level applies to person detection, body part
+    #   detection, equipment detection, and body part coverage. Amazon
+    #   Rekognition doesn't return summary information with a confidence
+    #   than this specified value. There isn't a default value.
+    #
+    #   Specify a `MinConfidence` value that is between 50-100% as
+    #   `DetectProtectiveEquipment` returns predictions only where the
+    #   detection confidence is between 50% - 100%. If you specify a value
+    #   that is less than 50%, the results are the same specifying a value
+    #   of 50%.
+    #   @return [Float]
+    #
+    # @!attribute [rw] required_equipment_types
+    #   An array of personal protective equipment types for which you want
+    #   summary information. If a person is detected wearing a required
+    #   requipment type, the person's ID is added to the
+    #   `PersonsWithRequiredEquipment` array field returned in
+    #   ProtectiveEquipmentSummary by `DetectProtectiveEquipment`.
+    #   @return [Array<String>]
+    #
+    class ProtectiveEquipmentSummarizationAttributes < Struct.new(
+      :min_confidence,
+      :required_equipment_types)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Summary information for required items of personal protective
+    # equipment (PPE) detected on persons by a call to
+    # DetectProtectiveEquipment. You specify the required type of PPE in the
+    # `SummarizationAttributes` (ProtectiveEquipmentSummarizationAttributes)
+    # input parameter. The summary includes which persons were detected
+    # wearing the required personal protective equipment
+    # (`PersonsWithRequiredEquipment`), which persons were detected as not
+    # wearing the required PPE (`PersonsWithoutRequiredEquipment`), and the
+    # persons in which a determination could not be made
+    # (`PersonsIndeterminate`).
+    #
+    # To get a total for each category, use the size of the field array. For
+    # example, to find out how many people were detected as wearing the
+    # specified PPE, use the size of the `PersonsWithRequiredEquipment`
+    # array. If you want to find out more about a person, such as the
+    # location (BoundingBox) of the person on the image, use the person ID
+    # in each array element. Each person ID matches the ID field of a
+    # ProtectiveEquipmentPerson object returned in the `Persons` array by
+    # `DetectProtectiveEquipment`.
+    #
+    # @!attribute [rw] persons_with_required_equipment
+    #   An array of IDs for persons who are wearing detected personal
+    #   protective equipment.
+    #   @return [Array<Integer>]
+    #
+    # @!attribute [rw] persons_without_required_equipment
+    #   An array of IDs for persons who are not wearing all of the types of
+    #   PPE specified in the `RequiredEquipmentTypes` field of the detected
+    #   personal protective equipment.
+    #   @return [Array<Integer>]
+    #
+    # @!attribute [rw] persons_indeterminate
+    #   An array of IDs for persons where it was not possible to determine
+    #   if they are wearing personal protective equipment.
+    #   @return [Array<Integer>]
+    #
+    class ProtectiveEquipmentSummary < Struct.new(
+      :persons_with_required_equipment,
+      :persons_without_required_equipment,
+      :persons_indeterminate)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3844,7 +4179,7 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # A collection with the specified ID already exists.
+    # A resource with the specified ID already exists.
     #
     class ResourceAlreadyExistsException < Aws::EmptyStructure; end
 
@@ -3852,7 +4187,7 @@ module Aws::Rekognition
     #
     class ResourceInUseException < Aws::EmptyStructure; end
 
-    # The collection specified in the request cannot be found.
+    # The resource specified in the request cannot be found.
     #
     class ResourceNotFoundException < Aws::EmptyStructure; end
 
@@ -4145,6 +4480,12 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # The size of the collection exceeds the allowed limit. For more
+    # information, see Limits in Amazon Rekognition in the Amazon
+    # Rekognition Developer Guide.
+    #
+    class ServiceQuotaExceededException < Aws::EmptyStructure; end
+
     # Information about a shot detection segment detected in a video. For
     # more information, see SegmentDetection.
     #
@@ -5164,6 +5505,34 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass TagResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "ResourceArn", # required
+    #         tags: { # required
+    #           "TagKey" => "TagValue",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   Amazon Resource Name (ARN) of the model, collection, or stream
+    #   processor that you want to assign the tags to.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   The key-value tags to assign to the resource.
+    #   @return [Hash<String,String>]
+    #
+    class TagResourceRequest < Struct.new(
+      :resource_arn,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    class TagResourceResponse < Aws::EmptyStructure; end
+
     # Information about a technical cue segment. For more information, see
     # SegmentDetection.
     #
@@ -5417,6 +5786,32 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass UntagResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "ResourceArn", # required
+    #         tag_keys: ["TagKey"], # required
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   Amazon Resource Name (ARN) of the model, collection, or stream
+    #   processor that you want to remove the tags from.
+    #   @return [String]
+    #
+    # @!attribute [rw] tag_keys
+    #   A list of the tags that you want to remove.
+    #   @return [Array<String>]
+    #
+    class UntagResourceRequest < Struct.new(
+      :resource_arn,
+      :tag_keys)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    class UntagResourceResponse < Aws::EmptyStructure; end
+
     # Contains the Amazon S3 bucket location of the validation data for a
     # model training job.
     #