aws-sdk-rekognition 1.0.0.rc4 → 1.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3251495c163fec46733542c5afa712c300446873
-  data.tar.gz: b94bc747235917f87a110243dabd7ee692b8c9bd
+  metadata.gz: a69e8e4280cd0da712f034c5fc5395a84c2b4843
+  data.tar.gz: 2167f746687d49f12ce3ee69fb22080236cc36f3
 SHA512:
-  metadata.gz: a7839b56adaa603cc0b796460ca099a63b59aa81efd133604d076fb09f9a5fca3b26bd847b7472eaf45543113b7a91f3b0d3728ebb38787e41d4e02b01a1705e
-  data.tar.gz: 2a7c0a5ea99298f578ed235a6fb9e97482ca685d3fc6f4fc54cd7259d752cfb6f87a693c67acc8bd4de43825d1abdb0cff133389079bfe5a54e6e863a925cbd4
+  metadata.gz: a6861a56ae274bad133dd67a62b55d7378461b7fa24d0fc75e3213605620f8bff9863753e089c65771fe81922069052e8390e0c4a84216ef49b4b3e62a034a46
+  data.tar.gz: 4affdef535b7f6826de23f4847dddcb1938f7d759bdaa70bb513864628b6fc27dd66a5383a81d055856c284414158a7bd1810f4a825288d5d5d1b5da037a3974

data/lib/aws-sdk-rekognition.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.0.0.rc4'
+  GEM_VERSION = '1.0.0.rc5'
 
 end

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

@@ -18,6 +18,7 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
@@ -45,6 +46,7 @@ module Aws::Rekognition
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::JsonvalueConverter)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -378,14 +380,17 @@ module Aws::Rekognition
     #   an S3 object.
     #
     # @option params [Array<String>] :attributes
-    #   A list of facial attributes you would like to be returned. By default,
-    #   the API returns subset of facial attributes.
-    #
-    #   For example, you can specify the value as, \["ALL"\] or
-    #   \["DEFAULT"\]. If you provide both, \["ALL", "DEFAULT"\], the
-    #   service uses a logical AND operator to determine which attributes to
-    #   return (in this case, it is all attributes). If you specify all
-    #   attributes, Amazon Rekognition performs additional detection.
+    #   A list of facial attributes you want to be returned. This can be the
+    #   default list of attributes or all attributes. If you don't specify a
+    #   value for `Attributes` or if you specify `["DEFAULT"]`, the API
+    #   returns the following subset of facial attributes: `BoundingBox`,
+    #   `Confidence`, `Pose`, `Quality` and `Landmarks`. If you provide
+    #   `["ALL"]`, all facial attributes are returned but the operation will
+    #   take longer to complete.
+    #
+    #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a logical
+    #   AND operator to determine which attributes to return (in this case,
+    #   all attributes).
     #
     # @return [Types::DetectFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -518,7 +523,7 @@ module Aws::Rekognition
     #   Amazon Rekognition doesn't return any labels with confidence lower
     #   than this specified value.
     #
-    #   If `minConfidence` is not specified, the operation returns labels with
+    #   If `MinConfidence` is not specified, the operation returns labels with
     #   a confidence values greater than or equal to 50 percent.
     #
     # @return [Types::DetectLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -555,6 +560,74 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Detects explicit or suggestive adult content in a specified .jpeg or
+    # .png image. Use `DetectModerationLabels` to moderate images depending
+    # on your requirements. For example, you might want to filter images
+    # that contain nudity, but not images containing suggestive content.
+    #
+    # To filter images, use the labels returned by `DetectModerationLabels`
+    # to determine which types of content are appropriate. For information
+    # about moderation labels, see howitworks-moderateimage.
+    #
+    # @option params [required, Types::Image] :image
+    #   Provides the source image either as bytes or an S3 object.
+    #
+    #   The region for the S3 bucket containing the S3 object must match the
+    #   region you use for Amazon Rekognition operations.
+    #
+    #   You may need to Base64-encode the image bytes depending on the
+    #   language you are using and whether or not you are using the AWS SDK.
+    #   For more information, see example4.
+    #
+    #   If you use the Amazon CLI to call Amazon Rekognition operations,
+    #   passing image bytes using the Bytes property is not supported. You
+    #   must first upload the image to an Amazon S3 bucket and then call the
+    #   operation using the S3Object property.
+    #
+    #   For Amazon Rekognition to process an S3 object, the user must have
+    #   permission to access the S3 object. For more information, see
+    #   manage-access-resource-policies.
+    #
+    # @option params [Float] :min_confidence
+    #   Specifies the minimum confidence level for the labels to return.
+    #   Amazon Rekognition doesn't return any labels with a confidence level
+    #   lower than this specified value.
+    #
+    #   If you don't specify `MinConfidence`, the operation returns labels
+    #   with confidence values greater than or equal to 50 percent.
+    #
+    # @return [Types::DetectModerationLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DetectModerationLabelsResponse#moderation_labels #moderation_labels} => Array&lt;Types::ModerationLabel&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.detect_moderation_labels({
+    #     image: { # required
+    #       bytes: "data",
+    #       s3_object: {
+    #         bucket: "S3Bucket",
+    #         name: "S3ObjectName",
+    #         version: "S3ObjectVersion",
+    #       },
+    #     },
+    #     min_confidence: 1.0,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.moderation_labels #=> Array
+    #   resp.moderation_labels[0].confidence #=> Float
+    #   resp.moderation_labels[0].name #=> String
+    #   resp.moderation_labels[0].parent_name #=> String
+    #
+    # @overload detect_moderation_labels(params = {})
+    # @param [Hash] params ({})
+    def detect_moderation_labels(params = {}, options = {})
+      req = build_request(:detect_moderation_labels, params)
+      req.send_request(options)
+    end
+
     # Detects faces in the input image and adds them to the specified
     # collection.
     #
@@ -590,8 +663,8 @@ module Aws::Rekognition
     # `rekognition:IndexFaces` action.
     #
     # @option params [required, String] :collection_id
-    #   ID of an existing collection to which you want to add the faces that
-    #   are detected in the input images.
+    #   The ID of an existing collection to which you want to add the faces
+    #   that are detected in the input images.
     #
     # @option params [required, Types::Image] :image
     #   Provides the source image either as bytes or an S3 object.
@@ -616,15 +689,17 @@ module Aws::Rekognition
     #   ID you want to assign to all the faces detected in the image.
     #
     # @option params [Array<String>] :detection_attributes
-    #   (Optional) Returns detailed attributes of indexed faces. By default,
-    #   the operation returns a subset of the facial attributes.
-    #
-    #   For example, you can specify the value as, \["ALL"\] or
-    #   \["DEFAULT"\]. If you provide both, \["ALL", "DEFAULT"\], Amazon
-    #   Rekognition uses the logical AND operator to determine which
-    #   attributes to return (in this case, it is all attributes). If you
-    #   specify all attributes, the service performs additional detection, in
-    #   addition to the default.
+    #   A list of facial attributes that you want to be returned. This can be
+    #   the default list of attributes or all attributes. If you don't
+    #   specify a value for `Attributes` or if you specify `["DEFAULT"]`, the
+    #   API returns the following subset of facial attributes: `BoundingBox`,
+    #   `Confidence`, `Pose`, `Quality` and `Landmarks`. If you provide
+    #   `["ALL"]`, all facial attributes are returned but the operation will
+    #   take longer to complete.
+    #
+    #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a logical
+    #   AND operator to determine which attributes to return (in this case,
+    #   all attributes).
     #
     # @return [Types::IndexFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -988,7 +1063,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.0.0.rc4'
+      context[:gem_version] = '1.0.0.rc5'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -37,6 +37,8 @@ module Aws::Rekognition
     DetectFacesResponse = Shapes::StructureShape.new(name: 'DetectFacesResponse')
     DetectLabelsRequest = Shapes::StructureShape.new(name: 'DetectLabelsRequest')
     DetectLabelsResponse = Shapes::StructureShape.new(name: 'DetectLabelsResponse')
+    DetectModerationLabelsRequest = Shapes::StructureShape.new(name: 'DetectModerationLabelsRequest')
+    DetectModerationLabelsResponse = Shapes::StructureShape.new(name: 'DetectModerationLabelsResponse')
     Emotion = Shapes::StructureShape.new(name: 'Emotion')
     EmotionName = Shapes::StringShape.new(name: 'EmotionName')
     Emotions = Shapes::ListShape.new(name: 'Emotions')
@@ -78,6 +80,8 @@ module Aws::Rekognition
     ListFacesRequest = Shapes::StructureShape.new(name: 'ListFacesRequest')
     ListFacesResponse = Shapes::StructureShape.new(name: 'ListFacesResponse')
     MaxFaces = Shapes::IntegerShape.new(name: 'MaxFaces')
+    ModerationLabel = Shapes::StructureShape.new(name: 'ModerationLabel')
+    ModerationLabels = Shapes::ListShape.new(name: 'ModerationLabels')
     MouthOpen = Shapes::StructureShape.new(name: 'MouthOpen')
     Mustache = Shapes::StructureShape.new(name: 'Mustache')
     OrientationCorrection = Shapes::StringShape.new(name: 'OrientationCorrection')
@@ -180,6 +184,13 @@ module Aws::Rekognition
     DetectLabelsResponse.add_member(:orientation_correction, Shapes::ShapeRef.new(shape: OrientationCorrection, location_name: "OrientationCorrection"))
     DetectLabelsResponse.struct_class = Types::DetectLabelsResponse
 
+    DetectModerationLabelsRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
+    DetectModerationLabelsRequest.add_member(:min_confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "MinConfidence"))
+    DetectModerationLabelsRequest.struct_class = Types::DetectModerationLabelsRequest
+
+    DetectModerationLabelsResponse.add_member(:moderation_labels, Shapes::ShapeRef.new(shape: ModerationLabels, location_name: "ModerationLabels"))
+    DetectModerationLabelsResponse.struct_class = Types::DetectModerationLabelsResponse
+
     Emotion.add_member(:type, Shapes::ShapeRef.new(shape: EmotionName, location_name: "Type"))
     Emotion.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
     Emotion.struct_class = Types::Emotion
@@ -288,6 +299,13 @@ module Aws::Rekognition
     ListFacesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
     ListFacesResponse.struct_class = Types::ListFacesResponse
 
+    ModerationLabel.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
+    ModerationLabel.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
+    ModerationLabel.add_member(:parent_name, Shapes::ShapeRef.new(shape: String, location_name: "ParentName"))
+    ModerationLabel.struct_class = Types::ModerationLabel
+
+    ModerationLabels.member = Shapes::ShapeRef.new(shape: ModerationLabel)
+
     MouthOpen.add_member(:value, Shapes::ShapeRef.new(shape: Boolean, location_name: "Value"))
     MouthOpen.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
     MouthOpen.struct_class = Types::MouthOpen
@@ -440,6 +458,21 @@ module Aws::Rekognition
         o.errors << Shapes::ShapeRef.new(shape: InvalidImageFormatException)
       end)
 
+      api.add_operation(:detect_moderation_labels, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DetectModerationLabels"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DetectModerationLabelsRequest)
+        o.output = Shapes::ShapeRef.new(shape: DetectModerationLabelsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: ImageTooLargeException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
+      end)
+
       api.add_operation(:index_faces, Seahorse::Model::Operation.new.tap do |o|
         o.name = "IndexFaces"
         o.http_method = "POST"

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

@@ -367,14 +367,17 @@ module Aws::Rekognition
     #   @return [Types::Image]
     #
     # @!attribute [rw] attributes
-    #   A list of facial attributes you would like to be returned. By
-    #   default, the API returns subset of facial attributes.
-    #
-    #   For example, you can specify the value as, \["ALL"\] or
-    #   \["DEFAULT"\]. If you provide both, \["ALL", "DEFAULT"\], the
-    #   service uses a logical AND operator to determine which attributes to
-    #   return (in this case, it is all attributes). If you specify all
-    #   attributes, Amazon Rekognition performs additional detection.
+    #   A list of facial attributes you want to be returned. This can be the
+    #   default list of attributes or all attributes. If you don't specify
+    #   a value for `Attributes` or if you specify `["DEFAULT"]`, the API
+    #   returns the following subset of facial attributes: `BoundingBox`,
+    #   `Confidence`, `Pose`, `Quality` and `Landmarks`. If you provide
+    #   `["ALL"]`, all facial attributes are returned but the operation will
+    #   take longer to complete.
+    #
+    #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a
+    #   logical AND operator to determine which attributes to return (in
+    #   this case, all attributes).
     #   @return [Array<String>]
     #
     class DetectFacesRequest < Struct.new(
@@ -443,7 +446,7 @@ module Aws::Rekognition
     #   Amazon Rekognition doesn't return any labels with confidence lower
     #   than this specified value.
     #
-    #   If `minConfidence` is not specified, the operation returns labels
+    #   If `MinConfidence` is not specified, the operation returns labels
     #   with a confidence values greater than or equal to 50 percent.
     #   @return [Float]
     #
@@ -479,6 +482,68 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DetectModerationLabelsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         image: { # required
+    #           bytes: "data",
+    #           s3_object: {
+    #             bucket: "S3Bucket",
+    #             name: "S3ObjectName",
+    #             version: "S3ObjectVersion",
+    #           },
+    #         },
+    #         min_confidence: 1.0,
+    #       }
+    #
+    # @!attribute [rw] image
+    #   Provides the source image either as bytes or an S3 object.
+    #
+    #   The region for the S3 bucket containing the S3 object must match the
+    #   region you use for Amazon Rekognition operations.
+    #
+    #   You may need to Base64-encode the image bytes depending on the
+    #   language you are using and whether or not you are using the AWS SDK.
+    #   For more information, see example4.
+    #
+    #   If you use the Amazon CLI to call Amazon Rekognition operations,
+    #   passing image bytes using the Bytes property is not supported. You
+    #   must first upload the image to an Amazon S3 bucket and then call the
+    #   operation using the S3Object property.
+    #
+    #   For Amazon Rekognition to process an S3 object, the user must have
+    #   permission to access the S3 object. For more information, see
+    #   manage-access-resource-policies.
+    #   @return [Types::Image]
+    #
+    # @!attribute [rw] min_confidence
+    #   Specifies the minimum confidence level for the labels to return.
+    #   Amazon Rekognition doesn't return any labels with a confidence
+    #   level lower than this specified value.
+    #
+    #   If you don't specify `MinConfidence`, the operation returns labels
+    #   with confidence values greater than or equal to 50 percent.
+    #   @return [Float]
+    #
+    class DetectModerationLabelsRequest < Struct.new(
+      :image,
+      :min_confidence)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] moderation_labels
+    #   A list of labels for explicit or suggestive adult content found in
+    #   the image. The list includes the top-level label and each child
+    #   label detected in the image. This is useful for filtering specific
+    #   categories of content.
+    #   @return [Array<Types::ModerationLabel>]
+    #
+    class DetectModerationLabelsResponse < Struct.new(
+      :moderation_labels)
+      include Aws::Structure
+    end
+
     # The emotions detected on the face, and the confidence level in the
     # determination. For example, HAPPY, SAD, and ANGRY.
     #
@@ -781,15 +846,18 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Identifies image brightness and sharpness.
+    # Identifies face image brightness and sharpness.
     #
     # @!attribute [rw] brightness
     #   Value representing brightness of the face. The service returns a
-    #   value between 0 and 1 (inclusive).
+    #   value between 0 and 100 (inclusive). A higher value indicates a
+    #   brighter face image.
     #   @return [Float]
     #
     # @!attribute [rw] sharpness
-    #   Value representing sharpness of the face.
+    #   Value representing sharpness of the face. The service returns a
+    #   value between 0 and 100 (inclusive). A higher value indicates a
+    #   sharper face image.
     #   @return [Float]
     #
     class ImageQuality < Struct.new(
@@ -816,8 +884,8 @@ module Aws::Rekognition
     #       }
     #
     # @!attribute [rw] collection_id
-    #   ID of an existing collection to which you want to add the faces that
-    #   are detected in the input images.
+    #   The ID of an existing collection to which you want to add the faces
+    #   that are detected in the input images.
     #   @return [String]
     #
     # @!attribute [rw] image
@@ -845,15 +913,17 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] detection_attributes
-    #   (Optional) Returns detailed attributes of indexed faces. By default,
-    #   the operation returns a subset of the facial attributes.
-    #
-    #   For example, you can specify the value as, \["ALL"\] or
-    #   \["DEFAULT"\]. If you provide both, \["ALL", "DEFAULT"\],
-    #   Amazon Rekognition uses the logical AND operator to determine which
-    #   attributes to return (in this case, it is all attributes). If you
-    #   specify all attributes, the service performs additional detection,
-    #   in addition to the default.
+    #   A list of facial attributes that you want to be returned. This can
+    #   be the default list of attributes or all attributes. If you don't
+    #   specify a value for `Attributes` or if you specify `["DEFAULT"]`,
+    #   the API returns the following subset of facial attributes:
+    #   `BoundingBox`, `Confidence`, `Pose`, `Quality` and `Landmarks`. If
+    #   you provide `["ALL"]`, all facial attributes are returned but the
+    #   operation will take longer to complete.
+    #
+    #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a
+    #   logical AND operator to determine which attributes to return (in
+    #   this case, all attributes).
     #   @return [Array<String>]
     #
     class IndexFacesRequest < Struct.new(
@@ -1017,6 +1087,36 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # Provides information about a single type of moderated content found in
+    # an image. Each type of moderated content has a label within a
+    # hierarchical taxonomy. For more information, see
+    # howitworks-moderateimage.
+    #
+    # @!attribute [rw] confidence
+    #   Specifies the confidence that Amazon Rekognition has that the label
+    #   has been correctly identified.
+    #
+    #   If you don't specify the `MinConfidence` parameter in the call to
+    #   `DetectModerationLabels`, the operation returns labels with a
+    #   confidence value greater than or equal to 50 percent.
+    #   @return [Float]
+    #
+    # @!attribute [rw] name
+    #   The label name for the type of content detected in the image.
+    #   @return [String]
+    #
+    # @!attribute [rw] parent_name
+    #   The name for the parent label. Labels at the top-level of the
+    #   hierarchy have the parent label `""`.
+    #   @return [String]
+    #
+    class ModerationLabel < Struct.new(
+      :confidence,
+      :name,
+      :parent_name)
+      include Aws::Structure
+    end
+
     # Indicates whether or not the mouth on the face is open, and the
     # confidence level in the determination.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc4
+  version: 1.0.0.rc5
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core