aws-sdk-rekognition 1.80.0 → 1.82.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -51,6 +51,81 @@ module Aws::Rekognition
51
51
  include Aws::Structure
52
52
  end
53
53
 
54
+ # @!attribute [rw] collection_id
55
+ # The ID of an existing collection containing the UserID.
56
+ # @return [String]
57
+ #
58
+ # @!attribute [rw] user_id
59
+ # The ID for the existing UserID.
60
+ # @return [String]
61
+ #
62
+ # @!attribute [rw] face_ids
63
+ # An array of FaceIDs to associate with the UserID.
64
+ # @return [Array<String>]
65
+ #
66
+ # @!attribute [rw] user_match_threshold
67
+ # An optional value specifying the minimum confidence in the UserID
68
+ # match to return. The default value is 75.
69
+ # @return [Float]
70
+ #
71
+ # @!attribute [rw] client_request_token
72
+ # Idempotent token used to identify the request to `AssociateFaces`.
73
+ # If you use the same token with multiple `AssociateFaces` requests,
74
+ # the same response is returned. Use ClientRequestToken to prevent the
75
+ # same request from being processed more than once.
76
+ #
77
+ # **A suitable default value is auto-generated.** You should normally
78
+ # not need to pass this option.
79
+ # @return [String]
80
+ #
81
+ class AssociateFacesRequest < Struct.new(
82
+ :collection_id,
83
+ :user_id,
84
+ :face_ids,
85
+ :user_match_threshold,
86
+ :client_request_token)
87
+ SENSITIVE = []
88
+ include Aws::Structure
89
+ end
90
+
91
+ # @!attribute [rw] associated_faces
92
+ # An array of AssociatedFace objects containing FaceIDs that are
93
+ # successfully associated with the UserID is returned. Returned if the
94
+ # AssociateFaces action is successful.
95
+ # @return [Array<Types::AssociatedFace>]
96
+ #
97
+ # @!attribute [rw] unsuccessful_face_associations
98
+ # An array of UnsuccessfulAssociation objects containing FaceIDs that
99
+ # are not successfully associated along with the reasons. Returned if
100
+ # the AssociateFaces action is successful.
101
+ # @return [Array<Types::UnsuccessfulFaceAssociation>]
102
+ #
103
+ # @!attribute [rw] user_status
104
+ # The status of an update made to a UserID. Reflects if the UserID has
105
+ # been updated for every requested change.
106
+ # @return [String]
107
+ #
108
+ class AssociateFacesResponse < Struct.new(
109
+ :associated_faces,
110
+ :unsuccessful_face_associations,
111
+ :user_status)
112
+ SENSITIVE = []
113
+ include Aws::Structure
114
+ end
115
+
116
+ # Provides face metadata for the faces that are associated to a specific
117
+ # UserID.
118
+ #
119
+ # @!attribute [rw] face_id
120
+ # Unique identifier assigned to the face.
121
+ # @return [String]
122
+ #
123
+ class AssociatedFace < Struct.new(
124
+ :face_id)
125
+ SENSITIVE = []
126
+ include Aws::Structure
127
+ end
128
+
54
129
  # Metadata information about an audio stream. An array of
55
130
  # `AudioMetadata` objects for the audio streams found in a stored video
56
131
  # is returned by GetSegmentDetection.
@@ -561,6 +636,11 @@ module Aws::Rekognition
561
636
  include Aws::Structure
562
637
  end
563
638
 
639
+ # A User with the same Id already exists within the collection, or the
640
+ # update or deletion of the User caused an inconsistent state. **
641
+ #
642
+ class ConflictException < Aws::EmptyStructure; end
643
+
564
644
  # Label detection settings to use on a streaming video. Defining the
565
645
  # settings is required in the request parameter for
566
646
  # CreateStreamProcessor. Including this setting in the
@@ -1092,6 +1172,36 @@ module Aws::Rekognition
1092
1172
  include Aws::Structure
1093
1173
  end
1094
1174
 
1175
+ # @!attribute [rw] collection_id
1176
+ # The ID of an existing collection to which the new UserID needs to be
1177
+ # created.
1178
+ # @return [String]
1179
+ #
1180
+ # @!attribute [rw] user_id
1181
+ # ID for the UserID to be created. This ID needs to be unique within
1182
+ # the collection.
1183
+ # @return [String]
1184
+ #
1185
+ # @!attribute [rw] client_request_token
1186
+ # Idempotent token used to identify the request to `CreateUser`. If
1187
+ # you use the same token with multiple `CreateUser` requests, the same
1188
+ # response is returned. Use ClientRequestToken to prevent the same
1189
+ # request from being processed more than once.
1190
+ #
1191
+ # **A suitable default value is auto-generated.** You should normally
1192
+ # not need to pass this option.
1193
+ # @return [String]
1194
+ #
1195
+ class CreateUserRequest < Struct.new(
1196
+ :collection_id,
1197
+ :user_id,
1198
+ :client_request_token)
1199
+ SENSITIVE = []
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ class CreateUserResponse < Aws::EmptyStructure; end
1204
+
1095
1205
  # A custom label detected in an image by a call to DetectCustomLabels.
1096
1206
  #
1097
1207
  # @!attribute [rw] name
@@ -1379,8 +1489,13 @@ module Aws::Rekognition
1379
1489
  # An array of strings (face IDs) of the faces that were deleted.
1380
1490
  # @return [Array<String>]
1381
1491
  #
1492
+ # @!attribute [rw] unsuccessful_face_deletions
1493
+ # An array of any faces that weren't deleted.
1494
+ # @return [Array<Types::UnsuccessfulFaceDeletion>]
1495
+ #
1382
1496
  class DeleteFacesResponse < Struct.new(
1383
- :deleted_faces)
1497
+ :deleted_faces,
1498
+ :unsuccessful_face_deletions)
1384
1499
  SENSITIVE = []
1385
1500
  include Aws::Structure
1386
1501
  end
@@ -1462,6 +1577,35 @@ module Aws::Rekognition
1462
1577
 
1463
1578
  class DeleteStreamProcessorResponse < Aws::EmptyStructure; end
1464
1579
 
1580
+ # @!attribute [rw] collection_id
1581
+ # The ID of an existing collection from which the UserID needs to be
1582
+ # deleted.
1583
+ # @return [String]
1584
+ #
1585
+ # @!attribute [rw] user_id
1586
+ # ID for the UserID to be deleted.
1587
+ # @return [String]
1588
+ #
1589
+ # @!attribute [rw] client_request_token
1590
+ # Idempotent token used to identify the request to `DeleteUser`. If
1591
+ # you use the same token with multiple `DeleteUser `requests, the same
1592
+ # response is returned. Use ClientRequestToken to prevent the same
1593
+ # request from being processed more than once.
1594
+ #
1595
+ # **A suitable default value is auto-generated.** You should normally
1596
+ # not need to pass this option.
1597
+ # @return [String]
1598
+ #
1599
+ class DeleteUserRequest < Struct.new(
1600
+ :collection_id,
1601
+ :user_id,
1602
+ :client_request_token)
1603
+ SENSITIVE = []
1604
+ include Aws::Structure
1605
+ end
1606
+
1607
+ class DeleteUserResponse < Aws::EmptyStructure; end
1608
+
1465
1609
  # @!attribute [rw] collection_id
1466
1610
  # The ID of the collection to describe.
1467
1611
  # @return [String]
@@ -1495,11 +1639,16 @@ module Aws::Rekognition
1495
1639
  # Coordinated Universal Time (UTC), Thursday, 1 January 1970.
1496
1640
  # @return [Time]
1497
1641
  #
1642
+ # @!attribute [rw] user_count
1643
+ # The number of UserIDs assigned to the specified colleciton.
1644
+ # @return [Integer]
1645
+ #
1498
1646
  class DescribeCollectionResponse < Struct.new(
1499
1647
  :face_count,
1500
1648
  :face_model_version,
1501
1649
  :collection_arn,
1502
- :creation_timestamp)
1650
+ :creation_timestamp,
1651
+ :user_count)
1503
1652
  SENSITIVE = []
1504
1653
  include Aws::Structure
1505
1654
  end
@@ -2290,6 +2439,77 @@ module Aws::Rekognition
2290
2439
  include Aws::Structure
2291
2440
  end
2292
2441
 
2442
+ # @!attribute [rw] collection_id
2443
+ # The ID of an existing collection containing the UserID.
2444
+ # @return [String]
2445
+ #
2446
+ # @!attribute [rw] user_id
2447
+ # ID for the existing UserID.
2448
+ # @return [String]
2449
+ #
2450
+ # @!attribute [rw] client_request_token
2451
+ # Idempotent token used to identify the request to
2452
+ # `DisassociateFaces`. If you use the same token with multiple
2453
+ # `DisassociateFaces` requests, the same response is returned. Use
2454
+ # ClientRequestToken to prevent the same request from being processed
2455
+ # more than once.
2456
+ #
2457
+ # **A suitable default value is auto-generated.** You should normally
2458
+ # not need to pass this option.
2459
+ # @return [String]
2460
+ #
2461
+ # @!attribute [rw] face_ids
2462
+ # An array of face IDs to disassociate from the UserID.
2463
+ # @return [Array<String>]
2464
+ #
2465
+ class DisassociateFacesRequest < Struct.new(
2466
+ :collection_id,
2467
+ :user_id,
2468
+ :client_request_token,
2469
+ :face_ids)
2470
+ SENSITIVE = []
2471
+ include Aws::Structure
2472
+ end
2473
+
2474
+ # @!attribute [rw] disassociated_faces
2475
+ # An array of DissociatedFace objects containing FaceIds that are
2476
+ # successfully disassociated with the UserID is returned. Returned if
2477
+ # the DisassociatedFaces action is successful.
2478
+ # @return [Array<Types::DisassociatedFace>]
2479
+ #
2480
+ # @!attribute [rw] unsuccessful_face_disassociations
2481
+ # An array of UnsuccessfulDisassociation objects containing FaceIds
2482
+ # that are not successfully associated, along with the reasons for the
2483
+ # failure to associate. Returned if the DisassociateFaces action is
2484
+ # successful.
2485
+ # @return [Array<Types::UnsuccessfulFaceDisassociation>]
2486
+ #
2487
+ # @!attribute [rw] user_status
2488
+ # The status of an update made to a User. Reflects if the User has
2489
+ # been updated for every requested change.
2490
+ # @return [String]
2491
+ #
2492
+ class DisassociateFacesResponse < Struct.new(
2493
+ :disassociated_faces,
2494
+ :unsuccessful_face_disassociations,
2495
+ :user_status)
2496
+ SENSITIVE = []
2497
+ include Aws::Structure
2498
+ end
2499
+
2500
+ # Provides face metadata for the faces that are disassociated from a
2501
+ # specific UserID.
2502
+ #
2503
+ # @!attribute [rw] face_id
2504
+ # Unique identifier assigned to the face.
2505
+ # @return [String]
2506
+ #
2507
+ class DisassociatedFace < Struct.new(
2508
+ :face_id)
2509
+ SENSITIVE = []
2510
+ include Aws::Structure
2511
+ end
2512
+
2293
2513
  # A training dataset or a test dataset used in a dataset distribution
2294
2514
  # operation. For more information, see DistributeDatasetEntries.
2295
2515
  #
@@ -2522,13 +2742,18 @@ module Aws::Rekognition
2522
2742
  # indexing the face vector.
2523
2743
  # @return [String]
2524
2744
  #
2745
+ # @!attribute [rw] user_id
2746
+ # Unique identifier assigned to the user.
2747
+ # @return [String]
2748
+ #
2525
2749
  class Face < Struct.new(
2526
2750
  :face_id,
2527
2751
  :bounding_box,
2528
2752
  :image_id,
2529
2753
  :external_image_id,
2530
2754
  :confidence,
2531
- :index_faces_model_version)
2755
+ :index_faces_model_version,
2756
+ :user_id)
2532
2757
  SENSITIVE = []
2533
2758
  include Aws::Structure
2534
2759
  end
@@ -4585,10 +4810,20 @@ module Aws::Rekognition
4585
4810
  # Maximum number of faces to return.
4586
4811
  # @return [Integer]
4587
4812
  #
4813
+ # @!attribute [rw] user_id
4814
+ # An array of user IDs to match when listing faces in a collection.
4815
+ # @return [String]
4816
+ #
4817
+ # @!attribute [rw] face_ids
4818
+ # An array of face IDs to match when listing faces in a collection.
4819
+ # @return [Array<String>]
4820
+ #
4588
4821
  class ListFacesRequest < Struct.new(
4589
4822
  :collection_id,
4590
4823
  :next_token,
4591
- :max_results)
4824
+ :max_results,
4825
+ :user_id,
4826
+ :face_ids)
4592
4827
  SENSITIVE = []
4593
4828
  include Aws::Structure
4594
4829
  end
@@ -4716,6 +4951,42 @@ module Aws::Rekognition
4716
4951
  include Aws::Structure
4717
4952
  end
4718
4953
 
4954
+ # @!attribute [rw] collection_id
4955
+ # The ID of an existing collection.
4956
+ # @return [String]
4957
+ #
4958
+ # @!attribute [rw] max_results
4959
+ # Maximum number of UsersID to return.
4960
+ # @return [Integer]
4961
+ #
4962
+ # @!attribute [rw] next_token
4963
+ # Pagingation token to receive the next set of UsersID.
4964
+ # @return [String]
4965
+ #
4966
+ class ListUsersRequest < Struct.new(
4967
+ :collection_id,
4968
+ :max_results,
4969
+ :next_token)
4970
+ SENSITIVE = []
4971
+ include Aws::Structure
4972
+ end
4973
+
4974
+ # @!attribute [rw] users
4975
+ # List of UsersID associated with the specified collection.
4976
+ # @return [Array<Types::User>]
4977
+ #
4978
+ # @!attribute [rw] next_token
4979
+ # A pagination token to be used with the subsequent request if the
4980
+ # response is truncated.
4981
+ # @return [String]
4982
+ #
4983
+ class ListUsersResponse < Struct.new(
4984
+ :users,
4985
+ :next_token)
4986
+ SENSITIVE = []
4987
+ include Aws::Structure
4988
+ end
4989
+
4719
4990
  # Contains settings that specify the location of an Amazon S3 bucket
4720
4991
  # used to store the output of a Face Liveness session. Note that the S3
4721
4992
  # bucket must be located in the caller's AWS account and in the same
@@ -4744,6 +5015,23 @@ module Aws::Rekognition
4744
5015
  #
4745
5016
  class MalformedPolicyDocumentException < Aws::EmptyStructure; end
4746
5017
 
5018
+ # Contains metadata for a UserID matched with a given face.
5019
+ #
5020
+ # @!attribute [rw] user_id
5021
+ # A provided ID for the UserID. Unique within the collection.
5022
+ # @return [String]
5023
+ #
5024
+ # @!attribute [rw] user_status
5025
+ # The status of the user matched to a provided FaceID.
5026
+ # @return [String]
5027
+ #
5028
+ class MatchedUser < Struct.new(
5029
+ :user_id,
5030
+ :user_status)
5031
+ SENSITIVE = []
5032
+ include Aws::Structure
5033
+ end
5034
+
4747
5035
  # Provides information about a single type of inappropriate, unwanted,
4748
5036
  # or offensive content found in an image or video. Each type of
4749
5037
  # moderated content has a label within a hierarchical taxonomy. For more
@@ -5653,6 +5941,224 @@ module Aws::Rekognition
5653
5941
  include Aws::Structure
5654
5942
  end
5655
5943
 
5944
+ # @!attribute [rw] collection_id
5945
+ # The ID of an existing collection containing the UserID.
5946
+ # @return [String]
5947
+ #
5948
+ # @!attribute [rw] image
5949
+ # Provides the input image either as bytes or an S3 object.
5950
+ #
5951
+ # You pass image bytes to an Amazon Rekognition API operation by using
5952
+ # the `Bytes` property. For example, you would use the `Bytes`
5953
+ # property to pass an image loaded from a local file system. Image
5954
+ # bytes passed by using the `Bytes` property must be base64-encoded.
5955
+ # Your code may not need to encode image bytes if you are using an AWS
5956
+ # SDK to call Amazon Rekognition API operations.
5957
+ #
5958
+ # For more information, see Analyzing an Image Loaded from a Local
5959
+ # File System in the Amazon Rekognition Developer Guide.
5960
+ #
5961
+ # You pass images stored in an S3 bucket to an Amazon Rekognition API
5962
+ # operation by using the `S3Object` property. Images stored in an S3
5963
+ # bucket do not need to be base64-encoded.
5964
+ #
5965
+ # The region for the S3 bucket containing the S3 object must match the
5966
+ # region you use for Amazon Rekognition operations.
5967
+ #
5968
+ # If you use the AWS CLI to call Amazon Rekognition operations,
5969
+ # passing image bytes using the Bytes property is not supported. You
5970
+ # must first upload the image to an Amazon S3 bucket and then call the
5971
+ # operation using the S3Object property.
5972
+ #
5973
+ # For Amazon Rekognition to process an S3 object, the user must have
5974
+ # permission to access the S3 object. For more information, see How
5975
+ # Amazon Rekognition works with IAM in the Amazon Rekognition
5976
+ # Developer Guide.
5977
+ # @return [Types::Image]
5978
+ #
5979
+ # @!attribute [rw] user_match_threshold
5980
+ # Specifies the minimum confidence in the UserID match to return.
5981
+ # Default value is 80.
5982
+ # @return [Float]
5983
+ #
5984
+ # @!attribute [rw] max_users
5985
+ # Maximum number of UserIDs to return.
5986
+ # @return [Integer]
5987
+ #
5988
+ # @!attribute [rw] quality_filter
5989
+ # A filter that specifies a quality bar for how much filtering is done
5990
+ # to identify faces. Filtered faces aren't searched for in the
5991
+ # collection. The default value is NONE.
5992
+ # @return [String]
5993
+ #
5994
+ class SearchUsersByImageRequest < Struct.new(
5995
+ :collection_id,
5996
+ :image,
5997
+ :user_match_threshold,
5998
+ :max_users,
5999
+ :quality_filter)
6000
+ SENSITIVE = []
6001
+ include Aws::Structure
6002
+ end
6003
+
6004
+ # @!attribute [rw] user_matches
6005
+ # An array of UserID objects that matched the input face, along with
6006
+ # the confidence in the match. The returned structure will be empty if
6007
+ # there are no matches. Returned if the SearchUsersByImageResponse
6008
+ # action is successful.
6009
+ # @return [Array<Types::UserMatch>]
6010
+ #
6011
+ # @!attribute [rw] face_model_version
6012
+ # Version number of the face detection model associated with the input
6013
+ # collection CollectionId.
6014
+ # @return [String]
6015
+ #
6016
+ # @!attribute [rw] searched_face
6017
+ # A list of FaceDetail objects containing the BoundingBox for the
6018
+ # largest face in image, as well as the confidence in the bounding
6019
+ # box, that was searched for matches. If no valid face is detected in
6020
+ # the image the response will contain no SearchedFace object.
6021
+ # @return [Types::SearchedFaceDetails]
6022
+ #
6023
+ # @!attribute [rw] unsearched_faces
6024
+ # List of UnsearchedFace objects. Contains the face details infered
6025
+ # from the specified image but not used for search. Contains reasons
6026
+ # that describe why a face wasn't used for Search.
6027
+ # @return [Array<Types::UnsearchedFace>]
6028
+ #
6029
+ class SearchUsersByImageResponse < Struct.new(
6030
+ :user_matches,
6031
+ :face_model_version,
6032
+ :searched_face,
6033
+ :unsearched_faces)
6034
+ SENSITIVE = []
6035
+ include Aws::Structure
6036
+ end
6037
+
6038
+ # @!attribute [rw] collection_id
6039
+ # The ID of an existing collection containing the UserID, used with a
6040
+ # UserId or FaceId. If a FaceId is provided, UserId isn’t required to
6041
+ # be present in the Collection.
6042
+ # @return [String]
6043
+ #
6044
+ # @!attribute [rw] user_id
6045
+ # ID for the existing User.
6046
+ # @return [String]
6047
+ #
6048
+ # @!attribute [rw] face_id
6049
+ # ID for the existing face.
6050
+ # @return [String]
6051
+ #
6052
+ # @!attribute [rw] user_match_threshold
6053
+ # Optional value that specifies the minimum confidence in the matched
6054
+ # UserID to return. Default value of 80.
6055
+ # @return [Float]
6056
+ #
6057
+ # @!attribute [rw] max_users
6058
+ # Maximum number of identities to return.
6059
+ # @return [Integer]
6060
+ #
6061
+ class SearchUsersRequest < Struct.new(
6062
+ :collection_id,
6063
+ :user_id,
6064
+ :face_id,
6065
+ :user_match_threshold,
6066
+ :max_users)
6067
+ SENSITIVE = []
6068
+ include Aws::Structure
6069
+ end
6070
+
6071
+ # @!attribute [rw] user_matches
6072
+ # An array of UserMatch objects that matched the input face along with
6073
+ # the confidence in the match. Array will be empty if there are no
6074
+ # matches.
6075
+ # @return [Array<Types::UserMatch>]
6076
+ #
6077
+ # @!attribute [rw] face_model_version
6078
+ # Version number of the face detection model associated with the input
6079
+ # CollectionId.
6080
+ # @return [String]
6081
+ #
6082
+ # @!attribute [rw] searched_face
6083
+ # Contains the ID of a face that was used to search for matches in a
6084
+ # collection.
6085
+ # @return [Types::SearchedFace]
6086
+ #
6087
+ # @!attribute [rw] searched_user
6088
+ # Contains the ID of the UserID that was used to search for matches in
6089
+ # a collection.
6090
+ # @return [Types::SearchedUser]
6091
+ #
6092
+ class SearchUsersResponse < Struct.new(
6093
+ :user_matches,
6094
+ :face_model_version,
6095
+ :searched_face,
6096
+ :searched_user)
6097
+ SENSITIVE = []
6098
+ include Aws::Structure
6099
+ end
6100
+
6101
+ # Provides face metadata such as FaceId, BoundingBox, Confidence of the
6102
+ # input face used for search.
6103
+ #
6104
+ # @!attribute [rw] face_id
6105
+ # Unique identifier assigned to the face.
6106
+ # @return [String]
6107
+ #
6108
+ class SearchedFace < Struct.new(
6109
+ :face_id)
6110
+ SENSITIVE = []
6111
+ include Aws::Structure
6112
+ end
6113
+
6114
+ # Contains data regarding the input face used for a search.
6115
+ #
6116
+ # @!attribute [rw] face_detail
6117
+ # Structure containing attributes of the face that the algorithm
6118
+ # detected.
6119
+ #
6120
+ # A `FaceDetail` object contains either the default facial attributes
6121
+ # or all facial attributes. The default attributes are `BoundingBox`,
6122
+ # `Confidence`, `Landmarks`, `Pose`, and `Quality`.
6123
+ #
6124
+ # GetFaceDetection is the only Amazon Rekognition Video stored video
6125
+ # operation that can return a `FaceDetail` object with all attributes.
6126
+ # To specify which attributes to return, use the `FaceAttributes`
6127
+ # input parameter for StartFaceDetection. The following Amazon
6128
+ # Rekognition Video operations return only the default attributes. The
6129
+ # corresponding Start operations don't have a `FaceAttributes` input
6130
+ # parameter:
6131
+ #
6132
+ # * GetCelebrityRecognition
6133
+ #
6134
+ # * GetPersonTracking
6135
+ #
6136
+ # * GetFaceSearch
6137
+ #
6138
+ # The Amazon Rekognition Image DetectFaces and IndexFaces operations
6139
+ # can return all facial attributes. To specify which attributes to
6140
+ # return, use the `Attributes` input parameter for `DetectFaces`. For
6141
+ # `IndexFaces`, use the `DetectAttributes` input parameter.
6142
+ # @return [Types::FaceDetail]
6143
+ #
6144
+ class SearchedFaceDetails < Struct.new(
6145
+ :face_detail)
6146
+ SENSITIVE = []
6147
+ include Aws::Structure
6148
+ end
6149
+
6150
+ # Contains metadata about a User searched for within a collection.
6151
+ #
6152
+ # @!attribute [rw] user_id
6153
+ # A provided ID for the UserID. Unique within the collection.
6154
+ # @return [String]
6155
+ #
6156
+ class SearchedUser < Struct.new(
6157
+ :user_id)
6158
+ SENSITIVE = []
6159
+ include Aws::Structure
6160
+ end
6161
+
5656
6162
  # A technical cue or shot detection segment detected in a video. An
5657
6163
  # array of `SegmentDetection` objects containing all segments detected
5658
6164
  # in a stored video is returned by GetSegmentDetection.
@@ -6944,6 +7450,125 @@ module Aws::Rekognition
6944
7450
  include Aws::Structure
6945
7451
  end
6946
7452
 
7453
+ # Face details inferred from the image but not used for search. The
7454
+ # response attribute contains reasons for why a face wasn't used for
7455
+ # Search.
7456
+ #
7457
+ # @!attribute [rw] face_details
7458
+ # Structure containing attributes of the face that the algorithm
7459
+ # detected.
7460
+ #
7461
+ # A `FaceDetail` object contains either the default facial attributes
7462
+ # or all facial attributes. The default attributes are `BoundingBox`,
7463
+ # `Confidence`, `Landmarks`, `Pose`, and `Quality`.
7464
+ #
7465
+ # GetFaceDetection is the only Amazon Rekognition Video stored video
7466
+ # operation that can return a `FaceDetail` object with all attributes.
7467
+ # To specify which attributes to return, use the `FaceAttributes`
7468
+ # input parameter for StartFaceDetection. The following Amazon
7469
+ # Rekognition Video operations return only the default attributes. The
7470
+ # corresponding Start operations don't have a `FaceAttributes` input
7471
+ # parameter:
7472
+ #
7473
+ # * GetCelebrityRecognition
7474
+ #
7475
+ # * GetPersonTracking
7476
+ #
7477
+ # * GetFaceSearch
7478
+ #
7479
+ # The Amazon Rekognition Image DetectFaces and IndexFaces operations
7480
+ # can return all facial attributes. To specify which attributes to
7481
+ # return, use the `Attributes` input parameter for `DetectFaces`. For
7482
+ # `IndexFaces`, use the `DetectAttributes` input parameter.
7483
+ # @return [Types::FaceDetail]
7484
+ #
7485
+ # @!attribute [rw] reasons
7486
+ # Reasons why a face wasn't used for Search.
7487
+ # @return [Array<String>]
7488
+ #
7489
+ class UnsearchedFace < Struct.new(
7490
+ :face_details,
7491
+ :reasons)
7492
+ SENSITIVE = []
7493
+ include Aws::Structure
7494
+ end
7495
+
7496
+ # Contains metadata like FaceId, UserID, and Reasons, for a face that
7497
+ # was unsuccessfully associated.
7498
+ #
7499
+ # @!attribute [rw] face_id
7500
+ # A unique identifier assigned to the face.
7501
+ # @return [String]
7502
+ #
7503
+ # @!attribute [rw] user_id
7504
+ # A provided ID for the UserID. Unique within the collection.
7505
+ # @return [String]
7506
+ #
7507
+ # @!attribute [rw] confidence
7508
+ # Match confidence with the UserID, provides information regarding if
7509
+ # a face association was unsuccessful because it didn't meet
7510
+ # UserMatchThreshold.
7511
+ # @return [Float]
7512
+ #
7513
+ # @!attribute [rw] reasons
7514
+ # The reason why the association was unsuccessful.
7515
+ # @return [Array<String>]
7516
+ #
7517
+ class UnsuccessfulFaceAssociation < Struct.new(
7518
+ :face_id,
7519
+ :user_id,
7520
+ :confidence,
7521
+ :reasons)
7522
+ SENSITIVE = []
7523
+ include Aws::Structure
7524
+ end
7525
+
7526
+ # Contains metadata like FaceId, UserID, and Reasons, for a face that
7527
+ # was unsuccessfully deleted.
7528
+ #
7529
+ # @!attribute [rw] face_id
7530
+ # A unique identifier assigned to the face.
7531
+ # @return [String]
7532
+ #
7533
+ # @!attribute [rw] user_id
7534
+ # A provided ID for the UserID. Unique within the collection.
7535
+ # @return [String]
7536
+ #
7537
+ # @!attribute [rw] reasons
7538
+ # The reason why the deletion was unsuccessful.
7539
+ # @return [Array<String>]
7540
+ #
7541
+ class UnsuccessfulFaceDeletion < Struct.new(
7542
+ :face_id,
7543
+ :user_id,
7544
+ :reasons)
7545
+ SENSITIVE = []
7546
+ include Aws::Structure
7547
+ end
7548
+
7549
+ # Contains metadata like FaceId, UserID, and Reasons, for a face that
7550
+ # was unsuccessfully disassociated.
7551
+ #
7552
+ # @!attribute [rw] face_id
7553
+ # A unique identifier assigned to the face.
7554
+ # @return [String]
7555
+ #
7556
+ # @!attribute [rw] user_id
7557
+ # A provided ID for the UserID. Unique within the collection.
7558
+ # @return [String]
7559
+ #
7560
+ # @!attribute [rw] reasons
7561
+ # The reason why the deletion was unsuccessful.
7562
+ # @return [Array<String>]
7563
+ #
7564
+ class UnsuccessfulFaceDisassociation < Struct.new(
7565
+ :face_id,
7566
+ :user_id,
7567
+ :reasons)
7568
+ SENSITIVE = []
7569
+ include Aws::Structure
7570
+ end
7571
+
6947
7572
  # @!attribute [rw] resource_arn
6948
7573
  # Amazon Resource Name (ARN) of the model, collection, or stream
6949
7574
  # processor that you want to remove the tags from.
@@ -7019,6 +7644,42 @@ module Aws::Rekognition
7019
7644
 
7020
7645
  class UpdateStreamProcessorResponse < Aws::EmptyStructure; end
7021
7646
 
7647
+ # Metadata of the user stored in a collection.
7648
+ #
7649
+ # @!attribute [rw] user_id
7650
+ # A provided ID for the User. Unique within the collection.
7651
+ # @return [String]
7652
+ #
7653
+ # @!attribute [rw] user_status
7654
+ # Communicates if the UserID has been updated with latest set of faces
7655
+ # to be associated with the UserID.
7656
+ # @return [String]
7657
+ #
7658
+ class User < Struct.new(
7659
+ :user_id,
7660
+ :user_status)
7661
+ SENSITIVE = []
7662
+ include Aws::Structure
7663
+ end
7664
+
7665
+ # Provides UserID metadata along with the confidence in the match of
7666
+ # this UserID with the input face.
7667
+ #
7668
+ # @!attribute [rw] similarity
7669
+ # Describes the UserID metadata.
7670
+ # @return [Float]
7671
+ #
7672
+ # @!attribute [rw] user
7673
+ # Confidence in the match of this UserID with the input face.
7674
+ # @return [Types::MatchedUser]
7675
+ #
7676
+ class UserMatch < Struct.new(
7677
+ :similarity,
7678
+ :user)
7679
+ SENSITIVE = []
7680
+ include Aws::Structure
7681
+ end
7682
+
7022
7683
  # Contains the Amazon S3 bucket location of the validation data for a
7023
7684
  # model training job.
7024
7685
  #