@aws-sdk/client-rekognition 3.350.0 → 3.352.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/README.md +98 -7
  2. package/dist-cjs/Rekognition.js +14 -0
  3. package/dist-cjs/commands/AssociateFacesCommand.js +46 -0
  4. package/dist-cjs/commands/CreateUserCommand.js +46 -0
  5. package/dist-cjs/commands/DeleteUserCommand.js +46 -0
  6. package/dist-cjs/commands/DisassociateFacesCommand.js +46 -0
  7. package/dist-cjs/commands/ListUsersCommand.js +46 -0
  8. package/dist-cjs/commands/SearchUsersByImageCommand.js +46 -0
  9. package/dist-cjs/commands/SearchUsersCommand.js +46 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/models/models_0.js +159 -130
  12. package/dist-cjs/models/models_1.js +18 -1
  13. package/dist-cjs/pagination/ListUsersPaginator.js +29 -0
  14. package/dist-cjs/pagination/index.js +1 -0
  15. package/dist-cjs/protocols/Aws_json1_1.js +565 -4
  16. package/dist-es/Rekognition.js +14 -0
  17. package/dist-es/commands/AssociateFacesCommand.js +42 -0
  18. package/dist-es/commands/CreateUserCommand.js +42 -0
  19. package/dist-es/commands/DeleteUserCommand.js +42 -0
  20. package/dist-es/commands/DisassociateFacesCommand.js +42 -0
  21. package/dist-es/commands/ListUsersCommand.js +42 -0
  22. package/dist-es/commands/SearchUsersByImageCommand.js +42 -0
  23. package/dist-es/commands/SearchUsersCommand.js +42 -0
  24. package/dist-es/commands/index.js +7 -0
  25. package/dist-es/models/models_0.js +149 -120
  26. package/dist-es/models/models_1.js +16 -0
  27. package/dist-es/pagination/ListUsersPaginator.js +25 -0
  28. package/dist-es/pagination/index.js +1 -0
  29. package/dist-es/protocols/Aws_json1_1.js +548 -1
  30. package/dist-types/Rekognition.d.ts +84 -0
  31. package/dist-types/RekognitionClient.d.ts +44 -2
  32. package/dist-types/commands/AssociateFacesCommand.d.ts +203 -0
  33. package/dist-types/commands/CreateUserCommand.d.ts +126 -0
  34. package/dist-types/commands/DeleteFacesCommand.d.ts +9 -0
  35. package/dist-types/commands/DeleteUserCommand.d.ts +119 -0
  36. package/dist-types/commands/DescribeCollectionCommand.d.ts +1 -0
  37. package/dist-types/commands/DisassociateFacesCommand.d.ts +164 -0
  38. package/dist-types/commands/GetFaceSearchCommand.d.ts +1 -0
  39. package/dist-types/commands/IndexFacesCommand.d.ts +1 -0
  40. package/dist-types/commands/ListFacesCommand.d.ts +5 -0
  41. package/dist-types/commands/ListUsersCommand.d.ts +134 -0
  42. package/dist-types/commands/SearchFacesByImageCommand.d.ts +1 -0
  43. package/dist-types/commands/SearchFacesCommand.d.ts +1 -0
  44. package/dist-types/commands/SearchUsersByImageCommand.d.ts +366 -0
  45. package/dist-types/commands/SearchUsersCommand.d.ts +148 -0
  46. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +2 -1
  47. package/dist-types/commands/StartContentModerationCommand.d.ts +1 -1
  48. package/dist-types/commands/StartFaceDetectionCommand.d.ts +1 -1
  49. package/dist-types/commands/StartFaceSearchCommand.d.ts +1 -1
  50. package/dist-types/commands/StartLabelDetectionCommand.d.ts +1 -1
  51. package/dist-types/commands/StartPersonTrackingCommand.d.ts +1 -1
  52. package/dist-types/commands/StartProjectVersionCommand.d.ts +1 -1
  53. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +1 -1
  54. package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -1
  55. package/dist-types/commands/StartTextDetectionCommand.d.ts +1 -1
  56. package/dist-types/commands/StopProjectVersionCommand.d.ts +1 -1
  57. package/dist-types/commands/StopStreamProcessorCommand.d.ts +1 -1
  58. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  59. package/dist-types/commands/index.d.ts +7 -0
  60. package/dist-types/index.d.ts +35 -0
  61. package/dist-types/models/models_0.d.ts +668 -604
  62. package/dist-types/models/models_1.d.ts +562 -1
  63. package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
  64. package/dist-types/pagination/index.d.ts +1 -0
  65. package/dist-types/protocols/Aws_json1_1.d.ts +63 -0
  66. package/dist-types/ts3.4/Rekognition.d.ts +119 -0
  67. package/dist-types/ts3.4/RekognitionClient.d.ts +42 -0
  68. package/dist-types/ts3.4/commands/AssociateFacesCommand.d.ts +38 -0
  69. package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +35 -0
  70. package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +35 -0
  71. package/dist-types/ts3.4/commands/DisassociateFacesCommand.d.ts +39 -0
  72. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +35 -0
  73. package/dist-types/ts3.4/commands/SearchUsersByImageCommand.d.ts +39 -0
  74. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +35 -0
  75. package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +2 -4
  76. package/dist-types/ts3.4/commands/StartContentModerationCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/StartFaceDetectionCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/StartFaceSearchCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/StartLabelDetectionCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/StartPersonTrackingCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/StartProjectVersionCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/StartSegmentDetectionCommand.d.ts +1 -1
  83. package/dist-types/ts3.4/commands/StartStreamProcessorCommand.d.ts +1 -1
  84. package/dist-types/ts3.4/commands/StartTextDetectionCommand.d.ts +1 -1
  85. package/dist-types/ts3.4/commands/StopProjectVersionCommand.d.ts +1 -1
  86. package/dist-types/ts3.4/commands/StopStreamProcessorCommand.d.ts +1 -1
  87. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  88. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  89. package/dist-types/ts3.4/models/models_0.d.ts +236 -206
  90. package/dist-types/ts3.4/models/models_1.d.ts +150 -0
  91. package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  93. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +84 -0
  94. package/package.json +8 -6
@@ -0,0 +1,126 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateUserRequest, CreateUserResponse } from "../models/models_0";
5
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateUserCommand}.
14
+ */
15
+ export interface CreateUserCommandInput extends CreateUserRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateUserCommand}.
21
+ */
22
+ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Creates a new User within a collection specified by <code>CollectionId</code>. Takes
27
+ * <code>UserId</code> as a parameter, which is a user provided ID which should be unique
28
+ * within the collection. The provided <code>UserId</code> will alias the system generated
29
+ * UUID to make the <code>UserId</code> more user friendly. </p>
30
+ * <p>Uses a <code>ClientToken</code>, an idempotency token that ensures a call to
31
+ * <code>CreateUser</code> completes only once. If the value is not supplied, the AWS SDK
32
+ * generates an idempotency token for the requests. This prevents retries after a network
33
+ * error results from making multiple <code>CreateUser</code> calls. </p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { RekognitionClient, CreateUserCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
38
+ * // const { RekognitionClient, CreateUserCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
39
+ * const client = new RekognitionClient(config);
40
+ * const input = { // CreateUserRequest
41
+ * CollectionId: "STRING_VALUE", // required
42
+ * UserId: "STRING_VALUE", // required
43
+ * ClientRequestToken: "STRING_VALUE",
44
+ * };
45
+ * const command = new CreateUserCommand(input);
46
+ * const response = await client.send(command);
47
+ * // {};
48
+ *
49
+ * ```
50
+ *
51
+ * @param CreateUserCommandInput - {@link CreateUserCommandInput}
52
+ * @returns {@link CreateUserCommandOutput}
53
+ * @see {@link CreateUserCommandInput} for command's `input` shape.
54
+ * @see {@link CreateUserCommandOutput} for command's `response` shape.
55
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
56
+ *
57
+ * @throws {@link AccessDeniedException} (client fault)
58
+ * <p>You are not authorized to perform the action.</p>
59
+ *
60
+ * @throws {@link ConflictException} (client fault)
61
+ * <p>
62
+ * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
63
+ * </p>
64
+ *
65
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
66
+ * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
67
+ * parameters is different from the previous call to the operation.</p>
68
+ *
69
+ * @throws {@link InternalServerError} (server fault)
70
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
71
+ *
72
+ * @throws {@link InvalidParameterException} (client fault)
73
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
74
+ * operation again.</p>
75
+ *
76
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
77
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
78
+ * limit, contact Amazon Rekognition.</p>
79
+ *
80
+ * @throws {@link ResourceNotFoundException} (client fault)
81
+ * <p>The resource specified in the request cannot be found.</p>
82
+ *
83
+ * @throws {@link ServiceQuotaExceededException} (client fault)
84
+ * <p></p>
85
+ * <p>The size of the collection exceeds the allowed limit. For more information,
86
+ * see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
87
+ *
88
+ * @throws {@link ThrottlingException} (server fault)
89
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
90
+ *
91
+ * @throws {@link RekognitionServiceException}
92
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
93
+ *
94
+ * @example CreateUser
95
+ * ```javascript
96
+ * // Creates a new User within a collection specified by CollectionId.
97
+ * const input = {
98
+ * "CollectionId": "MyCollection",
99
+ * "UserId": "DemoUser"
100
+ * };
101
+ * const command = new CreateUserCommand(input);
102
+ * await client.send(command);
103
+ * // example id: createuser-1686181562299
104
+ * ```
105
+ *
106
+ */
107
+ export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, RekognitionClientResolvedConfig> {
108
+ readonly input: CreateUserCommandInput;
109
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
110
+ /**
111
+ * @public
112
+ */
113
+ constructor(input: CreateUserCommandInput);
114
+ /**
115
+ * @internal
116
+ */
117
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateUserCommandInput, CreateUserCommandOutput>;
118
+ /**
119
+ * @internal
120
+ */
121
+ private serialize;
122
+ /**
123
+ * @internal
124
+ */
125
+ private deserialize;
126
+ }
@@ -45,6 +45,15 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
45
45
  * // DeletedFaces: [ // FaceIdList
46
46
  * // "STRING_VALUE",
47
47
  * // ],
48
+ * // UnsuccessfulFaceDeletions: [ // UnsuccessfulFaceDeletionsList
49
+ * // { // UnsuccessfulFaceDeletion
50
+ * // FaceId: "STRING_VALUE",
51
+ * // UserId: "STRING_VALUE",
52
+ * // Reasons: [ // UnsuccessfulFaceDeletionReasons
53
+ * // "ASSOCIATED_TO_AN_EXISTING_USER" || "FACE_NOT_FOUND",
54
+ * // ],
55
+ * // },
56
+ * // ],
48
57
  * // };
49
58
  *
50
59
  * ```
@@ -0,0 +1,119 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DeleteUserRequest, DeleteUserResponse } from "../models/models_0";
5
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteUserCommand}.
14
+ */
15
+ export interface DeleteUserCommandInput extends DeleteUserRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteUserCommand}.
21
+ */
22
+ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes the specified UserID within the collection. Faces that are associated with the
27
+ * UserID are disassociated from the UserID before deleting the specified UserID. If the
28
+ * specified <code>Collection</code> or <code>UserID</code> is already deleted or not found, a
29
+ * <code>ResourceNotFoundException</code> will be thrown. If the action is successful with a
30
+ * 200 response, an empty HTTP body is returned. </p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { RekognitionClient, DeleteUserCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
35
+ * // const { RekognitionClient, DeleteUserCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
36
+ * const client = new RekognitionClient(config);
37
+ * const input = { // DeleteUserRequest
38
+ * CollectionId: "STRING_VALUE", // required
39
+ * UserId: "STRING_VALUE", // required
40
+ * ClientRequestToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new DeleteUserCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
49
+ * @returns {@link DeleteUserCommandOutput}
50
+ * @see {@link DeleteUserCommandInput} for command's `input` shape.
51
+ * @see {@link DeleteUserCommandOutput} for command's `response` shape.
52
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p>You are not authorized to perform the action.</p>
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>
59
+ * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
60
+ * </p>
61
+ *
62
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
63
+ * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
64
+ * parameters is different from the previous call to the operation.</p>
65
+ *
66
+ * @throws {@link InternalServerError} (server fault)
67
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
68
+ *
69
+ * @throws {@link InvalidParameterException} (client fault)
70
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
71
+ * operation again.</p>
72
+ *
73
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
74
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
75
+ * limit, contact Amazon Rekognition.</p>
76
+ *
77
+ * @throws {@link ResourceNotFoundException} (client fault)
78
+ * <p>The resource specified in the request cannot be found.</p>
79
+ *
80
+ * @throws {@link ThrottlingException} (server fault)
81
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
82
+ *
83
+ * @throws {@link RekognitionServiceException}
84
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
85
+ *
86
+ * @example DeleteUser
87
+ * ```javascript
88
+ * // Deletes the specified UserID within the collection.
89
+ * const input = {
90
+ * "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440001",
91
+ * "CollectionId": "MyCollection",
92
+ * "UserId": "DemoUser"
93
+ * };
94
+ * const command = new DeleteUserCommand(input);
95
+ * await client.send(command);
96
+ * // example id: deleteuser-1686181913475
97
+ * ```
98
+ *
99
+ */
100
+ export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, RekognitionClientResolvedConfig> {
101
+ readonly input: DeleteUserCommandInput;
102
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
103
+ /**
104
+ * @public
105
+ */
106
+ constructor(input: DeleteUserCommandInput);
107
+ /**
108
+ * @internal
109
+ */
110
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteUserCommandInput, DeleteUserCommandOutput>;
111
+ /**
112
+ * @internal
113
+ */
114
+ private serialize;
115
+ /**
116
+ * @internal
117
+ */
118
+ private deserialize;
119
+ }
@@ -44,6 +44,7 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
44
44
  * // FaceModelVersion: "STRING_VALUE",
45
45
  * // CollectionARN: "STRING_VALUE",
46
46
  * // CreationTimestamp: new Date("TIMESTAMP"),
47
+ * // UserCount: Number("long"),
47
48
  * // };
48
49
  *
49
50
  * ```
@@ -0,0 +1,164 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DisassociateFacesRequest, DisassociateFacesResponse } from "../models/models_0";
5
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DisassociateFacesCommand}.
14
+ */
15
+ export interface DisassociateFacesCommandInput extends DisassociateFacesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DisassociateFacesCommand}.
21
+ */
22
+ export interface DisassociateFacesCommandOutput extends DisassociateFacesResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Removes the association between a <code>Face</code> supplied in an array of
27
+ * <code>FaceIds</code> and the User. If the User is not present already, then a
28
+ * <code>ResourceNotFound</code> exception is thrown. If successful, an array of faces that are
29
+ * disassociated from the User is returned. If a given face is already disassociated from the
30
+ * given UserID, it will be ignored and not be returned in the response. If a given face is
31
+ * already associated with a different User or not found in the collection it will be returned as
32
+ * part of <code>UnsuccessfulDisassociations</code>. You can remove 1 - 100 face IDs from a user
33
+ * at one time.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { RekognitionClient, DisassociateFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
38
+ * // const { RekognitionClient, DisassociateFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
39
+ * const client = new RekognitionClient(config);
40
+ * const input = { // DisassociateFacesRequest
41
+ * CollectionId: "STRING_VALUE", // required
42
+ * UserId: "STRING_VALUE", // required
43
+ * ClientRequestToken: "STRING_VALUE",
44
+ * FaceIds: [ // UserFaceIdList // required
45
+ * "STRING_VALUE",
46
+ * ],
47
+ * };
48
+ * const command = new DisassociateFacesCommand(input);
49
+ * const response = await client.send(command);
50
+ * // { // DisassociateFacesResponse
51
+ * // DisassociatedFaces: [ // DisassociatedFacesList
52
+ * // { // DisassociatedFace
53
+ * // FaceId: "STRING_VALUE",
54
+ * // },
55
+ * // ],
56
+ * // UnsuccessfulFaceDisassociations: [ // UnsuccessfulFaceDisassociationList
57
+ * // { // UnsuccessfulFaceDisassociation
58
+ * // FaceId: "STRING_VALUE",
59
+ * // UserId: "STRING_VALUE",
60
+ * // Reasons: [ // UnsuccessfulFaceDisassociationReasons
61
+ * // "FACE_NOT_FOUND" || "ASSOCIATED_TO_A_DIFFERENT_USER",
62
+ * // ],
63
+ * // },
64
+ * // ],
65
+ * // UserStatus: "ACTIVE" || "UPDATING" || "CREATING" || "CREATED",
66
+ * // };
67
+ *
68
+ * ```
69
+ *
70
+ * @param DisassociateFacesCommandInput - {@link DisassociateFacesCommandInput}
71
+ * @returns {@link DisassociateFacesCommandOutput}
72
+ * @see {@link DisassociateFacesCommandInput} for command's `input` shape.
73
+ * @see {@link DisassociateFacesCommandOutput} for command's `response` shape.
74
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
75
+ *
76
+ * @throws {@link AccessDeniedException} (client fault)
77
+ * <p>You are not authorized to perform the action.</p>
78
+ *
79
+ * @throws {@link ConflictException} (client fault)
80
+ * <p>
81
+ * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
82
+ * </p>
83
+ *
84
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
85
+ * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
86
+ * parameters is different from the previous call to the operation.</p>
87
+ *
88
+ * @throws {@link InternalServerError} (server fault)
89
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
90
+ *
91
+ * @throws {@link InvalidParameterException} (client fault)
92
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
93
+ * operation again.</p>
94
+ *
95
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
96
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
97
+ * limit, contact Amazon Rekognition.</p>
98
+ *
99
+ * @throws {@link ResourceNotFoundException} (client fault)
100
+ * <p>The resource specified in the request cannot be found.</p>
101
+ *
102
+ * @throws {@link ThrottlingException} (server fault)
103
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
104
+ *
105
+ * @throws {@link RekognitionServiceException}
106
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
107
+ *
108
+ * @example DisassociateFaces
109
+ * ```javascript
110
+ * // Removes the association between a Face supplied in an array of FaceIds and the User.
111
+ * const input = {
112
+ * "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440003",
113
+ * "CollectionId": "MyCollection",
114
+ * "FaceIds": [
115
+ * "f5817d37-94f6-4335-bfee-6cf79a3d806e",
116
+ * "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
117
+ * ],
118
+ * "UserId": "DemoUser"
119
+ * };
120
+ * const command = new DisassociateFacesCommand(input);
121
+ * const response = await client.send(command);
122
+ * /* response ==
123
+ * {
124
+ * "DisassociatedFaces": [
125
+ * {
126
+ * "FaceId": "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
127
+ * }
128
+ * ],
129
+ * "UnsuccessfulFaceDisassociations": [
130
+ * {
131
+ * "FaceId": "f5817d37-94f6-4335-bfee-6cf79a3d806e",
132
+ * "Reasons": [
133
+ * "ASSOCIATED_TO_A_DIFFERENT_USER"
134
+ * ],
135
+ * "UserId": "demoUser1"
136
+ * }
137
+ * ],
138
+ * "UserStatus": "UPDATING"
139
+ * }
140
+ * *\/
141
+ * // example id: disassociatefaces-1686182627295
142
+ * ```
143
+ *
144
+ */
145
+ export declare class DisassociateFacesCommand extends $Command<DisassociateFacesCommandInput, DisassociateFacesCommandOutput, RekognitionClientResolvedConfig> {
146
+ readonly input: DisassociateFacesCommandInput;
147
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
148
+ /**
149
+ * @public
150
+ */
151
+ constructor(input: DisassociateFacesCommandInput);
152
+ /**
153
+ * @internal
154
+ */
155
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateFacesCommandInput, DisassociateFacesCommandOutput>;
156
+ /**
157
+ * @internal
158
+ */
159
+ private serialize;
160
+ /**
161
+ * @internal
162
+ */
163
+ private deserialize;
164
+ }
@@ -177,6 +177,7 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
177
177
  * // ExternalImageId: "STRING_VALUE",
178
178
  * // Confidence: Number("float"),
179
179
  * // IndexFacesModelVersion: "STRING_VALUE",
180
+ * // UserId: "STRING_VALUE",
180
181
  * // },
181
182
  * // },
182
183
  * // ],
@@ -156,6 +156,7 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
156
156
  * // ExternalImageId: "STRING_VALUE",
157
157
  * // Confidence: Number("float"),
158
158
  * // IndexFacesModelVersion: "STRING_VALUE",
159
+ * // UserId: "STRING_VALUE",
159
160
  * // },
160
161
  * // FaceDetail: { // FaceDetail
161
162
  * // BoundingBox: {
@@ -39,6 +39,10 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
39
39
  * CollectionId: "STRING_VALUE", // required
40
40
  * NextToken: "STRING_VALUE",
41
41
  * MaxResults: Number("int"),
42
+ * UserId: "STRING_VALUE",
43
+ * FaceIds: [ // FaceIdList
44
+ * "STRING_VALUE",
45
+ * ],
42
46
  * };
43
47
  * const command = new ListFacesCommand(input);
44
48
  * const response = await client.send(command);
@@ -56,6 +60,7 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
56
60
  * // ExternalImageId: "STRING_VALUE",
57
61
  * // Confidence: Number("float"),
58
62
  * // IndexFacesModelVersion: "STRING_VALUE",
63
+ * // UserId: "STRING_VALUE",
59
64
  * // },
60
65
  * // ],
61
66
  * // NextToken: "STRING_VALUE",
@@ -0,0 +1,134 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ListUsersRequest, ListUsersResponse } from "../models/models_0";
5
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListUsersCommand}.
14
+ */
15
+ export interface ListUsersCommandInput extends ListUsersRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListUsersCommand}.
21
+ */
22
+ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns metadata of the User such as <code>UserID</code> in the specified collection.
27
+ * Anonymous User (to reserve faces without any identity) is not returned as part of this
28
+ * request. The results are sorted by system generated primary key ID. If the response is
29
+ * truncated, <code>NextToken</code> is returned in the response that can be used in the
30
+ * subsequent request to retrieve the next set of identities.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { RekognitionClient, ListUsersCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
35
+ * // const { RekognitionClient, ListUsersCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
36
+ * const client = new RekognitionClient(config);
37
+ * const input = { // ListUsersRequest
38
+ * CollectionId: "STRING_VALUE", // required
39
+ * MaxResults: Number("int"),
40
+ * NextToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new ListUsersCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // ListUsersResponse
45
+ * // Users: [ // UserList
46
+ * // { // User
47
+ * // UserId: "STRING_VALUE",
48
+ * // UserStatus: "ACTIVE" || "UPDATING" || "CREATING" || "CREATED",
49
+ * // },
50
+ * // ],
51
+ * // NextToken: "STRING_VALUE",
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param ListUsersCommandInput - {@link ListUsersCommandInput}
57
+ * @returns {@link ListUsersCommandOutput}
58
+ * @see {@link ListUsersCommandInput} for command's `input` shape.
59
+ * @see {@link ListUsersCommandOutput} for command's `response` shape.
60
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
61
+ *
62
+ * @throws {@link AccessDeniedException} (client fault)
63
+ * <p>You are not authorized to perform the action.</p>
64
+ *
65
+ * @throws {@link InternalServerError} (server fault)
66
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
67
+ *
68
+ * @throws {@link InvalidPaginationTokenException} (client fault)
69
+ * <p>Pagination token in the request is not valid.</p>
70
+ *
71
+ * @throws {@link InvalidParameterException} (client fault)
72
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
73
+ * operation again.</p>
74
+ *
75
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
76
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
77
+ * limit, contact Amazon Rekognition.</p>
78
+ *
79
+ * @throws {@link ResourceNotFoundException} (client fault)
80
+ * <p>The resource specified in the request cannot be found.</p>
81
+ *
82
+ * @throws {@link ThrottlingException} (server fault)
83
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
84
+ *
85
+ * @throws {@link RekognitionServiceException}
86
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
87
+ *
88
+ * @example ListUsers
89
+ * ```javascript
90
+ * // Returns metadata of the User such as UserID in the specified collection.
91
+ * const input = {
92
+ * "CollectionId": "MyCollection"
93
+ * };
94
+ * const command = new ListUsersCommand(input);
95
+ * const response = await client.send(command);
96
+ * /* response ==
97
+ * {
98
+ * "NextToken": "MGYZLAHX1T5a....",
99
+ * "Users": [
100
+ * {
101
+ * "UserId": "demoUser4",
102
+ * "UserStatus": "CREATED"
103
+ * },
104
+ * {
105
+ * "UserId": "demoUser2",
106
+ * "UserStatus": "CREATED"
107
+ * }
108
+ * ]
109
+ * }
110
+ * *\/
111
+ * // example id: listusers-1686182360075
112
+ * ```
113
+ *
114
+ */
115
+ export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, RekognitionClientResolvedConfig> {
116
+ readonly input: ListUsersCommandInput;
117
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
118
+ /**
119
+ * @public
120
+ */
121
+ constructor(input: ListUsersCommandInput);
122
+ /**
123
+ * @internal
124
+ */
125
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListUsersCommandInput, ListUsersCommandOutput>;
126
+ /**
127
+ * @internal
128
+ */
129
+ private serialize;
130
+ /**
131
+ * @internal
132
+ */
133
+ private deserialize;
134
+ }
@@ -105,6 +105,7 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
105
105
  * // ExternalImageId: "STRING_VALUE",
106
106
  * // Confidence: Number("float"),
107
107
  * // IndexFacesModelVersion: "STRING_VALUE",
108
+ * // UserId: "STRING_VALUE",
108
109
  * // },
109
110
  * // },
110
111
  * // ],
@@ -70,6 +70,7 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
70
70
  * // ExternalImageId: "STRING_VALUE",
71
71
  * // Confidence: Number("float"),
72
72
  * // IndexFacesModelVersion: "STRING_VALUE",
73
+ * // UserId: "STRING_VALUE",
73
74
  * // },
74
75
  * // },
75
76
  * // ],