@aws-sdk/client-rekognition 3.350.0 → 3.351.0

package/dist-types/commands/DeleteUserCommand.d.ts

@@ -0,0 +1,106 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DeleteUserRequest, DeleteUserResponse } from "../models/models_0";
+import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteUserCommand}.
+ */
+export interface DeleteUserCommandInput extends DeleteUserRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteUserCommand}.
+ */
+export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes the specified UserID within the collection. Faces that are associated with the
+ *       UserID are disassociated from the UserID before deleting the specified UserID. If the
+ *       specified <code>Collection</code> or <code>UserID</code> is already deleted or not found, a
+ *         <code>ResourceNotFoundException</code> will be thrown. If the action is successful with a
+ *       200 response, an empty HTTP body is returned. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RekognitionClient, DeleteUserCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
+ * // const { RekognitionClient, DeleteUserCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
+ * const client = new RekognitionClient(config);
+ * const input = { // DeleteUserRequest
+ *   CollectionId: "STRING_VALUE", // required
+ *   UserId: "STRING_VALUE", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ * };
+ * const command = new DeleteUserCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
+ * @returns {@link DeleteUserCommandOutput}
+ * @see {@link DeleteUserCommandInput} for command's `input` shape.
+ * @see {@link DeleteUserCommandOutput} for command's `response` shape.
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You are not authorized to perform the action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>
+ *       A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
+ *     </p>
+ *
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
+ *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
+ *         parameters is different from the previous call to the operation.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>Input parameter violated a constraint. Validate your parameter before calling the API
+ *       operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this
+ *       limit, contact Amazon Rekognition.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link RekognitionServiceException}
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
+ *
+ */
+export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, RekognitionClientResolvedConfig> {
+    readonly input: DeleteUserCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteUserCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteUserCommandInput, DeleteUserCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/DescribeCollectionCommand.d.ts

@@ -44,6 +44,7 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
  * //   FaceModelVersion: "STRING_VALUE",
  * //   CollectionARN: "STRING_VALUE",
  * //   CreationTimestamp: new Date("TIMESTAMP"),
+ * //   UserCount: Number("long"),
  * // };
  *
  * ```

package/dist-types/commands/DisassociateFacesCommand.d.ts

@@ -0,0 +1,128 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DisassociateFacesRequest, DisassociateFacesResponse } from "../models/models_0";
+import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DisassociateFacesCommand}.
+ */
+export interface DisassociateFacesCommandInput extends DisassociateFacesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DisassociateFacesCommand}.
+ */
+export interface DisassociateFacesCommandOutput extends DisassociateFacesResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Removes the association between a <code>Face</code> supplied in an array of
+ *         <code>FaceIds</code> and the User. If the User is not present already, then a
+ *         <code>ResourceNotFound</code> exception is thrown. If successful, an array of faces that are
+ *       disassociated from the User is returned. If a given face is already disassociated from the
+ *       given UserID, it will be ignored and not be returned in the response. If a given face is
+ *       already associated with a different User or not found in the collection it will be returned as
+ *       part of <code>UnsuccessfulDisassociations</code>. You can remove 1 - 100 face IDs from a user
+ *       at one time.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RekognitionClient, DisassociateFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
+ * // const { RekognitionClient, DisassociateFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
+ * const client = new RekognitionClient(config);
+ * const input = { // DisassociateFacesRequest
+ *   CollectionId: "STRING_VALUE", // required
+ *   UserId: "STRING_VALUE", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ *   FaceIds: [ // UserFaceIdList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new DisassociateFacesCommand(input);
+ * const response = await client.send(command);
+ * // { // DisassociateFacesResponse
+ * //   DisassociatedFaces: [ // DisassociatedFacesList
+ * //     { // DisassociatedFace
+ * //       FaceId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   UnsuccessfulFaceDisassociations: [ // UnsuccessfulFaceDisassociationList
+ * //     { // UnsuccessfulFaceDisassociation
+ * //       FaceId: "STRING_VALUE",
+ * //       UserId: "STRING_VALUE",
+ * //       Reasons: [ // UnsuccessfulFaceDisassociationReasons
+ * //         "FACE_NOT_FOUND" || "ASSOCIATED_TO_A_DIFFERENT_USER",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   UserStatus: "ACTIVE" || "UPDATING" || "CREATING" || "CREATED",
+ * // };
+ *
+ * ```
+ *
+ * @param DisassociateFacesCommandInput - {@link DisassociateFacesCommandInput}
+ * @returns {@link DisassociateFacesCommandOutput}
+ * @see {@link DisassociateFacesCommandInput} for command's `input` shape.
+ * @see {@link DisassociateFacesCommandOutput} for command's `response` shape.
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You are not authorized to perform the action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>
+ *       A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
+ *     </p>
+ *
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
+ *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
+ *         parameters is different from the previous call to the operation.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>Input parameter violated a constraint. Validate your parameter before calling the API
+ *       operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this
+ *       limit, contact Amazon Rekognition.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link RekognitionServiceException}
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
+ *
+ */
+export declare class DisassociateFacesCommand extends $Command<DisassociateFacesCommandInput, DisassociateFacesCommandOutput, RekognitionClientResolvedConfig> {
+    readonly input: DisassociateFacesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DisassociateFacesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateFacesCommandInput, DisassociateFacesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/GetFaceSearchCommand.d.ts

@@ -177,6 +177,7 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
  * //             ExternalImageId: "STRING_VALUE",
  * //             Confidence: Number("float"),
  * //             IndexFacesModelVersion: "STRING_VALUE",
+ * //             UserId: "STRING_VALUE",
  * //           },
  * //         },
  * //       ],

package/dist-types/commands/IndexFacesCommand.d.ts

@@ -156,6 +156,7 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
  * //         ExternalImageId: "STRING_VALUE",
  * //         Confidence: Number("float"),
  * //         IndexFacesModelVersion: "STRING_VALUE",
+ * //         UserId: "STRING_VALUE",
  * //       },
  * //       FaceDetail: { // FaceDetail
  * //         BoundingBox: {

package/dist-types/commands/ListFacesCommand.d.ts

@@ -39,6 +39,10 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
  *   CollectionId: "STRING_VALUE", // required
  *   NextToken: "STRING_VALUE",
  *   MaxResults: Number("int"),
+ *   UserId: "STRING_VALUE",
+ *   FaceIds: [ // FaceIdList
+ *     "STRING_VALUE",
+ *   ],
  * };
  * const command = new ListFacesCommand(input);
  * const response = await client.send(command);
@@ -56,6 +60,7 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
  * //       ExternalImageId: "STRING_VALUE",
  * //       Confidence: Number("float"),
  * //       IndexFacesModelVersion: "STRING_VALUE",
+ * //       UserId: "STRING_VALUE",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

package/dist-types/commands/ListUsersCommand.d.ts

@@ -0,0 +1,108 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ListUsersRequest, ListUsersResponse } from "../models/models_0";
+import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListUsersCommand}.
+ */
+export interface ListUsersCommandInput extends ListUsersRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListUsersCommand}.
+ */
+export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns metadata of the User such as <code>UserID</code> in the specified collection.
+ *       Anonymous User (to reserve faces without any identity) is not returned as part of this
+ *       request. The results are sorted by system generated primary key ID. If the response is
+ *       truncated, <code>NextToken</code> is returned in the response that can be used in the
+ *       subsequent request to retrieve the next set of identities.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RekognitionClient, ListUsersCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
+ * // const { RekognitionClient, ListUsersCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
+ * const client = new RekognitionClient(config);
+ * const input = { // ListUsersRequest
+ *   CollectionId: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListUsersCommand(input);
+ * const response = await client.send(command);
+ * // { // ListUsersResponse
+ * //   Users: [ // UserList
+ * //     { // User
+ * //       UserId: "STRING_VALUE",
+ * //       UserStatus: "ACTIVE" || "UPDATING" || "CREATING" || "CREATED",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListUsersCommandInput - {@link ListUsersCommandInput}
+ * @returns {@link ListUsersCommandOutput}
+ * @see {@link ListUsersCommandInput} for command's `input` shape.
+ * @see {@link ListUsersCommandOutput} for command's `response` shape.
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You are not authorized to perform the action.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidPaginationTokenException} (client fault)
+ *  <p>Pagination token in the request is not valid.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>Input parameter violated a constraint. Validate your parameter before calling the API
+ *       operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this
+ *       limit, contact Amazon Rekognition.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link RekognitionServiceException}
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
+ *
+ */
+export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, RekognitionClientResolvedConfig> {
+    readonly input: ListUsersCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListUsersCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListUsersCommandInput, ListUsersCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/SearchFacesByImageCommand.d.ts

@@ -105,6 +105,7 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
  * //         ExternalImageId: "STRING_VALUE",
  * //         Confidence: Number("float"),
  * //         IndexFacesModelVersion: "STRING_VALUE",
+ * //         UserId: "STRING_VALUE",
  * //       },
  * //     },
  * //   ],

package/dist-types/commands/SearchFacesCommand.d.ts

@@ -70,6 +70,7 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
  * //         ExternalImageId: "STRING_VALUE",
  * //         Confidence: Number("float"),
  * //         IndexFacesModelVersion: "STRING_VALUE",
+ * //         UserId: "STRING_VALUE",
  * //       },
  * //     },
  * //   ],