/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the rekognition-2016-06-27.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Rekognition.Model; namespace Amazon.Rekognition { /// <summary> /// Interface for accessing Rekognition /// /// This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon /// Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon /// Rekognition Custom Labels</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon /// Rekognition Stored Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon /// Rekognition Streaming Video</a>. It provides descriptions of actions, data types, /// common parameters, and common errors. /// /// /// <para> /// <b>Amazon Rekognition Image</b> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_AssociateFaces.html">AssociateFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html">CompareFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html">CreateCollection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateUser.html">CreateUser</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html">DeleteCollection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html">DeleteFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteUser.html">DeleteUser</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html">DescribeCollection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html">DetectFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html">DetectLabels</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html">DetectModerationLabels</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html">DetectProtectiveEquipment</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html">DetectText</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DisassociateFaces.html">DisassociateFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html">GetCelebrityInfo</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html">ListCollections</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListUsers</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html">RecognizeCelebrities</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html">SearchFaces</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html">SearchFacesByImage</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsers.html">SearchUsers</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html">SearchUsersByImage</a> /// /// </para> /// </li> </ul> /// <para> /// <b>Amazon Rekognition Custom Labels</b> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html">CopyProjectVersion</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html">CreateDataset</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html">CreateProject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html">CreateProjectVersion</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html">DeleteDataset</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html">DeleteProject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html">DeleteProjectPolicy</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html">DeleteProjectVersion</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html">DescribeDataset</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html">DescribeProjects</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html">DescribeProjectVersions</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html">DetectCustomLabels</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html">DistributeDatasetEntries</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html">ListDatasetEntries</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html">ListDatasetLabels</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html">ListProjectPolicies</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html">PutProjectPolicy</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html">StartProjectVersion</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html">StopProjectVersion</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html">UpdateDatasetEntries</a> /// /// </para> /// </li> </ul> /// <para> /// <b>Amazon Rekognition Video Stored Video</b> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html">GetCelebrityRecognition</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html">GetContentModeration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html">GetFaceDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html">GetFaceSearch</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html">GetLabelDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html">GetPersonTracking</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html">GetSegmentDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html">GetTextDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html">StartCelebrityRecognition</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html">StartContentModeration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html">StartFaceDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html">StartFaceSearch</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html">StartLabelDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html">StartPersonTracking</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html">StartSegmentDetection</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html">StartTextDetection</a> /// /// </para> /// </li> </ul> /// <para> /// <b>Amazon Rekognition Video Streaming Video</b> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html">CreateStreamProcessor</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html">DeleteStreamProcessor</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html">DescribeStreamProcessor</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html">ListStreamProcessors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html">StartStreamProcessor</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html">StopStreamProcessor</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html">UpdateStreamProcessor</a> /// /// </para> /// </li> </ul> /// </summary> public partial interface IAmazonRekognition : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// <summary> /// Paginators for the service /// </summary> IRekognitionPaginatorFactory Paginators { get; } #endif #region AssociateFaces /// <summary> /// Associates one or more faces with an existing UserID. Takes an array of <code>FaceIds</code>. /// Each <code>FaceId</code> that are present in the <code>FaceIds</code> list is associated /// with the provided UserID. The maximum number of total <code>FaceIds</code> per UserID /// is 100. /// /// /// <para> /// The <code>UserMatchThreshold</code> parameter specifies the minimum user match confidence /// required for the face to be associated with a UserID that has at least one <code>FaceID</code> /// already associated. This ensures that the <code>FaceIds</code> are associated with /// the right UserID. The value ranges from 0-100 and default value is 75. /// </para> /// /// <para> /// If successful, an array of <code>AssociatedFace</code> objects containing the associated /// <code>FaceIds</code> is returned. If a given face is already associated with the given /// <code>UserID</code>, it will be ignored and will not be returned in the response. /// If a given face is already associated to a different <code>UserID</code>, isn't found /// in the collection, doesn’t meet the <code>UserMatchThreshold</code>, or there are /// already 100 faces associated with the <code>UserID</code>, it will be returned as /// part of an array of <code>UnsuccessfulFaceAssociations.</code> /// </para> /// /// <para> /// The <code>UserStatus</code> reflects the status of an operation which updates a UserID /// representation with a list of given faces. The <code>UserStatus</code> can be: /// </para> /// <ul> <li> /// <para> /// ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete. /// </para> /// </li> <li> /// <para> /// CREATED - A UserID has been created, but has no FaceID(s) associated with it. /// </para> /// </li> <li> /// <para> /// UPDATING - A UserID is being updated and there are current associations or disassociations /// of FaceID(s) taking place. /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the AssociateFaces service method.</param> /// /// <returns>The response from the AssociateFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ConflictException"> /// A User with the same Id already exists within the collection, or the update or deletion /// of the User caused an inconsistent state. ** /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/AssociateFaces">REST API Reference for AssociateFaces Operation</seealso> AssociateFacesResponse AssociateFaces(AssociateFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the AssociateFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the AssociateFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/AssociateFaces">REST API Reference for AssociateFaces Operation</seealso> IAsyncResult BeginAssociateFaces(AssociateFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the AssociateFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateFaces.</param> /// /// <returns>Returns a AssociateFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/AssociateFaces">REST API Reference for AssociateFaces Operation</seealso> AssociateFacesResponse EndAssociateFaces(IAsyncResult asyncResult); #endregion #region CompareFaces /// <summary> /// Compares a face in the <i>source</i> input image with each of the 100 largest faces /// detected in the <i>target</i> input image. /// /// /// <para> /// If the source image contains multiple faces, the service detects the largest face /// and compares it with each face detected in the target image. /// </para> /// <note> /// <para> /// CompareFaces uses machine learning algorithms, which are probabilistic. A false negative /// is an incorrect prediction that a face in the target image has a low similarity confidence /// score when compared to the face in the source image. To reduce the probability of /// false negatives, we recommend that you compare the target image against multiple source /// images. If you plan to use <code>CompareFaces</code> to make a decision that impacts /// an individual's rights, privacy, or access to services, we recommend that you pass /// the result to a human for review and further validation before taking action. /// </para> /// </note> /// <para> /// You pass the input and target images either as base64-encoded image bytes or as references /// to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition /// operations, passing image bytes isn't supported. The image must be formatted as a /// PNG or JPEG file. /// </para> /// /// <para> /// In response, the operation returns an array of face matches ordered by similarity /// score in descending order. For each face match, the response provides a bounding box /// of the face, facial landmarks, pose details (pitch, roll, and yaw), quality (brightness /// and sharpness), and confidence value (indicating the level of confidence that the /// bounding box contains a face). The response also provides a similarity score, which /// indicates how closely the faces match. /// </para> /// <note> /// <para> /// By default, only faces with a similarity score of greater than or equal to 80% are /// returned in the response. You can change this value by specifying the <code>SimilarityThreshold</code> /// parameter. /// </para> /// </note> /// <para> /// <code>CompareFaces</code> also returns an array of faces that don't match the source /// image. For each face, it returns a bounding box, confidence value, landmarks, pose /// details, and quality. The response also returns information about the face in the /// source image, including the bounding box of the face and confidence value. /// </para> /// /// <para> /// The <code>QualityFilter</code> input parameter allows you to filter out detected faces /// that don’t meet a required quality bar. The quality bar is based on a variety of common /// use cases. Use <code>QualityFilter</code> to set the quality bar by specifying <code>LOW</code>, /// <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter detected faces, /// specify <code>NONE</code>. The default value is <code>NONE</code>. /// </para> /// /// <para> /// If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation /// information for the source and target images. Use these values to display the images /// with the correct image orientation. /// </para> /// /// <para> /// If no faces are detected in the source or target images, <code>CompareFaces</code> /// returns an <code>InvalidParameterException</code> error. /// </para> /// <note> /// <para> /// This is a stateless API operation. That is, data returned by this operation doesn't /// persist. /// </para> /// </note> /// <para> /// For an example, see Comparing Faces in Images in the Amazon Rekognition Developer /// Guide. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:CompareFaces</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CompareFaces service method.</param> /// /// <returns>The response from the CompareFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CompareFaces">REST API Reference for CompareFaces Operation</seealso> CompareFacesResponse CompareFaces(CompareFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the CompareFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CompareFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompareFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CompareFaces">REST API Reference for CompareFaces Operation</seealso> IAsyncResult BeginCompareFaces(CompareFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CompareFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCompareFaces.</param> /// /// <returns>Returns a CompareFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CompareFaces">REST API Reference for CompareFaces Operation</seealso> CompareFacesResponse EndCompareFaces(IAsyncResult asyncResult); #endregion #region CopyProjectVersion /// <summary> /// Copies a version of an Amazon Rekognition Custom Labels model from a source project /// to a destination project. The source and destination projects can be in different /// AWS accounts but must be in the same AWS Region. You can't copy a model to another /// AWS service. /// /// /// <para> /// To copy a model version to a different AWS account, you need to create a resource-based /// policy known as a <i>project policy</i>. You attach the project policy to the source /// project by calling <a>PutProjectPolicy</a>. The project policy gives permission to /// copy the model version from a trusting AWS account to a trusted account. /// </para> /// /// <para> /// For more information creating and attaching a project policy, see Attaching a project /// policy (SDK) in the <i>Amazon Rekognition Custom Labels Developer Guide</i>. /// </para> /// /// <para> /// If you are copying a model version to a project in the same AWS account, you don't /// need to create a project policy. /// </para> /// <note> /// <para> /// To copy a model, the destination project, source project, and source model version /// must already exist. /// </para> /// </note> /// <para> /// Copying a model version takes a while to complete. To get the current status, call /// <a>DescribeProjectVersions</a> and check the value of <code>Status</code> in the <a>ProjectVersionDescription</a> /// object. The copy operation has finished when the value of <code>Status</code> is <code>COPYING_COMPLETED</code>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:CopyProjectVersion</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CopyProjectVersion service method.</param> /// /// <returns>The response from the CopyProjectVersion service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CopyProjectVersion">REST API Reference for CopyProjectVersion Operation</seealso> CopyProjectVersionResponse CopyProjectVersion(CopyProjectVersionRequest request); /// <summary> /// Initiates the asynchronous execution of the CopyProjectVersion operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CopyProjectVersion operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyProjectVersion /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CopyProjectVersion">REST API Reference for CopyProjectVersion Operation</seealso> IAsyncResult BeginCopyProjectVersion(CopyProjectVersionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CopyProjectVersion operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCopyProjectVersion.</param> /// /// <returns>Returns a CopyProjectVersionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CopyProjectVersion">REST API Reference for CopyProjectVersion Operation</seealso> CopyProjectVersionResponse EndCopyProjectVersion(IAsyncResult asyncResult); #endregion #region CreateCollection /// <summary> /// Creates a collection in an AWS Region. You can add faces to the collection using the /// <a>IndexFaces</a> operation. /// /// /// <para> /// For example, you might create collections, one for each of your application users. /// A user can then index faces using the <code>IndexFaces</code> operation and persist /// results in a specific collection. Then, a user can search the collection for faces /// in the user-specific container. /// </para> /// /// <para> /// When you create a collection, it is associated with the latest version of the face /// model version. /// </para> /// <note> /// <para> /// Collection names are case-sensitive. /// </para> /// </note> /// <para> /// This operation requires permissions to perform the <code>rekognition:CreateCollection</code> /// action. If you want to tag your collection, you also require permission to perform /// the <code>rekognition:TagResource</code> operation. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateCollection service method.</param> /// /// <returns>The response from the CreateCollection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceAlreadyExistsException"> /// A resource with the specified ID already exists. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateCollection">REST API Reference for CreateCollection Operation</seealso> CreateCollectionResponse CreateCollection(CreateCollectionRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateCollection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateCollection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCollection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateCollection">REST API Reference for CreateCollection Operation</seealso> IAsyncResult BeginCreateCollection(CreateCollectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateCollection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCollection.</param> /// /// <returns>Returns a CreateCollectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateCollection">REST API Reference for CreateCollection Operation</seealso> CreateCollectionResponse EndCreateCollection(IAsyncResult asyncResult); #endregion #region CreateDataset /// <summary> /// Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by /// using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition /// Custom Labels dataset. /// /// /// <para> /// To create a training dataset for a project, specify <code>train</code> for the value /// of <code>DatasetType</code>. To create the test dataset for a project, specify <code>test</code> /// for the value of <code>DatasetType</code>. /// </para> /// /// <para> /// The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for /// the dataset. Creating a dataset takes a while to complete. Use <a>DescribeDataset</a> /// to check the current status. The dataset created successfully if the value of <code>Status</code> /// is <code>CREATE_COMPLETE</code>. /// </para> /// /// <para> /// To check if any non-terminal errors occurred, call <a>ListDatasetEntries</a> and check /// for the presence of <code>errors</code> lists in the JSON Lines. /// </para> /// /// <para> /// Dataset creation fails if a terminal error occurs (<code>Status</code> = <code>CREATE_FAILED</code>). /// Currently, you can't access the terminal error information. /// </para> /// /// <para> /// For more information, see Creating dataset in the <i>Amazon Rekognition Custom Labels /// Developer Guide</i>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:CreateDataset</code> /// action. If you want to copy an existing dataset, you also require permission to perform /// the <code>rekognition:ListDatasetEntries</code> action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateDataset service method.</param> /// /// <returns>The response from the CreateDataset service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceAlreadyExistsException"> /// A resource with the specified ID already exists. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateDataset">REST API Reference for CreateDataset Operation</seealso> CreateDatasetResponse CreateDataset(CreateDatasetRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateDataset operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateDataset operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDataset /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateDataset">REST API Reference for CreateDataset Operation</seealso> IAsyncResult BeginCreateDataset(CreateDatasetRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateDataset operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDataset.</param> /// /// <returns>Returns a CreateDatasetResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateDataset">REST API Reference for CreateDataset Operation</seealso> CreateDatasetResponse EndCreateDataset(IAsyncResult asyncResult); #endregion #region CreateFaceLivenessSession /// <summary> /// This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>, /// which you can use to start streaming Face Liveness video and get the results for a /// Face Liveness session. You can use the <code>OutputConfig</code> option in the Settings /// parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference /// images and audit images. You can use <code>AuditImagesLimit</code> to limit the number /// of audit images returned. This number is between 0 and 4. By default, it is set to /// 0. The limit is best effort and based on the duration of the selfie-video. /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateFaceLivenessSession service method.</param> /// /// <returns>The response from the CreateFaceLivenessSession service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateFaceLivenessSession">REST API Reference for CreateFaceLivenessSession Operation</seealso> CreateFaceLivenessSessionResponse CreateFaceLivenessSession(CreateFaceLivenessSessionRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateFaceLivenessSession operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateFaceLivenessSession operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateFaceLivenessSession /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateFaceLivenessSession">REST API Reference for CreateFaceLivenessSession Operation</seealso> IAsyncResult BeginCreateFaceLivenessSession(CreateFaceLivenessSessionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateFaceLivenessSession operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateFaceLivenessSession.</param> /// /// <returns>Returns a CreateFaceLivenessSessionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateFaceLivenessSession">REST API Reference for CreateFaceLivenessSession Operation</seealso> CreateFaceLivenessSessionResponse EndCreateFaceLivenessSession(IAsyncResult asyncResult); #endregion #region CreateProject /// <summary> /// Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources /// (datasets, model versions) that you use to create and manage Amazon Rekognition Custom /// Labels models. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:CreateProject</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateProject service method.</param> /// /// <returns>The response from the CreateProject service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateProject">REST API Reference for CreateProject Operation</seealso> CreateProjectResponse CreateProject(CreateProjectRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateProject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateProject operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateProject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateProject">REST API Reference for CreateProject Operation</seealso> IAsyncResult BeginCreateProject(CreateProjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateProject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateProject.</param> /// /// <returns>Returns a CreateProjectResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateProject">REST API Reference for CreateProject Operation</seealso> CreateProjectResponse EndCreateProject(IAsyncResult asyncResult); #endregion #region CreateProjectVersion /// <summary> /// Creates a new version of a model and begins training. Models are managed as part of /// an Amazon Rekognition Custom Labels project. The response from <code>CreateProjectVersion</code> /// is an Amazon Resource Name (ARN) for the version of the model. /// /// /// <para> /// Training uses the training and test datasets associated with the project. For more /// information, see Creating training and test dataset in the <i>Amazon Rekognition Custom /// Labels Developer Guide</i>. /// </para> /// <note> /// <para> /// You can train a model in a project that doesn't have associated datasets by specifying /// manifest files in the <code>TrainingData</code> and <code>TestingData</code> fields. /// /// </para> /// /// <para> /// If you open the console after training a model with manifest files, Amazon Rekognition /// Custom Labels creates the datasets for you using the most recent manifest files. You /// can no longer train a model version for the project by specifying manifest files. /// /// </para> /// /// <para> /// Instead of training with a project without associated datasets, we recommend that /// you use the manifest files to create training and test datasets for the project. /// </para> /// </note> /// <para> /// Training takes a while to complete. You can get the current status by calling <a>DescribeProjectVersions</a>. /// Training completed successfully if the value of the <code>Status</code> field is <code>TRAINING_COMPLETED</code>. /// </para> /// /// <para> /// If training fails, see Debugging a failed model training in the <i>Amazon Rekognition /// Custom Labels</i> developer guide. /// </para> /// /// <para> /// Once training has successfully completed, call <a>DescribeProjectVersions</a> to get /// the training results and evaluate the model. For more information, see Improving a /// trained Amazon Rekognition Custom Labels model in the <i>Amazon Rekognition Custom /// Labels</i> developers guide. /// </para> /// /// <para> /// After evaluating the model, you start the model by calling <a>StartProjectVersion</a>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateProjectVersion service method.</param> /// /// <returns>The response from the CreateProjectVersion service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateProjectVersion">REST API Reference for CreateProjectVersion Operation</seealso> CreateProjectVersionResponse CreateProjectVersion(CreateProjectVersionRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateProjectVersion operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateProjectVersion operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateProjectVersion /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateProjectVersion">REST API Reference for CreateProjectVersion Operation</seealso> IAsyncResult BeginCreateProjectVersion(CreateProjectVersionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateProjectVersion operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateProjectVersion.</param> /// /// <returns>Returns a CreateProjectVersionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateProjectVersion">REST API Reference for CreateProjectVersion Operation</seealso> CreateProjectVersionResponse EndCreateProjectVersion(IAsyncResult asyncResult); #endregion #region CreateStreamProcessor /// <summary> /// Creates an Amazon Rekognition stream processor that you can use to detect and recognize /// faces or to detect labels in a streaming video. /// /// /// <para> /// Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. /// There are two different settings for stream processors in Amazon Rekognition: detecting /// faces and detecting labels. /// </para> /// <ul> <li> /// <para> /// If you are creating a stream processor for detecting faces, you provide as input a /// Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) /// stream for receiving the output. You must use the <code>FaceSearch</code> option in /// <code>Settings</code>, specifying the collection that contains the faces you want /// to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> /// to stop processing. /// </para> /// </li> <li> /// <para> /// If you are creating a stream processor to detect labels, you provide as input a Kinesis /// video stream (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), /// and an Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide /// a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you /// want to detect by using the <code>ConnectedHome</code> option in settings, and selecting /// one of the following: <code>PERSON</code>, <code>PET</code>, <code>PACKAGE</code>, /// <code>ALL</code> You can also specify where in the frame you want Amazon Rekognition /// to monitor with <code>RegionsOfInterest</code>. When you run the <a>StartStreamProcessor</a> /// operation on a label detection stream processor, you input start and stop information /// to determine the length of the processing time. /// </para> /// </li> </ul> /// <para> /// Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code> /// to manage the stream processor. For example, you can start processing the source video /// by calling <a>StartStreamProcessor</a> with the <code>Name</code> field. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:CreateStreamProcessor</code> /// action. If you want to tag your stream processor, you also require permission to perform /// the <code>rekognition:TagResource</code> operation. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateStreamProcessor service method.</param> /// /// <returns>The response from the CreateStreamProcessor service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateStreamProcessor">REST API Reference for CreateStreamProcessor Operation</seealso> CreateStreamProcessorResponse CreateStreamProcessor(CreateStreamProcessorRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateStreamProcessor operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateStreamProcessor operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStreamProcessor /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateStreamProcessor">REST API Reference for CreateStreamProcessor Operation</seealso> IAsyncResult BeginCreateStreamProcessor(CreateStreamProcessorRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateStreamProcessor operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStreamProcessor.</param> /// /// <returns>Returns a CreateStreamProcessorResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateStreamProcessor">REST API Reference for CreateStreamProcessor Operation</seealso> CreateStreamProcessorResponse EndCreateStreamProcessor(IAsyncResult asyncResult); #endregion #region CreateUser /// <summary> /// Creates a new User within a collection specified by <code>CollectionId</code>. Takes /// <code>UserId</code> as a parameter, which is a user provided ID which should be unique /// within the collection. The provided <code>UserId</code> will alias the system generated /// UUID to make the <code>UserId</code> more user friendly. /// /// /// <para> /// Uses a <code>ClientToken</code>, an idempotency token that ensures a call to <code>CreateUser</code> /// completes only once. If the value is not supplied, the AWS SDK generates an idempotency /// token for the requests. This prevents retries after a network error results from making /// multiple <code>CreateUser</code> calls. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateUser service method.</param> /// /// <returns>The response from the CreateUser service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ConflictException"> /// A User with the same Id already exists within the collection, or the update or deletion /// of the User caused an inconsistent state. ** /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateUser">REST API Reference for CreateUser Operation</seealso> CreateUserResponse CreateUser(CreateUserRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateUser operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateUser operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateUser /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateUser">REST API Reference for CreateUser Operation</seealso> IAsyncResult BeginCreateUser(CreateUserRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateUser operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateUser.</param> /// /// <returns>Returns a CreateUserResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateUser">REST API Reference for CreateUser Operation</seealso> CreateUserResponse EndCreateUser(IAsyncResult asyncResult); #endregion #region DeleteCollection /// <summary> /// Deletes the specified collection. Note that this operation removes all faces in the /// collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting /// a collection</a>. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DeleteCollection</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteCollection service method.</param> /// /// <returns>The response from the DeleteCollection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteCollection">REST API Reference for DeleteCollection Operation</seealso> DeleteCollectionResponse DeleteCollection(DeleteCollectionRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteCollection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteCollection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCollection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteCollection">REST API Reference for DeleteCollection Operation</seealso> IAsyncResult BeginDeleteCollection(DeleteCollectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteCollection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCollection.</param> /// /// <returns>Returns a DeleteCollectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteCollection">REST API Reference for DeleteCollection Operation</seealso> DeleteCollectionResponse EndDeleteCollection(IAsyncResult asyncResult); #endregion #region DeleteDataset /// <summary> /// Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might /// take while. Use <a>DescribeDataset</a> to check the current status. The dataset is /// still deleting if the value of <code>Status</code> is <code>DELETE_IN_PROGRESS</code>. /// If you try to access the dataset after it is deleted, you get a <code>ResourceNotFoundException</code> /// exception. /// /// /// <para> /// You can't delete a dataset while it is creating (<code>Status</code> = <code>CREATE_IN_PROGRESS</code>) /// or if the dataset is updating (<code>Status</code> = <code>UPDATE_IN_PROGRESS</code>). /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DeleteDataset</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteDataset service method.</param> /// /// <returns>The response from the DeleteDataset service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteDataset">REST API Reference for DeleteDataset Operation</seealso> DeleteDatasetResponse DeleteDataset(DeleteDatasetRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteDataset operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteDataset operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDataset /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteDataset">REST API Reference for DeleteDataset Operation</seealso> IAsyncResult BeginDeleteDataset(DeleteDatasetRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteDataset operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDataset.</param> /// /// <returns>Returns a DeleteDatasetResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteDataset">REST API Reference for DeleteDataset Operation</seealso> DeleteDatasetResponse EndDeleteDataset(IAsyncResult asyncResult); #endregion #region DeleteFaces /// <summary> /// Deletes faces from a collection. You specify a collection ID and an array of face /// IDs to remove from the collection. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DeleteFaces</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteFaces service method.</param> /// /// <returns>The response from the DeleteFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteFaces">REST API Reference for DeleteFaces Operation</seealso> DeleteFacesResponse DeleteFaces(DeleteFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteFaces">REST API Reference for DeleteFaces Operation</seealso> IAsyncResult BeginDeleteFaces(DeleteFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteFaces.</param> /// /// <returns>Returns a DeleteFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteFaces">REST API Reference for DeleteFaces Operation</seealso> DeleteFacesResponse EndDeleteFaces(IAsyncResult asyncResult); #endregion #region DeleteProject /// <summary> /// Deletes an Amazon Rekognition Custom Labels project. To delete a project you must /// first delete all models associated with the project. To delete a model, see <a>DeleteProjectVersion</a>. /// /// /// <para> /// <code>DeleteProject</code> is an asynchronous operation. To check if the project /// is deleted, call <a>DescribeProjects</a>. The project is deleted when the project /// no longer appears in the response. Be aware that deleting a given project will also /// delete any <code>ProjectPolicies</code> associated with that project. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DeleteProject</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteProject service method.</param> /// /// <returns>The response from the DeleteProject service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProject">REST API Reference for DeleteProject Operation</seealso> DeleteProjectResponse DeleteProject(DeleteProjectRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteProject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteProject operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteProject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProject">REST API Reference for DeleteProject Operation</seealso> IAsyncResult BeginDeleteProject(DeleteProjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteProject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteProject.</param> /// /// <returns>Returns a DeleteProjectResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProject">REST API Reference for DeleteProject Operation</seealso> DeleteProjectResponse EndDeleteProject(IAsyncResult asyncResult); #endregion #region DeleteProjectPolicy /// <summary> /// Deletes an existing project policy. /// /// /// <para> /// To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. /// To attach a project policy to a project, call <a>PutProjectPolicy</a>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DeleteProjectPolicy</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteProjectPolicy service method.</param> /// /// <returns>The response from the DeleteProjectPolicy service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPolicyRevisionIdException"> /// The supplied revision id for the project policy is invalid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProjectPolicy">REST API Reference for DeleteProjectPolicy Operation</seealso> DeleteProjectPolicyResponse DeleteProjectPolicy(DeleteProjectPolicyRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteProjectPolicy operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteProjectPolicy operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteProjectPolicy /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProjectPolicy">REST API Reference for DeleteProjectPolicy Operation</seealso> IAsyncResult BeginDeleteProjectPolicy(DeleteProjectPolicyRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteProjectPolicy operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteProjectPolicy.</param> /// /// <returns>Returns a DeleteProjectPolicyResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProjectPolicy">REST API Reference for DeleteProjectPolicy Operation</seealso> DeleteProjectPolicyResponse EndDeleteProjectPolicy(IAsyncResult asyncResult); #endregion #region DeleteProjectVersion /// <summary> /// Deletes an Amazon Rekognition Custom Labels model. /// /// /// <para> /// You can't delete a model if it is running or if it is training. To check the status /// of a model, use the <code>Status</code> field returned from <a>DescribeProjectVersions</a>. /// To stop a running model call <a>StopProjectVersion</a>. If the model is training, /// wait until it finishes. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DeleteProjectVersion</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteProjectVersion service method.</param> /// /// <returns>The response from the DeleteProjectVersion service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProjectVersion">REST API Reference for DeleteProjectVersion Operation</seealso> DeleteProjectVersionResponse DeleteProjectVersion(DeleteProjectVersionRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteProjectVersion operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteProjectVersion operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteProjectVersion /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProjectVersion">REST API Reference for DeleteProjectVersion Operation</seealso> IAsyncResult BeginDeleteProjectVersion(DeleteProjectVersionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteProjectVersion operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteProjectVersion.</param> /// /// <returns>Returns a DeleteProjectVersionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteProjectVersion">REST API Reference for DeleteProjectVersion Operation</seealso> DeleteProjectVersionResponse EndDeleteProjectVersion(IAsyncResult asyncResult); #endregion #region DeleteStreamProcessor /// <summary> /// Deletes the stream processor identified by <code>Name</code>. You assign the value /// for <code>Name</code> when you create the stream processor with <a>CreateStreamProcessor</a>. /// You might not be able to use the same name for a stream processor for a few seconds /// after calling <code>DeleteStreamProcessor</code>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteStreamProcessor service method.</param> /// /// <returns>The response from the DeleteStreamProcessor service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteStreamProcessor">REST API Reference for DeleteStreamProcessor Operation</seealso> DeleteStreamProcessorResponse DeleteStreamProcessor(DeleteStreamProcessorRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteStreamProcessor operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteStreamProcessor operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStreamProcessor /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteStreamProcessor">REST API Reference for DeleteStreamProcessor Operation</seealso> IAsyncResult BeginDeleteStreamProcessor(DeleteStreamProcessorRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteStreamProcessor operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStreamProcessor.</param> /// /// <returns>Returns a DeleteStreamProcessorResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteStreamProcessor">REST API Reference for DeleteStreamProcessor Operation</seealso> DeleteStreamProcessorResponse EndDeleteStreamProcessor(IAsyncResult asyncResult); #endregion #region DeleteUser /// <summary> /// 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. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteUser service method.</param> /// /// <returns>The response from the DeleteUser service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ConflictException"> /// A User with the same Id already exists within the collection, or the update or deletion /// of the User caused an inconsistent state. ** /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteUser">REST API Reference for DeleteUser Operation</seealso> DeleteUserResponse DeleteUser(DeleteUserRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteUser operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteUser operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUser /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteUser">REST API Reference for DeleteUser Operation</seealso> IAsyncResult BeginDeleteUser(DeleteUserRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteUser operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUser.</param> /// /// <returns>Returns a DeleteUserResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteUser">REST API Reference for DeleteUser Operation</seealso> DeleteUserResponse EndDeleteUser(IAsyncResult asyncResult); #endregion #region DescribeCollection /// <summary> /// Describes the specified collection. You can use <code>DescribeCollection</code> to /// get information, such as the number of faces indexed into a collection and the version /// of the model used by the collection for face detection. /// /// /// <para> /// For more information, see Describing a Collection in the Amazon Rekognition Developer /// Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeCollection service method.</param> /// /// <returns>The response from the DescribeCollection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeCollection">REST API Reference for DescribeCollection Operation</seealso> DescribeCollectionResponse DescribeCollection(DescribeCollectionRequest request); /// <summary> /// Initiates the asynchronous execution of the DescribeCollection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeCollection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCollection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeCollection">REST API Reference for DescribeCollection Operation</seealso> IAsyncResult BeginDescribeCollection(DescribeCollectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DescribeCollection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCollection.</param> /// /// <returns>Returns a DescribeCollectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeCollection">REST API Reference for DescribeCollection Operation</seealso> DescribeCollectionResponse EndDescribeCollection(IAsyncResult asyncResult); #endregion #region DescribeDataset /// <summary> /// Describes an Amazon Rekognition Custom Labels dataset. You can get information such /// as the current status of a dataset and statistics about the images and labels in a /// dataset. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DescribeDataset</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeDataset service method.</param> /// /// <returns>The response from the DescribeDataset service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeDataset">REST API Reference for DescribeDataset Operation</seealso> DescribeDatasetResponse DescribeDataset(DescribeDatasetRequest request); /// <summary> /// Initiates the asynchronous execution of the DescribeDataset operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeDataset operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDataset /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeDataset">REST API Reference for DescribeDataset Operation</seealso> IAsyncResult BeginDescribeDataset(DescribeDatasetRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DescribeDataset operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDataset.</param> /// /// <returns>Returns a DescribeDatasetResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeDataset">REST API Reference for DescribeDataset Operation</seealso> DescribeDatasetResponse EndDescribeDataset(IAsyncResult asyncResult); #endregion #region DescribeProjects /// <summary> /// Gets information about your Amazon Rekognition Custom Labels projects. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeProjects service method.</param> /// /// <returns>The response from the DescribeProjects service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeProjects">REST API Reference for DescribeProjects Operation</seealso> DescribeProjectsResponse DescribeProjects(DescribeProjectsRequest request); /// <summary> /// Initiates the asynchronous execution of the DescribeProjects operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeProjects operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeProjects /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeProjects">REST API Reference for DescribeProjects Operation</seealso> IAsyncResult BeginDescribeProjects(DescribeProjectsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DescribeProjects operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeProjects.</param> /// /// <returns>Returns a DescribeProjectsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeProjects">REST API Reference for DescribeProjects Operation</seealso> DescribeProjectsResponse EndDescribeProjects(IAsyncResult asyncResult); #endregion #region DescribeProjectVersions /// <summary> /// Lists and describes the versions of a model in an Amazon Rekognition Custom Labels /// project. You can specify up to 10 model versions in <code>ProjectVersionArns</code>. /// If you don't specify a value, descriptions for all model versions in the project are /// returned. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeProjectVersions service method.</param> /// /// <returns>The response from the DescribeProjectVersions service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeProjectVersions">REST API Reference for DescribeProjectVersions Operation</seealso> DescribeProjectVersionsResponse DescribeProjectVersions(DescribeProjectVersionsRequest request); /// <summary> /// Initiates the asynchronous execution of the DescribeProjectVersions operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeProjectVersions operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeProjectVersions /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeProjectVersions">REST API Reference for DescribeProjectVersions Operation</seealso> IAsyncResult BeginDescribeProjectVersions(DescribeProjectVersionsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DescribeProjectVersions operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeProjectVersions.</param> /// /// <returns>Returns a DescribeProjectVersionsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeProjectVersions">REST API Reference for DescribeProjectVersions Operation</seealso> DescribeProjectVersionsResponse EndDescribeProjectVersions(IAsyncResult asyncResult); #endregion #region DescribeStreamProcessor /// <summary> /// Provides information about a stream processor created by <a>CreateStreamProcessor</a>. /// You can get information about the input and output streams, the input parameters for /// the face recognition being performed, and the current status of the stream processor. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeStreamProcessor service method.</param> /// /// <returns>The response from the DescribeStreamProcessor service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeStreamProcessor">REST API Reference for DescribeStreamProcessor Operation</seealso> DescribeStreamProcessorResponse DescribeStreamProcessor(DescribeStreamProcessorRequest request); /// <summary> /// Initiates the asynchronous execution of the DescribeStreamProcessor operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeStreamProcessor operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStreamProcessor /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeStreamProcessor">REST API Reference for DescribeStreamProcessor Operation</seealso> IAsyncResult BeginDescribeStreamProcessor(DescribeStreamProcessorRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DescribeStreamProcessor operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStreamProcessor.</param> /// /// <returns>Returns a DescribeStreamProcessorResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeStreamProcessor">REST API Reference for DescribeStreamProcessor Operation</seealso> DescribeStreamProcessorResponse EndDescribeStreamProcessor(IAsyncResult asyncResult); #endregion #region DetectCustomLabels /// <summary> /// Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels /// model. /// /// /// <para> /// You specify which version of a model version to use by using the <code>ProjectVersionArn</code> /// input parameter. /// </para> /// /// <para> /// You pass the input image as base64-encoded image bytes or as a reference to an image /// in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, /// passing image bytes is not supported. The image must be either a PNG or JPEG formatted /// file. /// </para> /// /// <para> /// For each object that the model version detects on an image, the API returns a (<code>CustomLabel</code>) /// object in an array (<code>CustomLabels</code>). Each <code>CustomLabel</code> object /// provides the label name (<code>Name</code>), the level of confidence that the image /// contains the object (<code>Confidence</code>), and object location information, if /// it exists, for the label on the image (<code>Geometry</code>). /// </para> /// /// <para> /// To filter labels that are returned, specify a value for <code>MinConfidence</code>. /// <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's /// higher than the specified value. The value of <code>MinConfidence</code> maps to the /// assumed threshold values created during training. For more information, see <i>Assumed /// threshold</i> in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition /// Custom Labels metrics expresses an assumed threshold as a floating point value between /// 0-1. The range of <code>MinConfidence</code> normalizes the threshold value to a percentage /// value (0-100). Confidence responses from <code>DetectCustomLabels</code> are also /// returned as a percentage. You can use <code>MinConfidence</code> to change the precision /// and recall or your model. For more information, see <i>Analyzing an image</i> in the /// Amazon Rekognition Custom Labels Developer Guide. /// </para> /// /// <para> /// If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code> /// returns labels based on the assumed threshold of each label. /// </para> /// /// <para> /// This is a stateless API operation. That is, the operation does not persist any data. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DetectCustomLabels</code> /// action. /// </para> /// /// <para> /// For more information, see <i>Analyzing an image</i> in the Amazon Rekognition Custom /// Labels Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DetectCustomLabels service method.</param> /// /// <returns>The response from the DetectCustomLabels service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotReadyException"> /// The requested resource isn't ready. For example, this exception occurs when you call /// <code>DetectCustomLabels</code> with a model version that isn't deployed. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectCustomLabels">REST API Reference for DetectCustomLabels Operation</seealso> DetectCustomLabelsResponse DetectCustomLabels(DetectCustomLabelsRequest request); /// <summary> /// Initiates the asynchronous execution of the DetectCustomLabels operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DetectCustomLabels operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectCustomLabels /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectCustomLabels">REST API Reference for DetectCustomLabels Operation</seealso> IAsyncResult BeginDetectCustomLabels(DetectCustomLabelsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DetectCustomLabels operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDetectCustomLabels.</param> /// /// <returns>Returns a DetectCustomLabelsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectCustomLabels">REST API Reference for DetectCustomLabels Operation</seealso> DetectCustomLabelsResponse EndDetectCustomLabels(IAsyncResult asyncResult); #endregion #region DetectFaces /// <summary> /// Detects faces within an image that is provided as input. /// /// /// <para> /// <code>DetectFaces</code> detects the 100 largest faces in the image. For each face /// detected, the operation returns face details. These details include a bounding box /// of the face, a confidence value (that the bounding box contains a face), and a fixed /// set of attributes such as facial landmarks (for example, coordinates of eye and mouth), /// pose, presence of facial occlusion, and so on. /// </para> /// /// <para> /// The face-detection algorithm is most effective on frontal faces. For non-frontal or /// obscured faces, the algorithm might not detect the faces or might detect faces with /// lower confidence. /// </para> /// /// <para> /// You pass the input image either as base64-encoded image bytes or as a reference to /// an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition /// operations, passing image bytes is not supported. The image must be either a PNG or /// JPEG formatted file. /// </para> /// <note> /// <para> /// This is a stateless API operation. That is, the operation does not persist any data. /// </para> /// </note> /// <para> /// This operation requires permissions to perform the <code>rekognition:DetectFaces</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DetectFaces service method.</param> /// /// <returns>The response from the DetectFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectFaces">REST API Reference for DetectFaces Operation</seealso> DetectFacesResponse DetectFaces(DetectFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the DetectFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DetectFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectFaces">REST API Reference for DetectFaces Operation</seealso> IAsyncResult BeginDetectFaces(DetectFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DetectFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDetectFaces.</param> /// /// <returns>Returns a DetectFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectFaces">REST API Reference for DetectFaces Operation</seealso> DetectFacesResponse EndDetectFaces(IAsyncResult asyncResult); #endregion #region DetectLabels /// <summary> /// Detects instances of real-world entities within an image (JPEG or PNG) provided as /// input. This includes objects like flower, tree, and table; events like wedding, graduation, /// and birthday party; and concepts like landscape, evening, and nature. /// /// /// <para> /// For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition /// Developer Guide. /// </para> /// /// <para> /// You pass the input image as base64-encoded image bytes or as a reference to an image /// in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, /// passing image bytes is not supported. The image must be either a PNG or JPEG formatted /// file. /// </para> /// /// <para> /// <b>Optional Parameters</b> /// </para> /// /// <para> /// You can specify one or both of the <code>GENERAL_LABELS</code> and <code>IMAGE_PROPERTIES</code> /// feature types when calling the DetectLabels API. Including <code>GENERAL_LABELS</code> /// will ensure the response includes the labels detected in the input image, while including /// <code>IMAGE_PROPERTIES </code>will ensure the response includes information about /// the image quality and color. /// </para> /// /// <para> /// When using <code>GENERAL_LABELS</code> and/or <code>IMAGE_PROPERTIES</code> you can /// provide filtering criteria to the Settings parameter. You can filter with sets of /// individual labels or with label categories. You can specify inclusive filters, exclusive /// filters, or a combination of inclusive and exclusive filters. For more information /// on filtering see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html">Detecting /// Labels in an Image</a>. /// </para> /// /// <para> /// You can specify <code>MinConfidence</code> to control the confidence threshold for /// the labels returned. The default is 55%. You can also add the <code>MaxLabels</code> /// parameter to limit the number of labels returned. The default and upper limit is 1000 /// labels. /// </para> /// /// <para> /// <b>Response Elements</b> /// </para> /// /// <para> /// For each object, scene, and concept the API returns one or more labels. The API returns /// the following types of information about labels: /// </para> /// <ul> <li> /// <para> /// Name - The name of the detected label. /// </para> /// </li> <li> /// <para> /// Confidence - The level of confidence in the label assigned to a detected object. /// /// </para> /// </li> <li> /// <para> /// Parents - The ancestor labels for a detected label. DetectLabels returns a hierarchical /// taxonomy of detected labels. For example, a detected car might be assigned the label /// car. The label car has two parent labels: Vehicle (its parent) and Transportation /// (its grandparent). The response includes the all ancestors for a label, where every /// ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation /// are returned as unique labels in the response. /// </para> /// </li> <li> /// <para> /// Aliases - Possible Aliases for the label. /// </para> /// </li> <li> /// <para> /// Categories - The label categories that the detected label belongs to. /// </para> /// </li> <li> /// <para> /// BoundingBox — Bounding boxes are described for all instances of detected common object /// labels, returned in an array of Instance objects. An Instance object contains a BoundingBox /// object, describing the location of the label on the input image. It also includes /// the confidence for the accuracy of the detected bounding box. /// </para> /// </li> </ul> /// <para> /// The API returns the following information regarding the image, as part of the ImageProperties /// structure: /// </para> /// <ul> <li> /// <para> /// Quality - Information about the Sharpness, Brightness, and Contrast of the input image, /// scored between 0 to 100. Image quality is returned for the entire image, as well as /// the background and the foreground. /// </para> /// </li> <li> /// <para> /// Dominant Color - An array of the dominant colors in the image. /// </para> /// </li> <li> /// <para> /// Foreground - Information about the sharpness, brightness, and dominant colors of the /// input image’s foreground. /// </para> /// </li> <li> /// <para> /// Background - Information about the sharpness, brightness, and dominant colors of the /// input image’s background. /// </para> /// </li> </ul> /// <para> /// The list of returned labels will include at least one label for every detected object, /// along with information about that label. In the following example, suppose the input /// image has a lighthouse, the sea, and a rock. The response includes all three labels, /// one for each object, as well as the confidence in the label: /// </para> /// /// <para> /// <code>{Name: lighthouse, Confidence: 98.4629}</code> /// </para> /// /// <para> /// <code>{Name: rock,Confidence: 79.2097}</code> /// </para> /// /// <para> /// <code> {Name: sea,Confidence: 75.061}</code> /// </para> /// /// <para> /// The list of labels can include multiple labels for the same object. For example, if /// the input image shows a flower (for example, a tulip), the operation might return /// the following three labels. /// </para> /// /// <para> /// <code>{Name: flower,Confidence: 99.0562}</code> /// </para> /// /// <para> /// <code>{Name: plant,Confidence: 99.0562}</code> /// </para> /// /// <para> /// <code>{Name: tulip,Confidence: 99.0562}</code> /// </para> /// /// <para> /// In this example, the detection algorithm more precisely identifies the flower as a /// tulip. /// </para> /// <note> /// <para> /// If the object detected is a person, the operation doesn't provide the same facial /// details that the <a>DetectFaces</a> operation provides. /// </para> /// </note> /// <para> /// This is a stateless API operation that doesn't return any data. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DetectLabels</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DetectLabels service method.</param> /// /// <returns>The response from the DetectLabels service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectLabels">REST API Reference for DetectLabels Operation</seealso> DetectLabelsResponse DetectLabels(DetectLabelsRequest request); /// <summary> /// Initiates the asynchronous execution of the DetectLabels operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DetectLabels operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectLabels /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectLabels">REST API Reference for DetectLabels Operation</seealso> IAsyncResult BeginDetectLabels(DetectLabelsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DetectLabels operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDetectLabels.</param> /// /// <returns>Returns a DetectLabelsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectLabels">REST API Reference for DetectLabels Operation</seealso> DetectLabelsResponse EndDetectLabels(IAsyncResult asyncResult); #endregion #region DetectModerationLabels /// <summary> /// Detects unsafe content in a specified JPEG or PNG format image. Use <code>DetectModerationLabels</code> /// to moderate images depending on your requirements. For example, you might want to /// filter images that contain nudity, but not images containing suggestive content. /// /// /// <para> /// To filter images, use the labels returned by <code>DetectModerationLabels</code> to /// determine which types of content are appropriate. /// </para> /// /// <para> /// For information about moderation labels, see Detecting Unsafe Content in the Amazon /// Rekognition Developer Guide. /// </para> /// /// <para> /// You pass the input image either as base64-encoded image bytes or as a reference to /// an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition /// operations, passing image bytes is not supported. The image must be either a PNG or /// JPEG formatted file. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DetectModerationLabels service method.</param> /// /// <returns>The response from the DetectModerationLabels service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.HumanLoopQuotaExceededException"> /// The number of in-progress human reviews you have has exceeded the number allowed. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectModerationLabels">REST API Reference for DetectModerationLabels Operation</seealso> DetectModerationLabelsResponse DetectModerationLabels(DetectModerationLabelsRequest request); /// <summary> /// Initiates the asynchronous execution of the DetectModerationLabels operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DetectModerationLabels operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectModerationLabels /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectModerationLabels">REST API Reference for DetectModerationLabels Operation</seealso> IAsyncResult BeginDetectModerationLabels(DetectModerationLabelsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DetectModerationLabels operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDetectModerationLabels.</param> /// /// <returns>Returns a DetectModerationLabelsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectModerationLabels">REST API Reference for DetectModerationLabels Operation</seealso> DetectModerationLabelsResponse EndDetectModerationLabels(IAsyncResult asyncResult); #endregion #region DetectProtectiveEquipment /// <summary> /// Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon /// Rekognition can detect the following types of PPE. /// /// <ul> <li> /// <para> /// Face cover /// </para> /// </li> <li> /// <para> /// Hand cover /// </para> /// </li> <li> /// <para> /// Head cover /// </para> /// </li> </ul> /// <para> /// You pass the input image as base64-encoded image bytes or as a reference to an image /// in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file. /// </para> /// /// <para> /// <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected /// in an image. /// </para> /// /// <para> /// For each person detected in the image the API returns an array of body parts (face, /// head, left-hand, right-hand). For each body part, an array of detected items of PPE /// is returned, including an indicator of whether or not the PPE covers the body part. /// The API returns the confidence it has in each detection (person, PPE, body part and /// body part coverage). It also returns a bounding box (<a>BoundingBox</a>) for each /// detected person and each detected item of PPE. /// </para> /// /// <para> /// You can optionally request a summary of detected PPE items with the <code>SummarizationAttributes</code> /// input parameter. The summary provides the following information. /// </para> /// <ul> <li> /// <para> /// The persons detected as wearing all of the types of PPE that you specify. /// </para> /// </li> <li> /// <para> /// The persons detected as not wearing all of the types PPE that you specify. /// </para> /// </li> <li> /// <para> /// The persons detected where PPE adornment could not be determined. /// </para> /// </li> </ul> /// <para> /// This is a stateless API operation. That is, the operation does not persist any data. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DetectProtectiveEquipment service method.</param> /// /// <returns>The response from the DetectProtectiveEquipment service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectProtectiveEquipment">REST API Reference for DetectProtectiveEquipment Operation</seealso> DetectProtectiveEquipmentResponse DetectProtectiveEquipment(DetectProtectiveEquipmentRequest request); /// <summary> /// Initiates the asynchronous execution of the DetectProtectiveEquipment operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DetectProtectiveEquipment operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectProtectiveEquipment /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectProtectiveEquipment">REST API Reference for DetectProtectiveEquipment Operation</seealso> IAsyncResult BeginDetectProtectiveEquipment(DetectProtectiveEquipmentRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DetectProtectiveEquipment operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDetectProtectiveEquipment.</param> /// /// <returns>Returns a DetectProtectiveEquipmentResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectProtectiveEquipment">REST API Reference for DetectProtectiveEquipment Operation</seealso> DetectProtectiveEquipmentResponse EndDetectProtectiveEquipment(IAsyncResult asyncResult); #endregion #region DetectText /// <summary> /// Detects text in the input image and converts it into machine-readable text. /// /// /// <para> /// Pass the input image as base64-encoded image bytes or as a reference to an image in /// an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, /// you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, /// passing image bytes is not supported. The image must be either a .png or .jpeg formatted /// file. /// </para> /// /// <para> /// The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> /// elements, <code>TextDetections</code>. Each <code>TextDetection</code> element provides /// information about a single word or line of text that was detected in the image. /// </para> /// /// <para> /// A word is one or more script characters that are not separated by spaces. <code>DetectText</code> /// can detect up to 100 words in an image. /// </para> /// /// <para> /// A line is a string of equally spaced words. A line isn't necessarily a complete sentence. /// For example, a driver's license number is detected as a line. A line ends when there /// is no aligned text after it. Also, a line ends when there is a large gap between words, /// relative to the length of the words. This means, depending on the gap between words, /// Amazon Rekognition may detect multiple lines in text aligned in the same direction. /// Periods don't represent the end of a line. If a sentence spans multiple lines, the /// <code>DetectText</code> operation returns multiple lines. /// </para> /// /// <para> /// To determine whether a <code>TextDetection</code> element is a line of text or a word, /// use the <code>TextDetection</code> object <code>Type</code> field. /// </para> /// /// <para> /// To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. /// </para> /// /// <para> /// For more information, see Detecting text in the Amazon Rekognition Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DetectText service method.</param> /// /// <returns>The response from the DetectText service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectText">REST API Reference for DetectText Operation</seealso> DetectTextResponse DetectText(DetectTextRequest request); /// <summary> /// Initiates the asynchronous execution of the DetectText operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DetectText operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectText /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectText">REST API Reference for DetectText Operation</seealso> IAsyncResult BeginDetectText(DetectTextRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DetectText operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDetectText.</param> /// /// <returns>Returns a DetectTextResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectText">REST API Reference for DetectText Operation</seealso> DetectTextResponse EndDetectText(IAsyncResult asyncResult); #endregion #region DisassociateFaces /// <summary> /// 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. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DisassociateFaces service method.</param> /// /// <returns>The response from the DisassociateFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ConflictException"> /// A User with the same Id already exists within the collection, or the update or deletion /// of the User caused an inconsistent state. ** /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DisassociateFaces">REST API Reference for DisassociateFaces Operation</seealso> DisassociateFacesResponse DisassociateFaces(DisassociateFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the DisassociateFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DisassociateFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisassociateFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DisassociateFaces">REST API Reference for DisassociateFaces Operation</seealso> IAsyncResult BeginDisassociateFaces(DisassociateFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DisassociateFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDisassociateFaces.</param> /// /// <returns>Returns a DisassociateFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DisassociateFaces">REST API Reference for DisassociateFaces Operation</seealso> DisassociateFacesResponse EndDisassociateFaces(IAsyncResult asyncResult); #endregion #region DistributeDatasetEntries /// <summary> /// Distributes the entries (images) in a training dataset across the training dataset /// and the test dataset for a project. <code>DistributeDatasetEntries</code> moves 20% /// of the training dataset images to the test dataset. An entry is a JSON Line that describes /// an image. /// /// /// <para> /// You supply the Amazon Resource Names (ARN) of a project's training dataset and test /// dataset. The training dataset must contain the images that you want to split. The /// test dataset must be empty. The datasets must belong to the same project. To create /// training and test datasets for a project, call <a>CreateDataset</a>. /// </para> /// /// <para> /// Distributing a dataset takes a while to complete. To check the status call <code>DescribeDataset</code>. /// The operation is complete when the <code>Status</code> field for the training dataset /// and the test dataset is <code>UPDATE_COMPLETE</code>. If the dataset split fails, /// the value of <code>Status</code> is <code>UPDATE_FAILED</code>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:DistributeDatasetEntries</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DistributeDatasetEntries service method.</param> /// /// <returns>The response from the DistributeDatasetEntries service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotReadyException"> /// The requested resource isn't ready. For example, this exception occurs when you call /// <code>DetectCustomLabels</code> with a model version that isn't deployed. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DistributeDatasetEntries">REST API Reference for DistributeDatasetEntries Operation</seealso> DistributeDatasetEntriesResponse DistributeDatasetEntries(DistributeDatasetEntriesRequest request); /// <summary> /// Initiates the asynchronous execution of the DistributeDatasetEntries operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DistributeDatasetEntries operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDistributeDatasetEntries /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DistributeDatasetEntries">REST API Reference for DistributeDatasetEntries Operation</seealso> IAsyncResult BeginDistributeDatasetEntries(DistributeDatasetEntriesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DistributeDatasetEntries operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDistributeDatasetEntries.</param> /// /// <returns>Returns a DistributeDatasetEntriesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DistributeDatasetEntries">REST API Reference for DistributeDatasetEntries Operation</seealso> DistributeDatasetEntriesResponse EndDistributeDatasetEntries(IAsyncResult asyncResult); #endregion #region GetCelebrityInfo /// <summary> /// Gets the name and additional information about a celebrity based on their Amazon Rekognition /// ID. The additional information is returned as an array of URLs. If there is no additional /// information about the celebrity, this list is empty. /// /// /// <para> /// For more information, see Getting information about a celebrity in the Amazon Rekognition /// Developer Guide. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:GetCelebrityInfo</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetCelebrityInfo service method.</param> /// /// <returns>The response from the GetCelebrityInfo service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityInfo">REST API Reference for GetCelebrityInfo Operation</seealso> GetCelebrityInfoResponse GetCelebrityInfo(GetCelebrityInfoRequest request); /// <summary> /// Initiates the asynchronous execution of the GetCelebrityInfo operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetCelebrityInfo operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCelebrityInfo /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityInfo">REST API Reference for GetCelebrityInfo Operation</seealso> IAsyncResult BeginGetCelebrityInfo(GetCelebrityInfoRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetCelebrityInfo operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCelebrityInfo.</param> /// /// <returns>Returns a GetCelebrityInfoResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityInfo">REST API Reference for GetCelebrityInfo Operation</seealso> GetCelebrityInfoResponse EndGetCelebrityInfo(IAsyncResult asyncResult); #endregion #region GetCelebrityRecognition /// <summary> /// Gets the celebrity recognition results for a Amazon Rekognition Video analysis started /// by <a>StartCelebrityRecognition</a>. /// /// /// <para> /// Celebrity recognition in a video is an asynchronous operation. Analysis is started /// by a call to <a>StartCelebrityRecognition</a> which returns a job identifier (<code>JobId</code>). /// /// </para> /// /// <para> /// When the celebrity recognition operation finishes, Amazon Rekognition Video publishes /// a completion status to the Amazon Simple Notification Service topic registered in /// the initial call to <code>StartCelebrityRecognition</code>. To get the results of /// the celebrity recognition analysis, first check that the status value published to /// the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. /// /// </para> /// /// <para> /// For more information, see Working With Stored Videos in the Amazon Rekognition Developer /// Guide. /// </para> /// /// <para> /// <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) /// they are detected in an array (<code>Celebrities</code>) of <a>CelebrityRecognition</a> /// objects. Each <code>CelebrityRecognition</code> contains information about the celebrity /// in a <a>CelebrityDetail</a> object and the time, <code>Timestamp</code>, the celebrity /// was detected. This <a>CelebrityDetail</a> object stores information about the detected /// celebrity's face attributes, a face bounding box, known gender, the celebrity's name, /// and a confidence estimate. /// </para> /// <note> /// <para> /// <code>GetCelebrityRecognition</code> only returns the default facial attributes (<code>BoundingBox</code>, /// <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). /// The <code>BoundingBox</code> field only applies to the detected face instance. The /// other facial attributes listed in the <code>Face</code> object of the following response /// syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition /// Developer Guide. /// </para> /// </note> /// <para> /// By default, the <code>Celebrities</code> array is sorted by time (milliseconds from /// the start of the video). You can also sort the array by celebrity by specifying the /// value <code>ID</code> in the <code>SortBy</code> input parameter. /// </para> /// /// <para> /// The <code>CelebrityDetail</code> object includes the celebrity identifer and additional /// information urls. If you don't store the additional information urls, you can get /// them later by calling <a>GetCelebrityInfo</a> with the celebrity identifer. /// </para> /// /// <para> /// No information is returned for faces not recognized as celebrities. /// </para> /// /// <para> /// Use MaxResults parameter to limit the number of labels returned. If there are more /// results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> /// in the operation response contains a pagination token for getting the next set of /// results. To get the next page of results, call <code>GetCelebrityDetection</code> /// and populate the <code>NextToken</code> request parameter with the token value returned /// from the previous call to <code>GetCelebrityRecognition</code>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetCelebrityRecognition service method.</param> /// /// <returns>The response from the GetCelebrityRecognition service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityRecognition">REST API Reference for GetCelebrityRecognition Operation</seealso> GetCelebrityRecognitionResponse GetCelebrityRecognition(GetCelebrityRecognitionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetCelebrityRecognition operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetCelebrityRecognition operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCelebrityRecognition /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityRecognition">REST API Reference for GetCelebrityRecognition Operation</seealso> IAsyncResult BeginGetCelebrityRecognition(GetCelebrityRecognitionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetCelebrityRecognition operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCelebrityRecognition.</param> /// /// <returns>Returns a GetCelebrityRecognitionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityRecognition">REST API Reference for GetCelebrityRecognition Operation</seealso> GetCelebrityRecognitionResponse EndGetCelebrityRecognition(IAsyncResult asyncResult); #endregion #region GetContentModeration /// <summary> /// Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon /// Rekognition Video analysis started by <a>StartContentModeration</a>. For a list of /// moderation labels in Amazon Rekognition, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using /// the image and video moderation APIs</a>. /// /// /// <para> /// Amazon Rekognition Video inappropriate or offensive content detection in a stored /// video is an asynchronous operation. You start analysis by calling <a>StartContentModeration</a> /// which returns a job identifier (<code>JobId</code>). When analysis finishes, Amazon /// Rekognition Video publishes a completion status to the Amazon Simple Notification /// Service topic registered in the initial call to <code>StartContentModeration</code>. /// To get the results of the content analysis, first check that the status value published /// to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. /// /// </para> /// /// <para> /// For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers /// Guide. /// </para> /// /// <para> /// <code>GetContentModeration</code> returns detected inappropriate, unwanted, or offensive /// content moderation labels, and the time they are detected, in an array, <code>ModerationLabels</code>, /// of <a>ContentModerationDetection</a> objects. /// </para> /// /// <para> /// By default, the moderated labels are returned sorted by time, in milliseconds from /// the start of the video. You can also sort them by moderated label by specifying <code>NAME</code> /// for the <code>SortBy</code> input parameter. /// </para> /// /// <para> /// Since video analysis can return a large number of results, use the <code>MaxResults</code> /// parameter to limit the number of labels returned in a single call to <code>GetContentModeration</code>. /// If there are more results than specified in <code>MaxResults</code>, the value of /// <code>NextToken</code> in the operation response contains a pagination token for getting /// the next set of results. To get the next page of results, call <code>GetContentModeration</code> /// and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code> /// returned from the previous call to <code>GetContentModeration</code>. /// </para> /// /// <para> /// For more information, see moderating content in the Amazon Rekognition Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetContentModeration service method.</param> /// /// <returns>The response from the GetContentModeration service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetContentModeration">REST API Reference for GetContentModeration Operation</seealso> GetContentModerationResponse GetContentModeration(GetContentModerationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetContentModeration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetContentModeration operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetContentModeration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetContentModeration">REST API Reference for GetContentModeration Operation</seealso> IAsyncResult BeginGetContentModeration(GetContentModerationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetContentModeration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetContentModeration.</param> /// /// <returns>Returns a GetContentModerationResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetContentModeration">REST API Reference for GetContentModeration Operation</seealso> GetContentModerationResponse EndGetContentModeration(IAsyncResult asyncResult); #endregion #region GetFaceDetection /// <summary> /// Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>. /// /// /// <para> /// Face detection with Amazon Rekognition Video is an asynchronous operation. You start /// face detection by calling <a>StartFaceDetection</a> which returns a job identifier /// (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition /// Video publishes a completion status to the Amazon Simple Notification Service topic /// registered in the initial call to <code>StartFaceDetection</code>. To get the results /// of the face detection operation, first check that the status value published to the /// Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and /// pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>. /// </para> /// /// <para> /// <code>GetFaceDetection</code> returns an array of detected faces (<code>Faces</code>) /// sorted by the time the faces were detected. /// </para> /// /// <para> /// Use MaxResults parameter to limit the number of labels returned. If there are more /// results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> /// in the operation response contains a pagination token for getting the next set of /// results. To get the next page of results, call <code>GetFaceDetection</code> and populate /// the <code>NextToken</code> request parameter with the token value returned from the /// previous call to <code>GetFaceDetection</code>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetFaceDetection service method.</param> /// /// <returns>The response from the GetFaceDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceDetection">REST API Reference for GetFaceDetection Operation</seealso> GetFaceDetectionResponse GetFaceDetection(GetFaceDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetFaceDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetFaceDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetFaceDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceDetection">REST API Reference for GetFaceDetection Operation</seealso> IAsyncResult BeginGetFaceDetection(GetFaceDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetFaceDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetFaceDetection.</param> /// /// <returns>Returns a GetFaceDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceDetection">REST API Reference for GetFaceDetection Operation</seealso> GetFaceDetectionResponse EndGetFaceDetection(IAsyncResult asyncResult); #endregion #region GetFaceLivenessSessionResults /// <summary> /// Retrieves the results of a specific Face Liveness session. It requires the <code>sessionId</code> /// as input, which was created using <code>CreateFaceLivenessSession</code>. Returns /// the corresponding Face Liveness confidence score, a reference image that includes /// a face bounding box, and audit images that also contain face bounding boxes. The Face /// Liveness confidence score ranges from 0 to 100. The reference image can optionally /// be returned. /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetFaceLivenessSessionResults service method.</param> /// /// <returns>The response from the GetFaceLivenessSessionResults service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.SessionNotFoundException"> /// Occurs when a given sessionId is not found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceLivenessSessionResults">REST API Reference for GetFaceLivenessSessionResults Operation</seealso> GetFaceLivenessSessionResultsResponse GetFaceLivenessSessionResults(GetFaceLivenessSessionResultsRequest request); /// <summary> /// Initiates the asynchronous execution of the GetFaceLivenessSessionResults operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetFaceLivenessSessionResults operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetFaceLivenessSessionResults /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceLivenessSessionResults">REST API Reference for GetFaceLivenessSessionResults Operation</seealso> IAsyncResult BeginGetFaceLivenessSessionResults(GetFaceLivenessSessionResultsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetFaceLivenessSessionResults operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetFaceLivenessSessionResults.</param> /// /// <returns>Returns a GetFaceLivenessSessionResultsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceLivenessSessionResults">REST API Reference for GetFaceLivenessSessionResults Operation</seealso> GetFaceLivenessSessionResultsResponse EndGetFaceLivenessSessionResults(IAsyncResult asyncResult); #endregion #region GetFaceSearch /// <summary> /// Gets the face search results for Amazon Rekognition Video face search started by <a>StartFaceSearch</a>. /// The search returns faces in a collection that match the faces of persons detected /// in a video. It also includes the time(s) that faces are matched in the video. /// /// /// <para> /// Face search in a video is an asynchronous operation. You start face search by calling /// to <a>StartFaceSearch</a> which returns a job identifier (<code>JobId</code>). When /// the search operation finishes, Amazon Rekognition Video publishes a completion status /// to the Amazon Simple Notification Service topic registered in the initial call to /// <code>StartFaceSearch</code>. To get the search results, first check that the status /// value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. /// </para> /// /// <para> /// For more information, see Searching Faces in a Collection in the Amazon Rekognition /// Developer Guide. /// </para> /// /// <para> /// The search results are retured in an array, <code>Persons</code>, of <a>PersonMatch</a> /// objects. Each<code>PersonMatch</code> element contains details about the matching /// faces in the input collection, person information (facial attributes, bounding boxes, /// and person identifer) for the matched person, and the time the person was matched /// in the video. /// </para> /// <note> /// <para> /// <code>GetFaceSearch</code> only returns the default facial attributes (<code>BoundingBox</code>, /// <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). /// The other facial attributes listed in the <code>Face</code> object of the following /// response syntax are not returned. For more information, see FaceDetail in the Amazon /// Rekognition Developer Guide. /// </para> /// </note> /// <para> /// By default, the <code>Persons</code> array is sorted by the time, in milliseconds /// from the start of the video, persons are matched. You can also sort by persons by /// specifying <code>INDEX</code> for the <code>SORTBY</code> input parameter. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetFaceSearch service method.</param> /// /// <returns>The response from the GetFaceSearch service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceSearch">REST API Reference for GetFaceSearch Operation</seealso> GetFaceSearchResponse GetFaceSearch(GetFaceSearchRequest request); /// <summary> /// Initiates the asynchronous execution of the GetFaceSearch operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetFaceSearch operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetFaceSearch /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceSearch">REST API Reference for GetFaceSearch Operation</seealso> IAsyncResult BeginGetFaceSearch(GetFaceSearchRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetFaceSearch operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetFaceSearch.</param> /// /// <returns>Returns a GetFaceSearchResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetFaceSearch">REST API Reference for GetFaceSearch Operation</seealso> GetFaceSearchResponse EndGetFaceSearch(IAsyncResult asyncResult); #endregion #region GetLabelDetection /// <summary> /// Gets the label detection results of a Amazon Rekognition Video analysis started by /// <a>StartLabelDetection</a>. /// /// /// <para> /// The label detection operation is started by a call to <a>StartLabelDetection</a> which /// returns a job identifier (<code>JobId</code>). When the label detection operation /// finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification /// Service topic registered in the initial call to <code>StartlabelDetection</code>. /// /// </para> /// /// <para> /// To get the results of the label detection operation, first check that the status value /// published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>. /// </para> /// /// <para> /// <code>GetLabelDetection</code> returns an array of detected labels (<code>Labels</code>) /// sorted by the time the labels were detected. You can also sort by the label name by /// specifying <code>NAME</code> for the <code>SortBy</code> input parameter. If there /// is no <code>NAME</code> specified, the default sort is by timestamp. /// </para> /// /// <para> /// You can select how results are aggregated by using the <code>AggregateBy</code> input /// parameter. The default aggregation method is <code>TIMESTAMPS</code>. You can also /// aggregate by <code>SEGMENTS</code>, which aggregates all instances of labels detected /// in a given segment. /// </para> /// /// <para> /// The returned Labels array may include the following attributes: /// </para> /// <ul> <li> /// <para> /// Name - The name of the detected label. /// </para> /// </li> <li> /// <para> /// Confidence - The level of confidence in the label assigned to a detected object. /// </para> /// </li> <li> /// <para> /// Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical /// taxonomy of detected labels. For example, a detected car might be assigned the label /// car. The label car has two parent labels: Vehicle (its parent) and Transportation /// (its grandparent). The response includes the all ancestors for a label, where every /// ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation /// are returned as unique labels in the response. /// </para> /// </li> <li> /// <para> /// Aliases - Possible Aliases for the label. /// </para> /// </li> <li> /// <para> /// Categories - The label categories that the detected label belongs to. /// </para> /// </li> <li> /// <para> /// BoundingBox — Bounding boxes are described for all instances of detected common object /// labels, returned in an array of Instance objects. An Instance object contains a BoundingBox /// object, describing the location of the label on the input image. It also includes /// the confidence for the accuracy of the detected bounding box. /// </para> /// </li> <li> /// <para> /// Timestamp - Time, in milliseconds from the start of the video, that the label was /// detected. For aggregation by <code>SEGMENTS</code>, the <code>StartTimestampMillis</code>, /// <code>EndTimestampMillis</code>, and <code>DurationMillis</code> structures are what /// define a segment. Although the “Timestamp†structure is still returned with each label, /// its value is set to be the same as <code>StartTimestampMillis</code>. /// </para> /// </li> </ul> /// <para> /// Timestamp and Bounding box information are returned for detected Instances, only if /// aggregation is done by <code>TIMESTAMPS</code>. If aggregating by <code>SEGMENTS</code>, /// information about detected instances isn’t returned. /// </para> /// /// <para> /// The version of the label model used for the detection is also returned. /// </para> /// /// <para> /// <b>Note <code>DominantColors</code> isn't returned for <code>Instances</code>, although /// it is shown as part of the response in the sample seen below.</b> /// </para> /// /// <para> /// Use <code>MaxResults</code> parameter to limit the number of labels returned. If there /// are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> /// in the operation response contains a pagination token for getting the next set of /// results. To get the next page of results, call <code>GetlabelDetection</code> and /// populate the <code>NextToken</code> request parameter with the token value returned /// from the previous call to <code>GetLabelDetection</code>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetLabelDetection service method.</param> /// /// <returns>The response from the GetLabelDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetLabelDetection">REST API Reference for GetLabelDetection Operation</seealso> GetLabelDetectionResponse GetLabelDetection(GetLabelDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetLabelDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetLabelDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLabelDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetLabelDetection">REST API Reference for GetLabelDetection Operation</seealso> IAsyncResult BeginGetLabelDetection(GetLabelDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetLabelDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetLabelDetection.</param> /// /// <returns>Returns a GetLabelDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetLabelDetection">REST API Reference for GetLabelDetection Operation</seealso> GetLabelDetectionResponse EndGetLabelDetection(IAsyncResult asyncResult); #endregion #region GetPersonTracking /// <summary> /// Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>. /// /// /// <para> /// The person path tracking operation is started by a call to <code>StartPersonTracking</code> /// which returns a job identifier (<code>JobId</code>). When the operation finishes, /// Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification /// Service topic registered in the initial call to <code>StartPersonTracking</code>. /// </para> /// /// <para> /// To get the results of the person path tracking operation, first check that the status /// value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>. /// </para> /// /// <para> /// <code>GetPersonTracking</code> returns an array, <code>Persons</code>, of tracked /// persons and the time(s) their paths were tracked in the video. /// </para> /// <note> /// <para> /// <code>GetPersonTracking</code> only returns the default facial attributes (<code>BoundingBox</code>, /// <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). /// The other facial attributes listed in the <code>Face</code> object of the following /// response syntax are not returned. /// </para> /// /// <para> /// For more information, see FaceDetail in the Amazon Rekognition Developer Guide. /// </para> /// </note> /// <para> /// By default, the array is sorted by the time(s) a person's path is tracked in the video. /// You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> /// input parameter. /// </para> /// /// <para> /// Use the <code>MaxResults</code> parameter to limit the number of items returned. If /// there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> /// in the operation response contains a pagination token for getting the next set of /// results. To get the next page of results, call <code>GetPersonTracking</code> and /// populate the <code>NextToken</code> request parameter with the token value returned /// from the previous call to <code>GetPersonTracking</code>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetPersonTracking service method.</param> /// /// <returns>The response from the GetPersonTracking service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetPersonTracking">REST API Reference for GetPersonTracking Operation</seealso> GetPersonTrackingResponse GetPersonTracking(GetPersonTrackingRequest request); /// <summary> /// Initiates the asynchronous execution of the GetPersonTracking operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetPersonTracking operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPersonTracking /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetPersonTracking">REST API Reference for GetPersonTracking Operation</seealso> IAsyncResult BeginGetPersonTracking(GetPersonTrackingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetPersonTracking operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPersonTracking.</param> /// /// <returns>Returns a GetPersonTrackingResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetPersonTracking">REST API Reference for GetPersonTracking Operation</seealso> GetPersonTrackingResponse EndGetPersonTracking(IAsyncResult asyncResult); #endregion #region GetSegmentDetection /// <summary> /// Gets the segment detection results of a Amazon Rekognition Video analysis started /// by <a>StartSegmentDetection</a>. /// /// /// <para> /// Segment detection with Amazon Rekognition Video is an asynchronous operation. You /// start segment detection by calling <a>StartSegmentDetection</a> which returns a job /// identifier (<code>JobId</code>). When the segment detection operation finishes, Amazon /// Rekognition publishes a completion status to the Amazon Simple Notification Service /// topic registered in the initial call to <code>StartSegmentDetection</code>. To get /// the results of the segment detection operation, first check that the status value /// published to the Amazon SNS topic is <code>SUCCEEDED</code>. if so, call <code>GetSegmentDetection</code> /// and pass the job identifier (<code>JobId</code>) from the initial call of <code>StartSegmentDetection</code>. /// </para> /// /// <para> /// <code>GetSegmentDetection</code> returns detected segments in an array (<code>Segments</code>) /// of <a>SegmentDetection</a> objects. <code>Segments</code> is sorted by the segment /// types specified in the <code>SegmentTypes</code> input parameter of <code>StartSegmentDetection</code>. /// Each element of the array includes the detected segment, the precentage confidence /// in the acuracy of the detected segment, the type of the segment, and the frame in /// which the segment was detected. /// </para> /// /// <para> /// Use <code>SelectedSegmentTypes</code> to find out the type of segment detection requested /// in the call to <code>StartSegmentDetection</code>. /// </para> /// /// <para> /// Use the <code>MaxResults</code> parameter to limit the number of segment detections /// returned. If there are more results than specified in <code>MaxResults</code>, the /// value of <code>NextToken</code> in the operation response contains a pagination token /// for getting the next set of results. To get the next page of results, call <code>GetSegmentDetection</code> /// and populate the <code>NextToken</code> request parameter with the token value returned /// from the previous call to <code>GetSegmentDetection</code>. /// </para> /// /// <para> /// For more information, see Detecting video segments in stored video in the Amazon Rekognition /// Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetSegmentDetection service method.</param> /// /// <returns>The response from the GetSegmentDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetSegmentDetection">REST API Reference for GetSegmentDetection Operation</seealso> GetSegmentDetectionResponse GetSegmentDetection(GetSegmentDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetSegmentDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetSegmentDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSegmentDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetSegmentDetection">REST API Reference for GetSegmentDetection Operation</seealso> IAsyncResult BeginGetSegmentDetection(GetSegmentDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetSegmentDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSegmentDetection.</param> /// /// <returns>Returns a GetSegmentDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetSegmentDetection">REST API Reference for GetSegmentDetection Operation</seealso> GetSegmentDetectionResponse EndGetSegmentDetection(IAsyncResult asyncResult); #endregion #region GetTextDetection /// <summary> /// Gets the text detection results of a Amazon Rekognition Video analysis started by /// <a>StartTextDetection</a>. /// /// /// <para> /// Text detection with Amazon Rekognition Video is an asynchronous operation. You start /// text detection by calling <a>StartTextDetection</a> which returns a job identifier /// (<code>JobId</code>) When the text detection operation finishes, Amazon Rekognition /// publishes a completion status to the Amazon Simple Notification Service topic registered /// in the initial call to <code>StartTextDetection</code>. To get the results of the /// text detection operation, first check that the status value published to the Amazon /// SNS topic is <code>SUCCEEDED</code>. if so, call <code>GetTextDetection</code> and /// pass the job identifier (<code>JobId</code>) from the initial call of <code>StartLabelDetection</code>. /// </para> /// /// <para> /// <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) /// sorted by the time the text was detected, up to 50 words per frame of video. /// </para> /// /// <para> /// Each element of the array includes the detected text, the precentage confidence in /// the acuracy of the detected text, the time the text was detected, bounding box information /// for where the text was located, and unique identifiers for words and their lines. /// </para> /// /// <para> /// Use MaxResults parameter to limit the number of text detections returned. If there /// are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> /// in the operation response contains a pagination token for getting the next set of /// results. To get the next page of results, call <code>GetTextDetection</code> and populate /// the <code>NextToken</code> request parameter with the token value returned from the /// previous call to <code>GetTextDetection</code>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetTextDetection service method.</param> /// /// <returns>The response from the GetTextDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetTextDetection">REST API Reference for GetTextDetection Operation</seealso> GetTextDetectionResponse GetTextDetection(GetTextDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetTextDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetTextDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTextDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetTextDetection">REST API Reference for GetTextDetection Operation</seealso> IAsyncResult BeginGetTextDetection(GetTextDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetTextDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTextDetection.</param> /// /// <returns>Returns a GetTextDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetTextDetection">REST API Reference for GetTextDetection Operation</seealso> GetTextDetectionResponse EndGetTextDetection(IAsyncResult asyncResult); #endregion #region IndexFaces /// <summary> /// Detects faces in the input image and adds them to the specified collection. /// /// /// <para> /// Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying /// detection algorithm first detects the faces in the input image. For each face, the /// algorithm extracts facial features into a feature vector, and stores it in the backend /// database. Amazon Rekognition uses feature vectors when it performs face match and /// search operations using the <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations. /// </para> /// /// <para> /// For more information, see Adding faces to a collection in the Amazon Rekognition Developer /// Guide. /// </para> /// /// <para> /// To get the number of faces in a collection, call <a>DescribeCollection</a>. /// </para> /// /// <para> /// If you're using version 1.0 of the face detection model, <code>IndexFaces</code> indexes /// the 15 largest faces in the input image. Later versions of the face detection model /// index the 100 largest faces in the input image. /// </para> /// /// <para> /// If you're using version 4 or later of the face model, image orientation information /// is not returned in the <code>OrientationCorrection</code> field. /// </para> /// /// <para> /// To determine which version of the model you're using, call <a>DescribeCollection</a> /// and supply the collection ID. You can also get the model version from the value of /// <code>FaceModelVersion</code> in the response from <code>IndexFaces</code> /// </para> /// /// <para> /// For more information, see Model Versioning in the Amazon Rekognition Developer Guide. /// </para> /// /// <para> /// If you provide the optional <code>ExternalImageId</code> for the input image you provided, /// Amazon Rekognition associates this ID with all faces that it detects. When you call /// the <a>ListFaces</a> operation, the response returns the external ID. You can use /// this external image ID to create a client-side index to associate the faces with each /// image. You can then use the index to find all faces in an image. /// </para> /// /// <para> /// You can specify the maximum number of faces to index with the <code>MaxFaces</code> /// input parameter. This is useful when you want to index the largest faces in an image /// and don't want to index smaller faces, such as those belonging to people standing /// in the background. /// </para> /// /// <para> /// The <code>QualityFilter</code> input parameter allows you to filter out detected faces /// that don’t meet a required quality bar. The quality bar is based on a variety of common /// use cases. By default, <code>IndexFaces</code> chooses the quality bar that's used /// to filter faces. You can also explicitly choose the quality bar. Use <code>QualityFilter</code>, /// to set the quality bar by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. /// If you do not want to filter detected faces, specify <code>NONE</code>. /// </para> /// <note> /// <para> /// To use quality filtering, you need a collection associated with version 3 of the face /// model or higher. To get the version of the face model associated with a collection, /// call <a>DescribeCollection</a>. /// </para> /// </note> /// <para> /// Information about faces detected in an image, but not indexed, is returned in an array /// of <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't indexed /// for reasons such as: /// </para> /// <ul> <li> /// <para> /// The number of faces detected exceeds the value of the <code>MaxFaces</code> request /// parameter. /// </para> /// </li> <li> /// <para> /// The face is too small compared to the image dimensions. /// </para> /// </li> <li> /// <para> /// The face is too blurry. /// </para> /// </li> <li> /// <para> /// The image is too dark. /// </para> /// </li> <li> /// <para> /// The face has an extreme pose. /// </para> /// </li> <li> /// <para> /// The face doesn’t have enough detail to be suitable for face search. /// </para> /// </li> </ul> /// <para> /// In response, the <code>IndexFaces</code> operation returns an array of metadata for /// all detected faces, <code>FaceRecords</code>. This includes: /// </para> /// <ul> <li> /// <para> /// The bounding box, <code>BoundingBox</code>, of the detected face. /// </para> /// </li> <li> /// <para> /// A confidence value, <code>Confidence</code>, which indicates the confidence that the /// bounding box contains a face. /// </para> /// </li> <li> /// <para> /// A face ID, <code>FaceId</code>, assigned by the service for each face that's detected /// and stored. /// </para> /// </li> <li> /// <para> /// An image ID, <code>ImageId</code>, assigned by the service for the input image. /// </para> /// </li> </ul> /// <para> /// If you request <code>ALL</code> or specific facial attributes (e.g., <code>FACE_OCCLUDED</code>) /// by using the detectionAttributes parameter, Amazon Rekognition returns detailed facial /// attributes, such as facial landmarks (for example, location of eye and mouth), facial /// occlusion, and other facial attributes. /// </para> /// /// <para> /// If you provide the same image, specify the same collection, and use the same external /// ID in the <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate /// face metadata. /// </para> /// /// <para> /// The input image is passed either as base64-encoded image bytes, or as a reference /// to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition /// operations, passing image bytes isn't supported. The image must be formatted as a /// PNG or JPEG file. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:IndexFaces</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the IndexFaces service method.</param> /// /// <returns>The response from the IndexFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/IndexFaces">REST API Reference for IndexFaces Operation</seealso> IndexFacesResponse IndexFaces(IndexFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the IndexFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the IndexFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndIndexFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/IndexFaces">REST API Reference for IndexFaces Operation</seealso> IAsyncResult BeginIndexFaces(IndexFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the IndexFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexFaces.</param> /// /// <returns>Returns a IndexFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/IndexFaces">REST API Reference for IndexFaces Operation</seealso> IndexFacesResponse EndIndexFaces(IAsyncResult asyncResult); #endregion #region ListCollections /// <summary> /// Returns list of collection IDs in your account. If the result is truncated, the response /// also provides a <code>NextToken</code> that you can use in the subsequent request /// to fetch the next set of collection IDs. /// /// /// <para> /// For an example, see Listing collections in the Amazon Rekognition Developer Guide. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:ListCollections</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListCollections service method.</param> /// /// <returns>The response from the ListCollections service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListCollections">REST API Reference for ListCollections Operation</seealso> ListCollectionsResponse ListCollections(ListCollectionsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListCollections operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListCollections operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListCollections /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListCollections">REST API Reference for ListCollections Operation</seealso> IAsyncResult BeginListCollections(ListCollectionsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListCollections operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListCollections.</param> /// /// <returns>Returns a ListCollectionsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListCollections">REST API Reference for ListCollections Operation</seealso> ListCollectionsResponse EndListCollections(IAsyncResult asyncResult); #endregion #region ListDatasetEntries /// <summary> /// Lists the entries (images) within a dataset. An entry is a JSON Line that contains /// the information for a single image, including the image location, assigned labels, /// and object location bounding boxes. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html">Creating /// a manifest file</a>. /// /// /// <para> /// JSON Lines in the response include information about non-terminal errors found in /// the dataset. Non terminal errors are reported in <code>errors</code> lists within /// each JSON Line. The same information is reported in the training and testing validation /// result manifests that Amazon Rekognition Custom Labels creates during model training. /// /// </para> /// /// <para> /// You can filter the response in variety of ways, such as choosing which labels to return /// and returning JSON Lines created after a specific date. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:ListDatasetEntries</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListDatasetEntries service method.</param> /// /// <returns>The response from the ListDatasetEntries service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotReadyException"> /// The requested resource isn't ready. For example, this exception occurs when you call /// <code>DetectCustomLabels</code> with a model version that isn't deployed. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetEntries">REST API Reference for ListDatasetEntries Operation</seealso> ListDatasetEntriesResponse ListDatasetEntries(ListDatasetEntriesRequest request); /// <summary> /// Initiates the asynchronous execution of the ListDatasetEntries operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListDatasetEntries operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDatasetEntries /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetEntries">REST API Reference for ListDatasetEntries Operation</seealso> IAsyncResult BeginListDatasetEntries(ListDatasetEntriesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListDatasetEntries operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListDatasetEntries.</param> /// /// <returns>Returns a ListDatasetEntriesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetEntries">REST API Reference for ListDatasetEntries Operation</seealso> ListDatasetEntriesResponse EndListDatasetEntries(IAsyncResult asyncResult); #endregion #region ListDatasetLabels /// <summary> /// Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe /// images. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html">Labeling /// images</a>. /// /// /// <para> /// Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe /// images. For more information, see Labeling images in the <i>Amazon Rekognition Custom /// Labels Developer Guide</i>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListDatasetLabels service method.</param> /// /// <returns>The response from the ListDatasetLabels service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotReadyException"> /// The requested resource isn't ready. For example, this exception occurs when you call /// <code>DetectCustomLabels</code> with a model version that isn't deployed. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetLabels">REST API Reference for ListDatasetLabels Operation</seealso> ListDatasetLabelsResponse ListDatasetLabels(ListDatasetLabelsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListDatasetLabels operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListDatasetLabels operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDatasetLabels /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetLabels">REST API Reference for ListDatasetLabels Operation</seealso> IAsyncResult BeginListDatasetLabels(ListDatasetLabelsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListDatasetLabels operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListDatasetLabels.</param> /// /// <returns>Returns a ListDatasetLabelsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetLabels">REST API Reference for ListDatasetLabels Operation</seealso> ListDatasetLabelsResponse EndListDatasetLabels(IAsyncResult asyncResult); #endregion #region ListFaces /// <summary> /// Returns metadata for faces in the specified collection. This metadata includes information /// such as the bounding box coordinates, the confidence (that the bounding box contains /// a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon /// Rekognition Developer Guide. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:ListFaces</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListFaces service method.</param> /// /// <returns>The response from the ListFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListFaces">REST API Reference for ListFaces Operation</seealso> ListFacesResponse ListFaces(ListFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the ListFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListFaces">REST API Reference for ListFaces Operation</seealso> IAsyncResult BeginListFaces(ListFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListFaces.</param> /// /// <returns>Returns a ListFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListFaces">REST API Reference for ListFaces Operation</seealso> ListFacesResponse EndListFaces(IAsyncResult asyncResult); #endregion #region ListProjectPolicies /// <summary> /// Gets a list of the project policies attached to a project. /// /// /// <para> /// To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a /// project policy from a project, call <a>DeleteProjectPolicy</a>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:ListProjectPolicies</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListProjectPolicies service method.</param> /// /// <returns>The response from the ListProjectPolicies service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListProjectPolicies">REST API Reference for ListProjectPolicies Operation</seealso> ListProjectPoliciesResponse ListProjectPolicies(ListProjectPoliciesRequest request); /// <summary> /// Initiates the asynchronous execution of the ListProjectPolicies operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListProjectPolicies operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListProjectPolicies /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListProjectPolicies">REST API Reference for ListProjectPolicies Operation</seealso> IAsyncResult BeginListProjectPolicies(ListProjectPoliciesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListProjectPolicies operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListProjectPolicies.</param> /// /// <returns>Returns a ListProjectPoliciesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListProjectPolicies">REST API Reference for ListProjectPolicies Operation</seealso> ListProjectPoliciesResponse EndListProjectPolicies(IAsyncResult asyncResult); #endregion #region ListStreamProcessors /// <summary> /// Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListStreamProcessors service method.</param> /// /// <returns>The response from the ListStreamProcessors service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListStreamProcessors">REST API Reference for ListStreamProcessors Operation</seealso> ListStreamProcessorsResponse ListStreamProcessors(ListStreamProcessorsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListStreamProcessors operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListStreamProcessors operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStreamProcessors /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListStreamProcessors">REST API Reference for ListStreamProcessors Operation</seealso> IAsyncResult BeginListStreamProcessors(ListStreamProcessorsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListStreamProcessors operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListStreamProcessors.</param> /// /// <returns>Returns a ListStreamProcessorsResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListStreamProcessors">REST API Reference for ListStreamProcessors Operation</seealso> ListStreamProcessorsResponse EndListStreamProcessors(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// <summary> /// Returns a list of tags in an Amazon Rekognition collection, stream processor, or /// Custom Labels model. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:ListTagsForResource</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> /// /// <returns>The response from the ListTagsForResource service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// <summary> /// Initiates the asynchronous execution of the ListTagsForResource operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListTagsForResource operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListTagsForResource.</param> /// /// <returns>Returns a ListTagsForResourceResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region ListUsers /// <summary> /// 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. /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListUsers service method.</param> /// /// <returns>The response from the ListUsers service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPaginationTokenException"> /// Pagination token in the request is not valid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListUsers">REST API Reference for ListUsers Operation</seealso> ListUsersResponse ListUsers(ListUsersRequest request); /// <summary> /// Initiates the asynchronous execution of the ListUsers operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListUsers operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUsers /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListUsers">REST API Reference for ListUsers Operation</seealso> IAsyncResult BeginListUsers(ListUsersRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListUsers operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListUsers.</param> /// /// <returns>Returns a ListUsersResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListUsers">REST API Reference for ListUsers Operation</seealso> ListUsersResponse EndListUsers(IAsyncResult asyncResult); #endregion #region PutProjectPolicy /// <summary> /// Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting /// AWS account. A project policy specifies that a trusted AWS account can copy a model /// version from a trusting AWS account to a project in the trusted AWS account. To copy /// a model version you use the <a>CopyProjectVersion</a> operation. /// /// /// <para> /// For more information about the format of a project policy document, see Attaching /// a project policy (SDK) in the <i>Amazon Rekognition Custom Labels Developer Guide</i>. /// /// </para> /// /// <para> /// The response from <code>PutProjectPolicy</code> is a revision ID for the project policy. /// You can attach multiple project policies to a project. You can also update an existing /// project policy by specifying the policy revision ID of the existing policy. /// </para> /// /// <para> /// To remove a project policy from a project, call <a>DeleteProjectPolicy</a>. To get /// a list of project policies attached to a project, call <a>ListProjectPolicies</a>. /// /// </para> /// /// <para> /// You copy a model version by calling <a>CopyProjectVersion</a>. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:PutProjectPolicy</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutProjectPolicy service method.</param> /// /// <returns>The response from the PutProjectPolicy service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidPolicyRevisionIdException"> /// The supplied revision id for the project policy is invalid. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.MalformedPolicyDocumentException"> /// The format of the project policy document that you supplied to <code>PutProjectPolicy</code> /// is incorrect. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceAlreadyExistsException"> /// A resource with the specified ID already exists. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/PutProjectPolicy">REST API Reference for PutProjectPolicy Operation</seealso> PutProjectPolicyResponse PutProjectPolicy(PutProjectPolicyRequest request); /// <summary> /// Initiates the asynchronous execution of the PutProjectPolicy operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutProjectPolicy operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutProjectPolicy /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/PutProjectPolicy">REST API Reference for PutProjectPolicy Operation</seealso> IAsyncResult BeginPutProjectPolicy(PutProjectPolicyRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutProjectPolicy operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutProjectPolicy.</param> /// /// <returns>Returns a PutProjectPolicyResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/PutProjectPolicy">REST API Reference for PutProjectPolicy Operation</seealso> PutProjectPolicyResponse EndPutProjectPolicy(IAsyncResult asyncResult); #endregion #region RecognizeCelebrities /// <summary> /// Returns an array of celebrities recognized in the input image. For more information, /// see Recognizing celebrities in the Amazon Rekognition Developer Guide. /// /// /// <para> /// <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists /// the recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized /// faces in the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> /// doesn't return celebrities whose faces aren't among the largest 64 faces in the image. /// </para> /// /// <para> /// For each celebrity recognized, <code>RecognizeCelebrities</code> returns a <code>Celebrity</code> /// object. The <code>Celebrity</code> object contains the celebrity name, ID, URL links /// to additional information, match confidence, and a <code>ComparedFace</code> object /// that you can use to locate the celebrity's face on the image. /// </para> /// /// <para> /// Amazon Rekognition doesn't retain information about which images a celebrity has been /// recognized in. Your application must store this information and use the <code>Celebrity</code> /// ID property as a unique identifier for the celebrity. If you don't store the celebrity /// name or additional information URLs returned by <code>RecognizeCelebrities</code>, /// you will need the ID to identify the celebrity in a call to the <a>GetCelebrityInfo</a> /// operation. /// </para> /// /// <para> /// You pass the input image either as base64-encoded image bytes or as a reference to /// an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition /// operations, passing image bytes is not supported. The image must be either a PNG or /// JPEG formatted file. /// </para> /// /// <para> /// For an example, see Recognizing celebrities in an image in the Amazon Rekognition /// Developer Guide. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:RecognizeCelebrities</code> /// operation. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the RecognizeCelebrities service method.</param> /// /// <returns>The response from the RecognizeCelebrities service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/RecognizeCelebrities">REST API Reference for RecognizeCelebrities Operation</seealso> RecognizeCelebritiesResponse RecognizeCelebrities(RecognizeCelebritiesRequest request); /// <summary> /// Initiates the asynchronous execution of the RecognizeCelebrities operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the RecognizeCelebrities operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRecognizeCelebrities /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/RecognizeCelebrities">REST API Reference for RecognizeCelebrities Operation</seealso> IAsyncResult BeginRecognizeCelebrities(RecognizeCelebritiesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the RecognizeCelebrities operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginRecognizeCelebrities.</param> /// /// <returns>Returns a RecognizeCelebritiesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/RecognizeCelebrities">REST API Reference for RecognizeCelebrities Operation</seealso> RecognizeCelebritiesResponse EndRecognizeCelebrities(IAsyncResult asyncResult); #endregion #region SearchFaces /// <summary> /// For a given input face ID, searches for matching faces in the collection the face /// belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> /// operation. The operation compares the features of the input face with faces in the /// specified collection. /// /// <note> /// <para> /// You can also search faces without indexing faces by using the <code>SearchFacesByImage</code> /// operation. /// </para> /// </note> /// <para> /// The operation response returns an array of faces that match, ordered by similarity /// score with the highest similarity first. More specifically, it is an array of metadata /// for each face match that is found. Along with the metadata, the response also includes /// a <code>confidence</code> value for each face match, indicating the confidence that /// the specific face matches the input face. /// </para> /// /// <para> /// For an example, see Searching for a face using its face ID in the Amazon Rekognition /// Developer Guide. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:SearchFaces</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the SearchFaces service method.</param> /// /// <returns>The response from the SearchFaces service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFaces">REST API Reference for SearchFaces Operation</seealso> SearchFacesResponse SearchFaces(SearchFacesRequest request); /// <summary> /// Initiates the asynchronous execution of the SearchFaces operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the SearchFaces operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchFaces /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFaces">REST API Reference for SearchFaces Operation</seealso> IAsyncResult BeginSearchFaces(SearchFacesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the SearchFaces operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginSearchFaces.</param> /// /// <returns>Returns a SearchFacesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFaces">REST API Reference for SearchFaces Operation</seealso> SearchFacesResponse EndSearchFaces(IAsyncResult asyncResult); #endregion #region SearchFacesByImage /// <summary> /// For a given input image, first detects the largest face in the image, and then searches /// the specified collection for matching faces. The operation compares the features of /// the input face with faces in the specified collection. /// /// <note> /// <para> /// To search for all faces in an input image, you might first call the <a>IndexFaces</a> /// operation, and then use the face IDs returned in subsequent calls to the <a>SearchFaces</a> /// operation. /// </para> /// /// <para> /// You can also call the <code>DetectFaces</code> operation and use the bounding boxes /// in the response to make face crops, which then you can pass in to the <code>SearchFacesByImage</code> /// operation. /// </para> /// </note> /// <para> /// You pass the input image either as base64-encoded image bytes or as a reference to /// an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition /// operations, passing image bytes is not supported. The image must be either a PNG or /// JPEG formatted file. /// </para> /// /// <para> /// The response returns an array of faces that match, ordered by similarity score with /// the highest similarity first. More specifically, it is an array of metadata for each /// face match found. Along with the metadata, the response also includes a <code>similarity</code> /// indicating how similar the face is to the input face. In the response, the operation /// also returns the bounding box (and a confidence level that the bounding box contains /// a face) of the face that Amazon Rekognition used for the input image. /// </para> /// /// <para> /// If no faces are detected in the input image, <code>SearchFacesByImage</code> returns /// an <code>InvalidParameterException</code> error. /// </para> /// /// <para> /// For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer /// Guide. /// </para> /// /// <para> /// The <code>QualityFilter</code> input parameter allows you to filter out detected faces /// that don’t meet a required quality bar. The quality bar is based on a variety of common /// use cases. Use <code>QualityFilter</code> to set the quality bar for filtering by /// specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If you do /// not want to filter detected faces, specify <code>NONE</code>. The default value is /// <code>NONE</code>. /// </para> /// <note> /// <para> /// To use quality filtering, you need a collection associated with version 3 of the face /// model or higher. To get the version of the face model associated with a collection, /// call <a>DescribeCollection</a>. /// </para> /// </note> /// <para> /// This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the SearchFacesByImage service method.</param> /// /// <returns>The response from the SearchFacesByImage service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFacesByImage">REST API Reference for SearchFacesByImage Operation</seealso> SearchFacesByImageResponse SearchFacesByImage(SearchFacesByImageRequest request); /// <summary> /// Initiates the asynchronous execution of the SearchFacesByImage operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the SearchFacesByImage operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchFacesByImage /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFacesByImage">REST API Reference for SearchFacesByImage Operation</seealso> IAsyncResult BeginSearchFacesByImage(SearchFacesByImageRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the SearchFacesByImage operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginSearchFacesByImage.</param> /// /// <returns>Returns a SearchFacesByImageResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFacesByImage">REST API Reference for SearchFacesByImage Operation</seealso> SearchFacesByImageResponse EndSearchFacesByImage(IAsyncResult asyncResult); #endregion #region SearchUsers /// <summary> /// Searches for UserIDs within a collection based on a <code>FaceId</code> or <code>UserId</code>. /// This API can be used to find the closest UserID (with a highest similarity) to associate /// a face. The request must be provided with either <code>FaceId</code> or <code>UserId</code>. /// The operation returns an array of UserID that match the <code>FaceId</code> or <code>UserId</code>, /// ordered by similarity score with the highest similarity first. /// </summary> /// <param name="request">Container for the necessary parameters to execute the SearchUsers service method.</param> /// /// <returns>The response from the SearchUsers service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchUsers">REST API Reference for SearchUsers Operation</seealso> SearchUsersResponse SearchUsers(SearchUsersRequest request); /// <summary> /// Initiates the asynchronous execution of the SearchUsers operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the SearchUsers operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchUsers /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchUsers">REST API Reference for SearchUsers Operation</seealso> IAsyncResult BeginSearchUsers(SearchUsersRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the SearchUsers operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginSearchUsers.</param> /// /// <returns>Returns a SearchUsersResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchUsers">REST API Reference for SearchUsers Operation</seealso> SearchUsersResponse EndSearchUsers(IAsyncResult asyncResult); #endregion #region SearchUsersByImage /// <summary> /// Searches for UserIDs using a supplied image. It first detects the largest face in /// the image, and then searches a specified collection for matching UserIDs. /// /// /// <para> /// The operation returns an array of UserIDs that match the face in the supplied image, /// ordered by similarity score with the highest similarity first. It also returns a bounding /// box for the face found in the input image. /// </para> /// /// <para> /// Information about faces detected in the supplied image, but not used for the search, /// is returned in an array of <code>UnsearchedFace</code> objects. If no valid face is /// detected in the image, the response will contain an empty <code>UserMatches</code> /// list and no <code>SearchedFace</code> object. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the SearchUsersByImage service method.</param> /// /// <returns>The response from the SearchUsersByImage service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ImageTooLargeException"> /// The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, /// the image size or resolution exceeds the allowed limit. For more information, see /// Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidImageFormatException"> /// The provided image format is not supported. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchUsersByImage">REST API Reference for SearchUsersByImage Operation</seealso> SearchUsersByImageResponse SearchUsersByImage(SearchUsersByImageRequest request); /// <summary> /// Initiates the asynchronous execution of the SearchUsersByImage operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the SearchUsersByImage operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearchUsersByImage /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchUsersByImage">REST API Reference for SearchUsersByImage Operation</seealso> IAsyncResult BeginSearchUsersByImage(SearchUsersByImageRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the SearchUsersByImage operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginSearchUsersByImage.</param> /// /// <returns>Returns a SearchUsersByImageResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchUsersByImage">REST API Reference for SearchUsersByImage Operation</seealso> SearchUsersByImageResponse EndSearchUsersByImage(IAsyncResult asyncResult); #endregion #region StartCelebrityRecognition /// <summary> /// Starts asynchronous recognition of celebrities in a stored video. /// /// /// <para> /// Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon /// S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. /// <code>StartCelebrityRecognition</code> returns a job identifier (<code>JobId</code>) /// which you use to get the results of the analysis. When celebrity recognition analysis /// is finished, Amazon Rekognition Video publishes a completion status to the Amazon /// Simple Notification Service topic that you specify in <code>NotificationChannel</code>. /// To get the results of the celebrity recognition analysis, first check that the status /// value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. /// /// </para> /// /// <para> /// For more information, see Recognizing celebrities in the Amazon Rekognition Developer /// Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartCelebrityRecognition service method.</param> /// /// <returns>The response from the StartCelebrityRecognition service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartCelebrityRecognition">REST API Reference for StartCelebrityRecognition Operation</seealso> StartCelebrityRecognitionResponse StartCelebrityRecognition(StartCelebrityRecognitionRequest request); /// <summary> /// Initiates the asynchronous execution of the StartCelebrityRecognition operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartCelebrityRecognition operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartCelebrityRecognition /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartCelebrityRecognition">REST API Reference for StartCelebrityRecognition Operation</seealso> IAsyncResult BeginStartCelebrityRecognition(StartCelebrityRecognitionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartCelebrityRecognition operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartCelebrityRecognition.</param> /// /// <returns>Returns a StartCelebrityRecognitionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartCelebrityRecognition">REST API Reference for StartCelebrityRecognition Operation</seealso> StartCelebrityRecognitionResponse EndStartCelebrityRecognition(IAsyncResult asyncResult); #endregion #region StartContentModeration /// <summary> /// Starts asynchronous detection of inappropriate, unwanted, or offensive content in /// a stored video. For a list of moderation labels in Amazon Rekognition, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using /// the image and video moderation APIs</a>. /// /// /// <para> /// Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. /// Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartContentModeration</code> /// returns a job identifier (<code>JobId</code>) which you use to get the results of /// the analysis. When content analysis is finished, Amazon Rekognition Video publishes /// a completion status to the Amazon Simple Notification Service topic that you specify /// in <code>NotificationChannel</code>. /// </para> /// /// <para> /// To get the results of the content analysis, first check that the status value published /// to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. /// /// </para> /// /// <para> /// For more information, see Moderating content in the Amazon Rekognition Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartContentModeration service method.</param> /// /// <returns>The response from the StartContentModeration service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartContentModeration">REST API Reference for StartContentModeration Operation</seealso> StartContentModerationResponse StartContentModeration(StartContentModerationRequest request); /// <summary> /// Initiates the asynchronous execution of the StartContentModeration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartContentModeration operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartContentModeration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartContentModeration">REST API Reference for StartContentModeration Operation</seealso> IAsyncResult BeginStartContentModeration(StartContentModerationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartContentModeration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartContentModeration.</param> /// /// <returns>Returns a StartContentModerationResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartContentModeration">REST API Reference for StartContentModeration Operation</seealso> StartContentModerationResponse EndStartContentModeration(IAsyncResult asyncResult); #endregion #region StartFaceDetection /// <summary> /// Starts asynchronous detection of faces in a stored video. /// /// /// <para> /// Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. /// Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartFaceDetection</code> /// returns a job identifier (<code>JobId</code>) that you use to get the results of the /// operation. When face detection is finished, Amazon Rekognition Video publishes a completion /// status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. /// To get the results of the face detection operation, first check that the status value /// published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>. /// </para> /// /// <para> /// For more information, see Detecting faces in a stored video in the Amazon Rekognition /// Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartFaceDetection service method.</param> /// /// <returns>The response from the StartFaceDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartFaceDetection">REST API Reference for StartFaceDetection Operation</seealso> StartFaceDetectionResponse StartFaceDetection(StartFaceDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the StartFaceDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartFaceDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartFaceDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartFaceDetection">REST API Reference for StartFaceDetection Operation</seealso> IAsyncResult BeginStartFaceDetection(StartFaceDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartFaceDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartFaceDetection.</param> /// /// <returns>Returns a StartFaceDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartFaceDetection">REST API Reference for StartFaceDetection Operation</seealso> StartFaceDetectionResponse EndStartFaceDetection(IAsyncResult asyncResult); #endregion #region StartFaceSearch /// <summary> /// Starts the asynchronous search for faces in a collection that match the faces of persons /// detected in a stored video. /// /// /// <para> /// The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket /// name and the filename of the video. <code>StartFaceSearch</code> returns a job identifier /// (<code>JobId</code>) which you use to get the search results once the search has completed. /// When searching is finished, Amazon Rekognition Video publishes a completion status /// to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. /// To get the search results, first check that the status value published to the Amazon /// SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the /// job identifier (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. /// For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html">Searching /// stored videos for faces</a>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartFaceSearch service method.</param> /// /// <returns>The response from the StartFaceSearch service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartFaceSearch">REST API Reference for StartFaceSearch Operation</seealso> StartFaceSearchResponse StartFaceSearch(StartFaceSearchRequest request); /// <summary> /// Initiates the asynchronous execution of the StartFaceSearch operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartFaceSearch operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartFaceSearch /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartFaceSearch">REST API Reference for StartFaceSearch Operation</seealso> IAsyncResult BeginStartFaceSearch(StartFaceSearchRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartFaceSearch operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartFaceSearch.</param> /// /// <returns>Returns a StartFaceSearchResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartFaceSearch">REST API Reference for StartFaceSearch Operation</seealso> StartFaceSearchResponse EndStartFaceSearch(IAsyncResult asyncResult); #endregion #region StartLabelDetection /// <summary> /// Starts asynchronous detection of labels in a stored video. /// /// /// <para> /// Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world /// entities. This includes objects like flower, tree, and table; events like wedding, /// graduation, and birthday party; concepts like landscape, evening, and nature; and /// activities like a person getting out of a car or a person skiing. /// </para> /// /// <para> /// The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket /// name and the filename of the video. <code>StartLabelDetection</code> returns a job /// identifier (<code>JobId</code>) which you use to get the results of the operation. /// When label detection is finished, Amazon Rekognition Video publishes a completion /// status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. /// </para> /// /// <para> /// To get the results of the label detection operation, first check that the status value /// published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>. /// </para> /// /// <para> /// <i>Optional Parameters</i> /// </para> /// /// <para> /// <code>StartLabelDetection</code> has the <code>GENERAL_LABELS</code> Feature applied /// by default. This feature allows you to provide filtering criteria to the <code>Settings</code> /// parameter. You can filter with sets of individual labels or with label categories. /// You can specify inclusive filters, exclusive filters, or a combination of inclusive /// and exclusive filters. For more information on filtering, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html">Detecting /// labels in a video</a>. /// </para> /// /// <para> /// You can specify <code>MinConfidence</code> to control the confidence threshold for /// the labels returned. The default is 50. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartLabelDetection service method.</param> /// /// <returns>The response from the StartLabelDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartLabelDetection">REST API Reference for StartLabelDetection Operation</seealso> StartLabelDetectionResponse StartLabelDetection(StartLabelDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the StartLabelDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartLabelDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartLabelDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartLabelDetection">REST API Reference for StartLabelDetection Operation</seealso> IAsyncResult BeginStartLabelDetection(StartLabelDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartLabelDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartLabelDetection.</param> /// /// <returns>Returns a StartLabelDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartLabelDetection">REST API Reference for StartLabelDetection Operation</seealso> StartLabelDetectionResponse EndStartLabelDetection(IAsyncResult asyncResult); #endregion #region StartPersonTracking /// <summary> /// Starts the asynchronous tracking of a person's path in a stored video. /// /// /// <para> /// Amazon Rekognition Video can track the path of people in a video stored in an Amazon /// S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. /// <code>StartPersonTracking</code> returns a job identifier (<code>JobId</code>) which /// you use to get the results of the operation. When label detection is finished, Amazon /// Rekognition publishes a completion status to the Amazon Simple Notification Service /// topic that you specify in <code>NotificationChannel</code>. /// </para> /// /// <para> /// To get the results of the person detection operation, first check that the status /// value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartPersonTracking service method.</param> /// /// <returns>The response from the StartPersonTracking service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartPersonTracking">REST API Reference for StartPersonTracking Operation</seealso> StartPersonTrackingResponse StartPersonTracking(StartPersonTrackingRequest request); /// <summary> /// Initiates the asynchronous execution of the StartPersonTracking operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartPersonTracking operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartPersonTracking /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartPersonTracking">REST API Reference for StartPersonTracking Operation</seealso> IAsyncResult BeginStartPersonTracking(StartPersonTrackingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartPersonTracking operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartPersonTracking.</param> /// /// <returns>Returns a StartPersonTrackingResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartPersonTracking">REST API Reference for StartPersonTracking Operation</seealso> StartPersonTrackingResponse EndStartPersonTracking(IAsyncResult asyncResult); #endregion #region StartProjectVersion /// <summary> /// Starts the running of the version of a model. Starting a model takes a while to complete. /// To check the current state of the model, use <a>DescribeProjectVersions</a>. /// /// /// <para> /// Once the model is running, you can detect custom labels in new images by calling <a>DetectCustomLabels</a>. /// </para> /// <note> /// <para> /// You are charged for the amount of time that the model is running. To stop a running /// model, call <a>StopProjectVersion</a>. /// </para> /// </note> /// <para> /// For more information, see <i>Running a trained Amazon Rekognition Custom Labels model</i> /// in the Amazon Rekognition Custom Labels Guide. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:StartProjectVersion</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartProjectVersion service method.</param> /// /// <returns>The response from the StartProjectVersion service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartProjectVersion">REST API Reference for StartProjectVersion Operation</seealso> StartProjectVersionResponse StartProjectVersion(StartProjectVersionRequest request); /// <summary> /// Initiates the asynchronous execution of the StartProjectVersion operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartProjectVersion operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartProjectVersion /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartProjectVersion">REST API Reference for StartProjectVersion Operation</seealso> IAsyncResult BeginStartProjectVersion(StartProjectVersionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartProjectVersion operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartProjectVersion.</param> /// /// <returns>Returns a StartProjectVersionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartProjectVersion">REST API Reference for StartProjectVersion Operation</seealso> StartProjectVersionResponse EndStartProjectVersion(IAsyncResult asyncResult); #endregion #region StartSegmentDetection /// <summary> /// Starts asynchronous detection of segment detection in a stored video. /// /// /// <para> /// Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. /// Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartSegmentDetection</code> /// returns a job identifier (<code>JobId</code>) which you use to get the results of /// the operation. When segment detection is finished, Amazon Rekognition Video publishes /// a completion status to the Amazon Simple Notification Service topic that you specify /// in <code>NotificationChannel</code>. /// </para> /// /// <para> /// You can use the <code>Filters</code> (<a>StartSegmentDetectionFilters</a>) input parameter /// to specify the minimum detection confidence returned in the response. Within <code>Filters</code>, /// use <code>ShotFilter</code> (<a>StartShotDetectionFilter</a>) to filter detected shots. /// Use <code>TechnicalCueFilter</code> (<a>StartTechnicalCueDetectionFilter</a>) to filter /// technical cues. /// </para> /// /// <para> /// To get the results of the segment detection operation, first check that the status /// value published to the Amazon SNS topic is <code>SUCCEEDED</code>. if so, call <a>GetSegmentDetection</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartSegmentDetection</code>. /// /// </para> /// /// <para> /// For more information, see Detecting video segments in stored video in the Amazon Rekognition /// Developer Guide. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartSegmentDetection service method.</param> /// /// <returns>The response from the StartSegmentDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartSegmentDetection">REST API Reference for StartSegmentDetection Operation</seealso> StartSegmentDetectionResponse StartSegmentDetection(StartSegmentDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the StartSegmentDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartSegmentDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartSegmentDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartSegmentDetection">REST API Reference for StartSegmentDetection Operation</seealso> IAsyncResult BeginStartSegmentDetection(StartSegmentDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartSegmentDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartSegmentDetection.</param> /// /// <returns>Returns a StartSegmentDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartSegmentDetection">REST API Reference for StartSegmentDetection Operation</seealso> StartSegmentDetectionResponse EndStartSegmentDetection(IAsyncResult asyncResult); #endregion #region StartStreamProcessor /// <summary> /// Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>. /// To tell <code>StartStreamProcessor</code> which stream processor to start, use the /// value of the <code>Name</code> field specified in the call to <code>CreateStreamProcessor</code>. /// /// /// <para> /// If you are using a label detection stream processor to detect labels, you need to /// provide a <code>Start selector</code> and a <code>Stop selector</code> to determine /// the length of the stream processing time. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartStreamProcessor service method.</param> /// /// <returns>The response from the StartStreamProcessor service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartStreamProcessor">REST API Reference for StartStreamProcessor Operation</seealso> StartStreamProcessorResponse StartStreamProcessor(StartStreamProcessorRequest request); /// <summary> /// Initiates the asynchronous execution of the StartStreamProcessor operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartStreamProcessor operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartStreamProcessor /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartStreamProcessor">REST API Reference for StartStreamProcessor Operation</seealso> IAsyncResult BeginStartStreamProcessor(StartStreamProcessorRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartStreamProcessor operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartStreamProcessor.</param> /// /// <returns>Returns a StartStreamProcessorResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartStreamProcessor">REST API Reference for StartStreamProcessor Operation</seealso> StartStreamProcessorResponse EndStartStreamProcessor(IAsyncResult asyncResult); #endregion #region StartTextDetection /// <summary> /// Starts asynchronous detection of text in a stored video. /// /// /// <para> /// Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. /// Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartTextDetection</code> /// returns a job identifier (<code>JobId</code>) which you use to get the results of /// the operation. When text detection is finished, Amazon Rekognition Video publishes /// a completion status to the Amazon Simple Notification Service topic that you specify /// in <code>NotificationChannel</code>. /// </para> /// /// <para> /// To get the results of the text detection operation, first check that the status value /// published to the Amazon SNS topic is <code>SUCCEEDED</code>. if so, call <a>GetTextDetection</a> /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartTextDetection</code>. /// /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StartTextDetection service method.</param> /// /// <returns>The response from the StartTextDetection service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.IdempotentParameterMismatchException"> /// 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. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidS3ObjectException"> /// Amazon Rekognition is unable to access the S3 object specified in the request. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.VideoTooLargeException"> /// The file size or duration of the supplied media is too large. The maximum file size /// is 10GB. The maximum duration is 6 hours. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartTextDetection">REST API Reference for StartTextDetection Operation</seealso> StartTextDetectionResponse StartTextDetection(StartTextDetectionRequest request); /// <summary> /// Initiates the asynchronous execution of the StartTextDetection operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StartTextDetection operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartTextDetection /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartTextDetection">REST API Reference for StartTextDetection Operation</seealso> IAsyncResult BeginStartTextDetection(StartTextDetectionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StartTextDetection operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStartTextDetection.</param> /// /// <returns>Returns a StartTextDetectionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StartTextDetection">REST API Reference for StartTextDetection Operation</seealso> StartTextDetectionResponse EndStartTextDetection(IAsyncResult asyncResult); #endregion #region StopProjectVersion /// <summary> /// Stops a running model. The operation might take a while to complete. To check the /// current status, call <a>DescribeProjectVersions</a>. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the StopProjectVersion service method.</param> /// /// <returns>The response from the StopProjectVersion service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StopProjectVersion">REST API Reference for StopProjectVersion Operation</seealso> StopProjectVersionResponse StopProjectVersion(StopProjectVersionRequest request); /// <summary> /// Initiates the asynchronous execution of the StopProjectVersion operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StopProjectVersion operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopProjectVersion /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StopProjectVersion">REST API Reference for StopProjectVersion Operation</seealso> IAsyncResult BeginStopProjectVersion(StopProjectVersionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StopProjectVersion operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStopProjectVersion.</param> /// /// <returns>Returns a StopProjectVersionResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StopProjectVersion">REST API Reference for StopProjectVersion Operation</seealso> StopProjectVersionResponse EndStopProjectVersion(IAsyncResult asyncResult); #endregion #region StopStreamProcessor /// <summary> /// Stops a running stream processor that was created by <a>CreateStreamProcessor</a>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the StopStreamProcessor service method.</param> /// /// <returns>The response from the StopStreamProcessor service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StopStreamProcessor">REST API Reference for StopStreamProcessor Operation</seealso> StopStreamProcessorResponse StopStreamProcessor(StopStreamProcessorRequest request); /// <summary> /// Initiates the asynchronous execution of the StopStreamProcessor operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the StopStreamProcessor operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopStreamProcessor /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StopStreamProcessor">REST API Reference for StopStreamProcessor Operation</seealso> IAsyncResult BeginStopStreamProcessor(StopStreamProcessorRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the StopStreamProcessor operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginStopStreamProcessor.</param> /// /// <returns>Returns a StopStreamProcessorResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/StopStreamProcessor">REST API Reference for StopStreamProcessor Operation</seealso> StopStreamProcessorResponse EndStopStreamProcessor(IAsyncResult asyncResult); #endregion #region TagResource /// <summary> /// Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, /// or Custom Labels model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging /// AWS Resources</a>. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:TagResource</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the TagResource service method.</param> /// /// <returns>The response from the TagResource service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ServiceQuotaExceededException"> /// The size of the collection exceeds the allowed limit. For more information, see Guidelines /// and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/TagResource">REST API Reference for TagResource Operation</seealso> TagResourceResponse TagResource(TagResourceRequest request); /// <summary> /// Initiates the asynchronous execution of the TagResource operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the TagResource operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/TagResource">REST API Reference for TagResource Operation</seealso> IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the TagResource operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginTagResource.</param> /// /// <returns>Returns a TagResourceResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/TagResource">REST API Reference for TagResource Operation</seealso> TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// <summary> /// Removes one or more tags from an Amazon Rekognition collection, stream processor, /// or Custom Labels model. /// /// /// <para> /// This operation requires permissions to perform the <code>rekognition:UntagResource</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the UntagResource service method.</param> /// /// <returns>The response from the UntagResource service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UntagResource">REST API Reference for UntagResource Operation</seealso> UntagResourceResponse UntagResource(UntagResourceRequest request); /// <summary> /// Initiates the asynchronous execution of the UntagResource operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the UntagResource operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UntagResource">REST API Reference for UntagResource Operation</seealso> IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the UntagResource operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginUntagResource.</param> /// /// <returns>Returns a UntagResourceResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UntagResource">REST API Reference for UntagResource Operation</seealso> UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateDatasetEntries /// <summary> /// Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line /// which contains the information for a single image, including the image location, assigned /// labels, and object location bounding boxes. For more information, see Image-Level /// labels in manifest files and Object localization in manifest files in the <i>Amazon /// Rekognition Custom Labels Developer Guide</i>. /// /// /// <para> /// If the <code>source-ref</code> field in the JSON line references an existing image, /// the existing image in the dataset is updated. If <code>source-ref</code> field doesn't /// reference an existing image, the image is added as a new image to the dataset. /// </para> /// /// <para> /// You specify the changes that you want to make in the <code>Changes</code> input parameter. /// There isn't a limit to the number JSON Lines that you can change, but the size of /// <code>Changes</code> must be less than 5MB. /// </para> /// /// <para> /// <code>UpdateDatasetEntries</code> returns immediatly, but the dataset update might /// take a while to complete. Use <a>DescribeDataset</a> to check the current status. /// The dataset updated successfully if the value of <code>Status</code> is <code>UPDATE_COMPLETE</code>. /// /// </para> /// /// <para> /// To check if any non-terminal errors occured, call <a>ListDatasetEntries</a> and check /// for the presence of <code>errors</code> lists in the JSON Lines. /// </para> /// /// <para> /// Dataset update fails if a terminal error occurs (<code>Status</code> = <code>UPDATE_FAILED</code>). /// Currently, you can't access the terminal error information from the Amazon Rekognition /// Custom Labels SDK. /// </para> /// /// <para> /// This operation requires permissions to perform the <code>rekognition:UpdateDatasetEntries</code> /// action. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the UpdateDatasetEntries service method.</param> /// /// <returns>The response from the UpdateDatasetEntries service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.LimitExceededException"> /// An Amazon Rekognition service limit was exceeded. For example, if you start too many /// Amazon Rekognition Video jobs concurrently, calls to start operations (<code>StartLabelDetection</code>, /// for example) will raise a <code>LimitExceededException</code> exception (HTTP status /// code: 400) until the number of concurrently running jobs is below the Amazon Rekognition /// service limit. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UpdateDatasetEntries">REST API Reference for UpdateDatasetEntries Operation</seealso> UpdateDatasetEntriesResponse UpdateDatasetEntries(UpdateDatasetEntriesRequest request); /// <summary> /// Initiates the asynchronous execution of the UpdateDatasetEntries operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the UpdateDatasetEntries operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDatasetEntries /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UpdateDatasetEntries">REST API Reference for UpdateDatasetEntries Operation</seealso> IAsyncResult BeginUpdateDatasetEntries(UpdateDatasetEntriesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the UpdateDatasetEntries operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDatasetEntries.</param> /// /// <returns>Returns a UpdateDatasetEntriesResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UpdateDatasetEntries">REST API Reference for UpdateDatasetEntries Operation</seealso> UpdateDatasetEntriesResponse EndUpdateDatasetEntries(IAsyncResult asyncResult); #endregion #region UpdateStreamProcessor /// <summary> /// Allows you to update a stream processor. You can change some settings and regions /// of interest and delete certain parameters. /// </summary> /// <param name="request">Container for the necessary parameters to execute the UpdateStreamProcessor service method.</param> /// /// <returns>The response from the UpdateStreamProcessor service method, as returned by Rekognition.</returns> /// <exception cref="Amazon.Rekognition.Model.AccessDeniedException"> /// You are not authorized to perform the action. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InternalServerErrorException"> /// Amazon Rekognition experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.InvalidParameterException"> /// Input parameter violated a constraint. Validate your parameter before calling the /// API operation again. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceInUseException"> /// The specified resource is already being used. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ResourceNotFoundException"> /// The resource specified in the request cannot be found. /// </exception> /// <exception cref="Amazon.Rekognition.Model.ThrottlingException"> /// Amazon Rekognition is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UpdateStreamProcessor">REST API Reference for UpdateStreamProcessor Operation</seealso> UpdateStreamProcessorResponse UpdateStreamProcessor(UpdateStreamProcessorRequest request); /// <summary> /// Initiates the asynchronous execution of the UpdateStreamProcessor operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the UpdateStreamProcessor operation on AmazonRekognitionClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStreamProcessor /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UpdateStreamProcessor">REST API Reference for UpdateStreamProcessor Operation</seealso> IAsyncResult BeginUpdateStreamProcessor(UpdateStreamProcessorRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the UpdateStreamProcessor operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStreamProcessor.</param> /// /// <returns>Returns a UpdateStreamProcessorResult from Rekognition.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/UpdateStreamProcessor">REST API Reference for UpdateStreamProcessor Operation</seealso> UpdateStreamProcessorResponse EndUpdateStreamProcessor(IAsyncResult asyncResult); #endregion } }