aws-sdk-rekognition 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a1e659bfcab4d476ed16b82699563d8a4245a87
-  data.tar.gz: e56321ace7c7b09ac2eaa2ac8508490423cd26db
+  metadata.gz: 7b69d3f2dcfb6e15adb8d4025d2dec808bfb3aeb
+  data.tar.gz: d6436cc0bf622e71424a52944a64b61687e03c72
 SHA512:
-  metadata.gz: 3cd64dcc63fa45b6218098c936c0b834f20b209e7e737adc9da27bf4ca3ea9537055e7b8236e8e052a7caa12fadbb049a5458459f1451f548445bb2ccb3f285c
-  data.tar.gz: 4625b27e2a08f494f9bb96977ed408f3f527f30b0c0fae56a5c055c4eb578c6b6724f456fcb6fea9407f523a3c576da49046327bd80d05dffeab4d32c054d811
+  metadata.gz: 3b7765b6a96526d4b10d072754be543167fe7560ce8226d5d4c0b3c92bbb5a029b1eb34e3258c1c7b6128ce870b50338f0fd1e2ba5a24247769d8b3bff216507
+  data.tar.gz: a5a06d8e5c90b6515d6feb9dda540e933bc5901ac9c5457469e35ce0edd4802115744458eac7dcbd2a805730194652b9baa7839a63a9091a9a6b38b6b8164372

data/lib/aws-sdk-rekognition.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.13.0'
+  GEM_VERSION = '1.14.0'
 
 end

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

@@ -959,6 +959,19 @@ module Aws::Rekognition
     #
     #  </note>
     #
+    # `DetectLabels` returns bounding boxes for instances of common object
+    # labels in an array of objects. An `Instance` object contains a object,
+    # for the location of the label on the image. It also includes the
+    # confidence by which the bounding box was detected.
+    #
+    # `DetectLabels` also returns a hierarchical taxonomy of detected
+    # labels. For example, a detected car might be assigned the label *car*.
+    # The label *car* has two parent labels: *Vehicle* (its parent) and
+    # *Transportation* (its grandparent). The response returns the entire
+    # list of ancestors for a label. Each ancestor is a unique label in the
+    # response. In the previous example, *Car*, *Vehicle*, and
+    # *Transportation* are returned as unique labels in the response.
+    #
     # This is a stateless API operation. That is, the operation does not
     # persist any data.
     #
@@ -987,6 +1000,7 @@ module Aws::Rekognition
     #
     #   * {Types::DetectLabelsResponse#labels #labels} => Array&lt;Types::Label&gt;
     #   * {Types::DetectLabelsResponse#orientation_correction #orientation_correction} => String
+    #   * {Types::DetectLabelsResponse#label_model_version #label_model_version} => String
     #
     #
     # @example Example: To detect labels
@@ -1038,7 +1052,16 @@ module Aws::Rekognition
     #   resp.labels #=> Array
     #   resp.labels[0].name #=> String
     #   resp.labels[0].confidence #=> Float
+    #   resp.labels[0].instances #=> Array
+    #   resp.labels[0].instances[0].bounding_box.width #=> Float
+    #   resp.labels[0].instances[0].bounding_box.height #=> Float
+    #   resp.labels[0].instances[0].bounding_box.left #=> Float
+    #   resp.labels[0].instances[0].bounding_box.top #=> Float
+    #   resp.labels[0].instances[0].confidence #=> Float
+    #   resp.labels[0].parents #=> Array
+    #   resp.labels[0].parents[0].name #=> String
     #   resp.orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
+    #   resp.label_model_version #=> String
     #
     # @overload detect_labels(params = {})
     # @param [Hash] params ({})
@@ -1765,6 +1788,13 @@ module Aws::Rekognition
     # with the token value returned from the previous call to
     # `GetLabelDetection`.
     #
+    # <note markdown="1"> `GetLabelDetection` doesn't return a hierarchical taxonomy, or
+    # bounding box information, for detected labels. `GetLabelDetection`
+    # returns `null` for the `Parents` and `Instances` attributes of the
+    # object which is returned in the `Labels` array.
+    #
+    #  </note>
+    #
     # @option params [required, String] :job_id
     #   Job identifier for the label detection operation for which you want
     #   results returned. You get the job identifer from an initial call to
@@ -1821,6 +1851,14 @@ module Aws::Rekognition
     #   resp.labels[0].timestamp #=> Integer
     #   resp.labels[0].label.name #=> String
     #   resp.labels[0].label.confidence #=> Float
+    #   resp.labels[0].label.instances #=> Array
+    #   resp.labels[0].label.instances[0].bounding_box.width #=> Float
+    #   resp.labels[0].label.instances[0].bounding_box.height #=> Float
+    #   resp.labels[0].label.instances[0].bounding_box.left #=> Float
+    #   resp.labels[0].label.instances[0].bounding_box.top #=> Float
+    #   resp.labels[0].label.instances[0].confidence #=> Float
+    #   resp.labels[0].label.parents #=> Array
+    #   resp.labels[0].label.parents[0].name #=> String
     #
     # @overload get_label_detection(params = {})
     # @param [Hash] params ({})
@@ -1829,22 +1867,22 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
-    # Gets the person tracking results of a Amazon Rekognition Video
-    # analysis started by .
+    # Gets the path tracking results of a Amazon Rekognition Video analysis
+    # started by .
     #
-    # The person detection operation is started by a call to
+    # The person path tracking operation is started by a call to
     # `StartPersonTracking` which returns a job identifier (`JobId`). When
-    # the person detection operation finishes, Amazon Rekognition Video
-    # publishes a completion status to the Amazon Simple Notification
-    # Service topic registered in the initial call to `StartPersonTracking`.
+    # the operation finishes, Amazon Rekognition Video publishes a
+    # completion status to the Amazon Simple Notification Service topic
+    # registered in the initial call to `StartPersonTracking`.
     #
-    # To get the results of the person tracking operation, first check that
-    # the status value published to the Amazon SNS topic is `SUCCEEDED`. If
-    # so, call and pass the job identifier (`JobId`) from the initial call
-    # to `StartPersonTracking`.
+    # To get the results of the person path tracking operation, first check
+    # that the status value published to the Amazon SNS topic is
+    # `SUCCEEDED`. If so, call and pass the job identifier (`JobId`) from
+    # the initial call to `StartPersonTracking`.
     #
     # `GetPersonTracking` returns an array, `Persons`, of tracked persons
-    # and the time(s) they were tracked in the video.
+    # and the time(s) their paths were tracked in the video.
     #
     # <note markdown="1"> `GetPersonTracking` only returns the default facial attributes
     # (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
@@ -1856,9 +1894,9 @@ module Aws::Rekognition
     #
     #  </note>
     #
-    # By default, the array is sorted by the time(s) a person is tracked in
-    # the video. You can sort by tracked persons by specifying `INDEX` for
-    # the `SortBy` input parameter.
+    # By default, the array is sorted by the time(s) a person's path is
+    # tracked in the video. You can sort by tracked persons by specifying
+    # `INDEX` for the `SortBy` input parameter.
     #
     # Use the `MaxResults` parameter to limit the number of items returned.
     # If there are more results than specified in `MaxResults`, the value of
@@ -3158,7 +3196,9 @@ module Aws::Rekognition
     #   certain Amazon Rekognition is that the moderated content is correctly
     #   identified. 0 is the lowest confidence. 100 is the highest confidence.
     #   Amazon Rekognition doesn't return any moderated content labels with a
-    #   confidence level lower than this specified value.
+    #   confidence level lower than this specified value. If you don't
+    #   specify `MinConfidence`, `GetContentModeration` returns labels with
+    #   confidence values greater than or equal to 50 percent.
     #
     # @option params [String] :client_request_token
     #   Idempotent token used to identify the start request. If you use the
@@ -3216,7 +3256,7 @@ module Aws::Rekognition
     # (`JobId`) that you use to get the results of the operation. When face
     # detection is finished, Amazon Rekognition Video publishes a completion
     # status to the Amazon Simple Notification Service topic that you
-    # specify in `NotificationChannel`. To get the results of the label
+    # specify in `NotificationChannel`. To get the results of the face
     # detection operation, first check that the status value published to
     # the Amazon SNS topic is `SUCCEEDED`. If so, call and pass the job
     # identifier (`JobId`) from the initial call to `StartFaceDetection`.
@@ -3444,15 +3484,16 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
-    # Starts the asynchronous tracking of persons in a stored video.
+    # Starts the asynchronous tracking of a person's path in a stored
+    # video.
     #
-    # Amazon Rekognition Video can track persons in a video stored in an
-    # Amazon S3 bucket. Use Video to specify the bucket name and the
-    # filename of the video. `StartPersonTracking` returns a job identifier
-    # (`JobId`) which you use to get the results of the operation. When
-    # label detection is finished, Amazon Rekognition publishes a completion
-    # status to the Amazon Simple Notification Service topic that you
-    # specify in `NotificationChannel`.
+    # Amazon Rekognition Video can track the path of people in a video
+    # stored in an Amazon S3 bucket. Use Video to specify the bucket name
+    # and the filename of the video. `StartPersonTracking` returns a job
+    # identifier (`JobId`) which you use to get the results of the
+    # operation. When label detection is finished, Amazon Rekognition
+    # publishes a completion status to the Amazon Simple Notification
+    # Service topic that you specify in `NotificationChannel`.
     #
     # To get the results of the person detection operation, first check that
     # the status value published to the Amazon SNS topic is `SUCCEEDED`. If
@@ -3566,7 +3607,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.13.0'
+      context[:gem_version] = '1.14.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -110,6 +110,8 @@ module Aws::Rekognition
     ImageTooLargeException = Shapes::StructureShape.new(name: 'ImageTooLargeException')
     IndexFacesRequest = Shapes::StructureShape.new(name: 'IndexFacesRequest')
     IndexFacesResponse = Shapes::StructureShape.new(name: 'IndexFacesResponse')
+    Instance = Shapes::StructureShape.new(name: 'Instance')
+    Instances = Shapes::ListShape.new(name: 'Instances')
     InternalServerError = Shapes::StructureShape.new(name: 'InternalServerError')
     InvalidImageFormatException = Shapes::StructureShape.new(name: 'InvalidImageFormatException')
     InvalidPaginationTokenException = Shapes::StructureShape.new(name: 'InvalidPaginationTokenException')
@@ -147,6 +149,8 @@ module Aws::Rekognition
     OrientationCorrection = Shapes::StringShape.new(name: 'OrientationCorrection')
     PageSize = Shapes::IntegerShape.new(name: 'PageSize')
     PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
+    Parent = Shapes::StructureShape.new(name: 'Parent')
+    Parents = Shapes::ListShape.new(name: 'Parents')
     Percent = Shapes::FloatShape.new(name: 'Percent')
     PersonDetail = Shapes::StructureShape.new(name: 'PersonDetail')
     PersonDetection = Shapes::StructureShape.new(name: 'PersonDetection')
@@ -377,6 +381,7 @@ module Aws::Rekognition
 
     DetectLabelsResponse.add_member(:labels, Shapes::ShapeRef.new(shape: Labels, location_name: "Labels"))
     DetectLabelsResponse.add_member(:orientation_correction, Shapes::ShapeRef.new(shape: OrientationCorrection, location_name: "OrientationCorrection"))
+    DetectLabelsResponse.add_member(:label_model_version, Shapes::ShapeRef.new(shape: String, location_name: "LabelModelVersion"))
     DetectLabelsResponse.struct_class = Types::DetectLabelsResponse
 
     DetectModerationLabelsRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
@@ -574,6 +579,12 @@ module Aws::Rekognition
     IndexFacesResponse.add_member(:unindexed_faces, Shapes::ShapeRef.new(shape: UnindexedFaces, location_name: "UnindexedFaces"))
     IndexFacesResponse.struct_class = Types::IndexFacesResponse
 
+    Instance.add_member(:bounding_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "BoundingBox"))
+    Instance.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
+    Instance.struct_class = Types::Instance
+
+    Instances.member = Shapes::ShapeRef.new(shape: Instance)
+
     KinesisDataStream.add_member(:arn, Shapes::ShapeRef.new(shape: KinesisDataArn, location_name: "Arn"))
     KinesisDataStream.struct_class = Types::KinesisDataStream
 
@@ -582,6 +593,8 @@ module Aws::Rekognition
 
     Label.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
     Label.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
+    Label.add_member(:instances, Shapes::ShapeRef.new(shape: Instances, location_name: "Instances"))
+    Label.add_member(:parents, Shapes::ShapeRef.new(shape: Parents, location_name: "Parents"))
     Label.struct_class = Types::Label
 
     LabelDetection.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
@@ -645,6 +658,11 @@ module Aws::Rekognition
     NotificationChannel.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
     NotificationChannel.struct_class = Types::NotificationChannel
 
+    Parent.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
+    Parent.struct_class = Types::Parent
+
+    Parents.member = Shapes::ShapeRef.new(shape: Parent)
+
     PersonDetail.add_member(:index, Shapes::ShapeRef.new(shape: PersonIndex, location_name: "Index"))
     PersonDetail.add_member(:bounding_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "BoundingBox"))
     PersonDetail.add_member(:face, Shapes::ShapeRef.new(shape: FaceDetail, location_name: "Face"))

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

@@ -46,10 +46,10 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Identifies the bounding box around the 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, 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).
     #
     # The `top` and `left` values returned are ratios of the overall image
     # size. For example, if the input image is 700x200 pixels, and the
@@ -809,22 +809,31 @@ module Aws::Rekognition
     #   @return [Array<Types::Label>]
     #
     # @!attribute [rw] orientation_correction
-    #   The orientation of the input image (counter-clockwise direction). If
-    #   your application displays the image, you can use this value to
-    #   correct the orientation. If Amazon Rekognition detects that the
-    #   input image was rotated (for example, by 90 degrees), it first
-    #   corrects the orientation before detecting the labels.
+    #   The value of `OrientationCorrection` is always null.
     #
-    #   <note markdown="1"> If the input image Exif metadata populates the orientation field,
-    #   Amazon Rekognition does not perform orientation correction and the
-    #   value of OrientationCorrection will be null.
+    #   If the input image is in .jpeg format, it might contain exchangeable
+    #   image (Exif) metadata that includes the image's orientation. Amazon
+    #   Rekognition uses this orientation information to perform image
+    #   correction - the bounding box coordinates are translated to
+    #   represent object locations after the orientation information in the
+    #   Exif metadata is used to correct the image orientation. Images in
+    #   .png format don't contain Exif metadata.
     #
-    #    </note>
+    #   Amazon Rekognition doesn’t perform image correction for images in
+    #   .png format and .jpeg images without orientation information in the
+    #   image Exif metadata. The bounding box coordinates are not translated
+    #   and represent the object locations before the image is rotated.
+    #   @return [String]
+    #
+    # @!attribute [rw] label_model_version
+    #   Version number of the label detection model that was used to detect
+    #   labels.
     #   @return [String]
     #
     class DetectLabelsResponse < Struct.new(
       :labels,
-      :orientation_correction)
+      :orientation_correction,
+      :label_model_version)
       include Aws::Structure
     end
 
@@ -1211,7 +1220,7 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Information about where text detected by is located on an image.
+    # Information about where the text detected by is located on an image.
     #
     # @!attribute [rw] bounding_box
     #   An axis-aligned coarse representation of the detected text's
@@ -1720,9 +1729,9 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] persons
-    #   An array of the persons detected in the video and the times they are
-    #   tracked throughout the video. An array element will exist for each
-    #   time the person is tracked.
+    #   An array of the persons detected in the video and the time(s) their
+    #   path was tracked throughout the video. An array element will exist
+    #   for each time a person's path is tracked.
     #   @return [Array<Types::PersonDetection>]
     #
     class GetPersonTrackingResponse < Struct.new(
@@ -1947,6 +1956,23 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # An instance of a label detected by .
+    #
+    # @!attribute [rw] bounding_box
+    #   The position of the label instance on the image.
+    #   @return [Types::BoundingBox]
+    #
+    # @!attribute [rw] confidence
+    #   The confidence that Amazon Rekognition Image has in the accuracy of
+    #   the bounding box.
+    #   @return [Float]
+    #
+    class Instance < Struct.new(
+      :bounding_box,
+      :confidence)
+      include Aws::Structure
+    end
+
     # The Kinesis data stream Amazon Rekognition to which the analysis
     # results of a Amazon Rekognition stream processor are streamed. For
     # more information, see CreateStreamProcessor in the Amazon Rekognition
@@ -1989,20 +2015,52 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Structure containing details about the detected label, including name,
-    # and level of confidence.
+    # Structure containing details about the detected label, including the
+    # name, and level of confidence.
+    #
+    # The Amazon Rekognition Image operation operation returns a
+    # hierarchical taxonomy (`Parents`) for detected labels and also
+    # bounding box information (`Instances`) for detected labels. Amazon
+    # Rekognition Video doesn't return this information and returns `null`
+    # for the `Parents` and `Instances` attributes.
     #
     # @!attribute [rw] name
-    #   The name (label) of the object.
+    #   The name (label) of the object or scene.
     #   @return [String]
     #
     # @!attribute [rw] confidence
     #   Level of confidence.
     #   @return [Float]
     #
+    # @!attribute [rw] instances
+    #   If `Label` represents an object, `Instances` contains the bounding
+    #   boxes for each instance of the detected object. Bounding boxes are
+    #   returned for common object labels such as people, cars, furniture,
+    #   apparel or pets.
+    #
+    #   <note markdown="1"> Amazon Rekognition Video does not support bounding box information
+    #   for detected labels. The value of `Instances` is returned as `null`
+    #   by `GetLabelDetection`.
+    #
+    #    </note>
+    #   @return [Array<Types::Instance>]
+    #
+    # @!attribute [rw] parents
+    #   The parent labels for a label. The response includes all ancestor
+    #   labels.
+    #
+    #   <note markdown="1"> Amazon Rekognition Video does not support a hierarchical taxonomy of
+    #   detected labels. The value of `Parents` is returned as `null` by
+    #   `GetLabelDetection`.
+    #
+    #    </note>
+    #   @return [Array<Types::Parent>]
+    #
     class Label < Struct.new(
       :name,
-      :confidence)
+      :confidence,
+      :instances,
+      :parents)
       include Aws::Structure
     end
 
@@ -2285,6 +2343,17 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # A parent label for a label. A label can have 0, 1, or more parents.
+    #
+    # @!attribute [rw] name
+    #   The name of the parent label.
+    #   @return [String]
+    #
+    class Parent < Struct.new(
+      :name)
+      include Aws::Structure
+    end
+
     # Details about a person detected in a video analysis request.
     #
     # @!attribute [rw] index
@@ -2308,21 +2377,21 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Details and tracking information for a single time a person is tracked
-    # in a video. Amazon Rekognition operations that track persons return an
-    # array of `PersonDetection` objects with elements for each time a
-    # person is tracked in a video.
+    # Details and path tracking information for a single time a person's
+    # path is tracked in a video. Amazon Rekognition operations that track
+    # people's paths return an array of `PersonDetection` objects with
+    # elements for each time a person's path is tracked in a video.
     #
     # For more information, see API\_GetPersonTracking in the Amazon
     # Rekognition Developer Guide.
     #
     # @!attribute [rw] timestamp
     #   The time, in milliseconds from the start of the video, that the
-    #   person was tracked.
+    #   person's path was tracked.
     #   @return [Integer]
     #
     # @!attribute [rw] person
-    #   Details about a person tracked in a video.
+    #   Details about a person whose path was tracked in a video.
     #   @return [Types::PersonDetail]
     #
     class PersonDetection < Struct.new(
@@ -2742,7 +2811,9 @@ module Aws::Rekognition
     #   how certain Amazon Rekognition is that the moderated content is
     #   correctly identified. 0 is the lowest confidence. 100 is the highest
     #   confidence. Amazon Rekognition doesn't return any moderated content
-    #   labels with a confidence level lower than this specified value.
+    #   labels with a confidence level lower than this specified value. If
+    #   you don't specify `MinConfidence`, `GetContentModeration` returns
+    #   labels with confidence values greater than or equal to 50 percent.
     #   @return [Float]
     #
     # @!attribute [rw] client_request_token

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core