AWS.Tools.Rekognition.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Rekognition</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet"> <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, <c>IndexFaces</c> 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 <c>OrientationCorrection</c> 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 <c>FaceModelVersion</c> in the response from <c>IndexFaces</c></para><para> For more information, see Model Versioning in the Amazon Rekognition Developer Guide. </para><para> If you provide the optional <c>ExternalImageId</c> 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 <c>MaxFaces</c> 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 <c>QualityFilter</c> 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, <c>IndexFaces</c> chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use <c>QualityFilter</c>, to set the quality bar by specifying <c>LOW</c>, <c>MEDIUM</c>, or <c>HIGH</c>. If you do not want to filter detected faces, specify <c>NONE</c>. </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, <c>UnindexedFaces</c>. Faces aren't indexed for reasons such as: </para><ul><li><para> The number of faces detected exceeds the value of the <c>MaxFaces</c> 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 <c>IndexFaces</c> operation returns an array of metadata for all detected faces, <c>FaceRecords</c>. This includes: </para><ul><li><para> The bounding box, <c>BoundingBox</c>, of the detected face. </para></li><li><para> A confidence value, <c>Confidence</c>, which indicates the confidence that the bounding box contains a face. </para></li><li><para> A face ID, <c>FaceId</c>, assigned by the service for each face that's detected and stored. </para></li><li><para> An image ID, <c>ImageId</c>, assigned by the service for the input image. </para></li></ul><para> If you request <c>ALL</c> or specific facial attributes (e.g., <c>FACE_OCCLUDED</c>) 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 <c>IndexFaces</c> 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 <c>rekognition:IndexFaces</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection to which you want to add the faces that are detected in the input images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.DetectionAttribute"> <summary> <para> <para>An array of facial attributes you want to be returned. A <c>DEFAULT</c> subset of facial attributes - <c>BoundingBox</c>, <c>Confidence</c>, <c>Pose</c>, <c>Quality</c>, and <c>Landmarks</c> - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using <c>["DEFAULT", "FACE_OCCLUDED"]</c> or just <c>["FACE_OCCLUDED"]</c>. You can request for all facial attributes by using <c>["ALL"]</c>. Requesting more attributes may increase response time.</para><para>If you provide both, <c>["ALL", "DEFAULT"]</c>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ExternalImageId"> <summary> <para> <para>The ID you want to assign to all the faces detected in the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.MaxFace"> <summary> <para> <para>The maximum number of faces to index. The value of <c>MaxFaces</c> must be greater than or equal to 1. <c>IndexFaces</c> returns no more than 100 detected faces in an image, even if you specify a larger value for <c>MaxFaces</c>.</para><para>If <c>IndexFaces</c> detects more faces than the value of <c>MaxFaces</c>, the faces with the lowest quality are filtered out first. If there are still more faces than the value of <c>MaxFaces</c>, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of <c>MaxFaces</c>). Information about the unindexed faces is available in the <c>UnindexedFaces</c> array. </para><para>The faces that are returned by <c>IndexFaces</c> are sorted by the largest face bounding box size to the smallest size, in descending order.</para><para><c>MaxFaces</c> can be used with a collection associated with any version of the face model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.QualityFilter"> <summary> <para> <para>A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify <c>AUTO</c>, Amazon Rekognition chooses the quality bar. If you specify <c>LOW</c>, <c>MEDIUM</c>, or <c>HIGH</c>, filtering removes all faces that don’t meet the chosen quality bar. The default value is <c>AUTO</c>. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify <c>NONE</c>, no filtering is performed. </para><para>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.IndexFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.IndexFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet"> <summary> Associates one or more faces with an existing UserID. Takes an array of <c>FaceIds</c>. Each <c>FaceId</c> that are present in the <c>FaceIds</c> list is associated with the provided UserID. The maximum number of total <c>FaceIds</c> per UserID is 100. <para> The <c>UserMatchThreshold</c> parameter specifies the minimum user match confidence required for the face to be associated with a UserID that has at least one <c>FaceID</c> already associated. This ensures that the <c>FaceIds</c> are associated with the right UserID. The value ranges from 0-100 and default value is 75. </para><para> If successful, an array of <c>AssociatedFace</c> objects containing the associated <c>FaceIds</c> is returned. If a given face is already associated with the given <c>UserID</c>, it will be ignored and will not be returned in the response. If a given face is already associated to a different <c>UserID</c>, isn't found in the collection, doesn’t meet the <c>UserMatchThreshold</c>, or there are already 100 faces associated with the <c>UserID</c>, it will be returned as part of an array of <c>UnsuccessfulFaceAssociations.</c></para><para> The <c>UserStatus</c> reflects the status of an operation which updates a UserID representation with a list of given faces. The <c>UserStatus</c> 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the request to <c>AssociateFaces</c>. If you use the same token with multiple <c>AssociateFaces</c> requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection containing the UserID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.FaceId"> <summary> <para> <para>An array of FaceIDs to associate with the UserID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.UserId"> <summary> <para> <para>The ID for the existing UserID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.UserMatchThreshold"> <summary> <para> <para>An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.AssociateFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.AssociateFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKREKFacesToUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.AddREKResourceTagCmdlet"> <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 <c>rekognition:TagResource</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKResourceTagCmdlet.ResourceArn"> <summary> <para> <para> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKResourceTagCmdlet.Tag"> <summary> <para> <para> The key-value tags to assign to the resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet"> <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 <c>CompareFaces</c> 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 <c>SimilarityThreshold</c> parameter. </para></note><para><c>CompareFaces</c> 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 <c>QualityFilter</c> 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 <c>QualityFilter</c> to set the quality bar by specifying <c>LOW</c>, <c>MEDIUM</c>, or <c>HIGH</c>. If you do not want to filter detected faces, specify <c>NONE</c>. The default value is <c>NONE</c>. </para><para> If the image doesn't contain Exif metadata, <c>CompareFaces</c> 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, <c>CompareFaces</c> returns an <c>InvalidParameterException</c> 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 <c>rekognition:CompareFaces</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.QualityFilter"> <summary> <para> <para>A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify <c>AUTO</c>, Amazon Rekognition chooses the quality bar. If you specify <c>LOW</c>, <c>MEDIUM</c>, or <c>HIGH</c>, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify <c>NONE</c>, no filtering is performed. The default value is <c>NONE</c>. </para><para>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SimilarityThreshold"> <summary> <para> <para>The minimum level of confidence in the face matches that a match must meet to be included in the <c>FaceMatches</c> array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CompareFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CompareFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><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> Copying project versions is supported only for Custom Labels models. </para><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 <c>Status</c> in the <a>ProjectVersionDescription</a> object. The copy operation has finished when the value of <c>Status</c> is <c>COPYING_COMPLETED</c>. </para><para> This operation requires permissions to perform the <c>rekognition:CopyProjectVersion</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.DestinationProjectArn"> <summary> <para> <para>The ARN of the project in the trusted AWS account that you want to copy the model version to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.KmsKeyId"> <summary> <para> <para>The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training results and manifest files written to the output Amazon S3 bucket (<c>OutputConfig</c>).</para><para>If you choose to use your own KMS key, you need the following permissions on the KMS key.</para><ul><li><para>kms:CreateGrant</para></li><li><para>kms:DescribeKey</para></li><li><para>kms:GenerateDataKey</para></li><li><para>kms:Decrypt</para></li></ul><para>If you don't specify a value for <c>KmsKeyId</c>, images copied into the service are encrypted using a key that AWS owns and manages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The S3 bucket where training output is placed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.OutputConfig_S3KeyPrefix"> <summary> <para> <para>The prefix applied to the training output files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.SourceProjectArn"> <summary> <para> <para>The ARN of the source project in the trusting AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.SourceProjectVersionArn"> <summary> <para> <para>The ARN of the model version in the source project that you want to copy to a destination project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.Tag"> <summary> <para> <para>The key-value tags to assign to the model version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.VersionName"> <summary> <para> <para>A name for the version of the model that's copied to the destination project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CopyProjectVersionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CopyProjectVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CopyREKProjectVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet"> <summary> Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. <para><c>RecognizeCelebrities</c> returns the 64 largest faces in the image. It lists the recognized celebrities in the <c>CelebrityFaces</c> array and any unrecognized faces in the <c>UnrecognizedFaces</c> array. <c>RecognizeCelebrities</c> doesn't return celebrities whose faces aren't among the largest 64 faces in the image. </para><para> For each celebrity recognized, <c>RecognizeCelebrities</c> returns a <c>Celebrity</c> object. The <c>Celebrity</c> object contains the celebrity name, ID, URL links to additional information, match confidence, and a <c>ComparedFace</c> 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 <c>Celebrity</c> ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by <c>RecognizeCelebrities</c>, 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 <c>rekognition:RecognizeCelebrities</c> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.RecognizeCelebritiesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.RecognizeCelebritiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </para><para> You specify which version of a model version to use by using the <c>ProjectVersionArn</c> 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 (<c>CustomLabel</c>) object in an array (<c>CustomLabels</c>). Each <c>CustomLabel</c> object provides the label name (<c>Name</c>), the level of confidence that the image contains the object (<c>Confidence</c>), and object location information, if it exists, for the label on the image (<c>Geometry</c>). Note that for the <c>DetectCustomLabelsLabels</c> operation, <c>Polygons</c> are not returned in the <c>Geometry</c> section of the response. </para><para> To filter labels that are returned, specify a value for <c>MinConfidence</c>. <c>DetectCustomLabelsLabels</c> only returns labels with a confidence that's higher than the specified value. The value of <c>MinConfidence</c> 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 <c>MinConfidence</c> normalizes the threshold value to a percentage value (0-100). Confidence responses from <c>DetectCustomLabels</c> are also returned as a percentage. You can use <c>MinConfidence</c> 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 <c>MinConfidence</c>, <c>DetectCustomLabels</c> 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 <c>rekognition:DetectCustomLabels</c> action. </para><para> For more information, see <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.S3Object_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.Image_Byte"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence level for the labels to return. <c>DetectCustomLabels</c> doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, <c>DetectCustomLabels</c> returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for <c>MinConfidence</c>, <c>DetectCustomLabels</c> returns labels based on the assumed threshold of each label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.S3Object_Name"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.ProjectVersionArn"> <summary> <para> <para>The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CustomLabels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectCustomLabelsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectCustomLabelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCustomLabelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectVersionArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectVersionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet"> <summary> Detects faces within an image that is provided as input. <para><c>DetectFaces</c> 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 <c>rekognition:DetectFaces</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.Attribute"> <summary> <para> <para>An array of facial attributes you want to be returned. A <c>DEFAULT</c> subset of facial attributes - <c>BoundingBox</c>, <c>Confidence</c>, <c>Pose</c>, <c>Quality</c>, and <c>Landmarks</c> - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using [<c>"DEFAULT", "FACE_OCCLUDED"</c>] or just [<c>"FACE_OCCLUDED"</c>]. You can request for all facial attributes by using [<c>"ALL"]</c>. Requesting more attributes may increase response time.</para><para>If you provide both, <c>["ALL", "DEFAULT"]</c>, the service uses a logical "AND" operator to determine which attributes to return (in this case, all attributes). </para><para>Note that while the FaceOccluded and EyeDirection attributes are supported when using <c>DetectFaces</c>, they aren't supported when analyzing videos with <c>StartFaceDetection</c> and <c>GetFaceDetection</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet"> <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 <c>GENERAL_LABELS</c> and <c>IMAGE_PROPERTIES</c> feature types when calling the DetectLabels API. Including <c>GENERAL_LABELS</c> will ensure the response includes the labels detected in the input image, while including <c>IMAGE_PROPERTIES </c>will ensure the response includes information about the image quality and color. </para><para> When using <c>GENERAL_LABELS</c> and/or <c>IMAGE_PROPERTIES</c> 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> When getting labels, you can specify <c>MinConfidence</c> to control the confidence threshold for the labels returned. The default is 55%. You can also add the <c>MaxLabels</c> parameter to limit the number of labels returned. The default and upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a feature type. </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><c>{Name: lighthouse, Confidence: 98.4629}</c></para><para><c>{Name: rock,Confidence: 79.2097}</c></para><para><c> {Name: sea,Confidence: 75.061}</c></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><c>{Name: flower,Confidence: 99.0562}</c></para><para><c>{Name: plant,Confidence: 99.0562}</c></para><para><c>{Name: tulip,Confidence: 99.0562}</c></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 <c>rekognition:DetectLabels</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.Feature"> <summary> <para> <para>A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.GeneralLabels_LabelCategoryExclusionFilter"> <summary> <para> <para>The label categories that should be excluded from the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.GeneralLabels_LabelCategoryInclusionFilter"> <summary> <para> <para>The label categories that should be included in the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.GeneralLabels_LabelExclusionFilter"> <summary> <para> <para>The labels that should be excluded from the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.GeneralLabels_LabelInclusionFilter"> <summary> <para> <para>The labels that should be included in the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageProperties_MaxDominantColor"> <summary> <para> <para>The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.MaxLabel"> <summary> <para> <para>Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.</para><para>If <c>MinConfidence</c> is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectLabelsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectLabelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet"> <summary> Detects unsafe content in a specified JPEG or PNG format image. Use <c>DetectModerationLabels</c> 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 <c>DetectModerationLabels</c> 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><para> You can specify an adapter to use when retrieving label predictions by providing a <c>ProjectVersionArn</c> to the <c>ProjectVersion</c> argument. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.S3Object_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.Image_Byte"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.DataAttributes_ContentClassifier"> <summary> <para> <para>Sets whether the input image is free of personally identifiable information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.HumanLoopConfig_FlowDefinitionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html">CreateFlowDefinition</a> Operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.HumanLoopConfig_HumanLoopName"> <summary> <para> <para>The name of the human review used for this image. This should be kept unique within a region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.</para><para>If you don't specify <c>MinConfidence</c>, the operation returns labels with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.S3Object_Name"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.ProjectVersion"> <summary> <para> <para>Identifier for the custom adapter. Expects the ProjectVersionArn as a value. Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectModerationLabelsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectModerationLabelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet"> <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><c>DetectProtectiveEquipment</c> 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 <c>SummarizationAttributes</c> 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 <c>rekognition:DetectProtectiveEquipment</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.SummarizationAttributes_MinConfidence"> <summary> <para> <para>The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value.</para><para>Specify a <c>MinConfidence</c> value that is between 50-100% as <c>DetectProtectiveEquipment</c> returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.SummarizationAttributes_RequiredEquipmentType"> <summary> <para> <para>An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the <c>PersonsWithRequiredEquipment</c> array field returned in <a>ProtectiveEquipmentSummary</a> by <c>DetectProtectiveEquipment</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKProtectiveEquipmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectProtectiveEquipmentResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectProtectiveEquipmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet"> <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 <c>DetectText</c> operation returns text in an array of <a>TextDetection</a> elements, <c>TextDetections</c>. Each <c>TextDetection</c> 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. <c>DetectText</c> 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 <c>DetectText</c> operation returns multiple lines. </para><para> To determine whether a <c>TextDetection</c> element is a line of text or a word, use the <c>TextDetection</c> object <c>Type</c> 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.WordFilter_MinBoundingBoxHeight"> <summary> <para> <para>Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.WordFilter_MinBoundingBoxWidth"> <summary> <para> <para>Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.WordFilter_MinConfidence"> <summary> <para> <para>Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0 and 100. The default MinConfidence is 80.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.Filters_RegionsOfInterest"> <summary> <para> <para> A Filter focusing on a certain area of the image. Uses a <c>BoundingBox</c> object to set the region of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TextDetections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectTextResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectTextResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityInfoCmdlet"> <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 <c>rekognition:GetCelebrityInfo</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityInfoCmdlet.Id"> <summary> <para> <para>The ID for the celebrity. You get the celebrity ID from a call to the <a>RecognizeCelebrities</a> operation, which recognizes celebrities in an image. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityInfoCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetCelebrityInfoResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetCelebrityInfoResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityInfoCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet"> <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 (<c>JobId</c>). </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 <c>StartCelebrityRecognition</c>. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <c>GetCelebrityDetection</c> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartCelebrityDetection</c>. </para><para> For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. </para><para><c>GetCelebrityRecognition</c> returns detected celebrities and the time(s) they are detected in an array (<c>Celebrities</c>) of <a>CelebrityRecognition</a> objects. Each <c>CelebrityRecognition</c> contains information about the celebrity in a <a>CelebrityDetail</a> object and the time, <c>Timestamp</c>, 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><c>GetCelebrityRecognition</c> only returns the default facial attributes (<c>BoundingBox</c>, <c>Confidence</c>, <c>Landmarks</c>, <c>Pose</c>, and <c>Quality</c>). The <c>BoundingBox</c> field only applies to the detected face instance. The other facial attributes listed in the <c>Face</c> 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 <c>Celebrities</c> array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value <c>ID</c> in the <c>SortBy</c> input parameter. </para><para> The <c>CelebrityDetail</c> 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 <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetCelebrityDetection</c> and populate the <c>NextToken</c> request parameter with the token value returned from the previous call to <c>GetCelebrityRecognition</c>. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.JobId"> <summary> <para> <para>Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to <c>StartCelebrityRecognition</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.SortBy"> <summary> <para> <para>Sort to use for celebrities returned in <c>Celebrities</c> field. Specify <c>ID</c> to sort by the celebrity identifier, specify <c>TIMESTAMP</c> to sort by the time the celebrity was recognized.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetCelebrityRecognitionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetCelebrityRecognitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionCmdlet"> <summary> Describes the specified collection. You can use <c>DescribeCollection</c> 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionCmdlet.CollectionId"> <summary> <para> <para>The ID of the collection to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DescribeCollectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DescribeCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet"> <summary> Returns list of collection IDs in your account. If the result is truncated, the response also provides a <c>NextToken</c> 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 <c>rekognition:ListCollections</c> action. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of collection IDs to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet.NextToken"> <summary> <para> <para>Pagination token from the previous response.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListCollectionsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListCollectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet"> <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 (<c>JobId</c>). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <c>StartContentModeration</c>. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <c>GetContentModeration</c> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartContentModeration</c>. </para><para> For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. </para><para><c>GetContentModeration</c> returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, <c>ModerationLabels</c>, 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 <c>NAME</c> for the <c>SortBy</c> input parameter. </para><para> Since video analysis can return a large number of results, use the <c>MaxResults</c> parameter to limit the number of labels returned in a single call to <c>GetContentModeration</c>. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetContentModeration</c> and populate the <c>NextToken</c> request parameter with the value of <c>NextToken</c> returned from the previous call to <c>GetContentModeration</c>. </para><para> For more information, see moderating content in the Amazon Rekognition Developer Guide. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.AggregateBy"> <summary> <para> <para>Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.JobId"> <summary> <para> <para>The identifier for the inappropriate, unwanted, or offensive content moderation job. Use <c>JobId</c> to identify the job in a subsequent call to <c>GetContentModeration</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.SortBy"> <summary> <para> <para>Sort to use for elements in the <c>ModerationLabelDetections</c> array. Use <c>TIMESTAMP</c> to sort array elements by the time labels are detected. Use <c>NAME</c> to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by <c>TIMESTAMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetContentModerationResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetContentModerationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><para> This operation requires permissions to perform the <c>rekognition:DescribeDataset</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetCmdlet.DatasetArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the dataset that you want to describe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DescribeDatasetResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DescribeDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><para> JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in <c>errors</c> 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 <c>rekognition:ListDatasetEntries</c> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.ContainsLabel"> <summary> <para> <para>Specifies a label filter for the response. The response includes an entry only if one or more of the labels in <c>ContainsLabels</c> exist in the entry. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.DatasetArn"> <summary> <para> <para> The Amazon Resource Name (ARN) for the dataset that you want to use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.HasError"> <summary> <para> <para>Specifies an error filter for the response. Specify <c>True</c> to only include entries that have errors. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.Labeled"> <summary> <para> <para> Specify <c>true</c> to get only the JSON Lines where the image is labeled. Specify <c>false</c> to get only the JSON Lines where the image isn't labeled. If you don't specify <c>Labeled</c>, <c>ListDatasetEntries</c> returns JSON Lines for labeled and unlabeled images. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.SourceRefContain"> <summary> <para> <para>If specified, <c>ListDatasetEntries</c> only returns JSON Lines where the value of <c>SourceRefContains</c> is part of the <c>source-ref</c> field. The <c>source-ref</c> field contains the Amazon S3 location of the image. You can use <c>SouceRefContains</c> for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListDatasetEntriesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListDatasetEntriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetEntryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><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><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet.DatasetArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the dataset that you want to use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetLabelDescriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListDatasetLabelsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListDatasetLabelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKDatasetLabelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet"> <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 (<c>JobId</c>). 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 <c>StartFaceDetection</c>. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetFaceDetection</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartFaceDetection</c>. </para><para><c>GetFaceDetection</c> returns an array of detected faces (<c>Faces</c>) 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 <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetFaceDetection</c> and populate the <c>NextToken</c> request parameter with the token value returned from the previous call to <c>GetFaceDetection</c>. </para><para> Note that for the <c>GetFaceDetection</c> operation, the returned values for <c>FaceOccluded</c> and <c>EyeDirection</c> will always be "null". </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.JobId"> <summary> <para> <para>Unique identifier for the face detection job. The <c>JobId</c> is returned from <c>StartFaceDetection</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetFaceDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetFaceDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet"> <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 <c>rekognition:ListFaces</c> action. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.CollectionId"> <summary> <para> <para>ID of the collection from which to list the faces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.FaceId"> <summary> <para> <para>An array of face IDs to filter results with when listing faces in a collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.UserId"> <summary> <para> <para>An array of user IDs to filter results with when listing faces in a collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of faces to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceLivenessSessionResultCmdlet"> <summary> Retrieves the results of a specific Face Liveness session. It requires the <c>sessionId</c> as input, which was created using <c>CreateFaceLivenessSession</c>. 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. <para> The number of audit images returned by <c>GetFaceLivenessSessionResults</c> is defined by the <c>AuditImagesLimit</c> paramater when calling <c>CreateFaceLivenessSession</c>. Reference images are always returned when possible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceLivenessSessionResultCmdlet.SessionId"> <summary> <para> <para>A unique 128-bit UUID. This is used to uniquely identify the session and also acts as an idempotency token for all operations associated with the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceLivenessSessionResultCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetFaceLivenessSessionResultsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetFaceLivenessSessionResultsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceLivenessSessionResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet"> <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 (<c>JobId</c>). 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 <c>StartFaceSearch</c>. To get the search results, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <c>GetFaceSearch</c> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartFaceSearch</c>. </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, <c>Persons</c>, of <a>PersonMatch</a> objects. Each<c>PersonMatch</c> 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><c>GetFaceSearch</c> only returns the default facial attributes (<c>BoundingBox</c>, <c>Confidence</c>, <c>Landmarks</c>, <c>Pose</c>, and <c>Quality</c>). The other facial attributes listed in the <c>Face</c> 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 <c>Persons</c> 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 <c>INDEX</c> for the <c>SORTBY</c> input parameter. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.JobId"> <summary> <para> <para>The job identifer for the search request. You get the job identifier from an initial call to <c>StartFaceSearch</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.SortBy"> <summary> <para> <para>Sort to use for grouping faces in the response. Use <c>TIMESTAMP</c> to group faces by the time that they are recognized. Use <c>INDEX</c> to sort by recognized faces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetFaceSearchResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetFaceSearchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet"> <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 (<c>JobId</c>). 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 <c>StartlabelDetection</c>. </para><para> To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartLabelDetection</c>. </para><para><c>GetLabelDetection</c> returns an array of detected labels (<c>Labels</c>) sorted by the time the labels were detected. You can also sort by the label name by specifying <c>NAME</c> for the <c>SortBy</c> input parameter. If there is no <c>NAME</c> specified, the default sort is by timestamp. </para><para> You can select how results are aggregated by using the <c>AggregateBy</c> input parameter. The default aggregation method is <c>TIMESTAMPS</c>. You can also aggregate by <c>SEGMENTS</c>, 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 <c>SEGMENTS</c>, the <c>StartTimestampMillis</c>, <c>EndTimestampMillis</c>, and <c>DurationMillis</c> 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 <c>StartTimestampMillis</c>. </para></li></ul><para> Timestamp and Bounding box information are returned for detected Instances, only if aggregation is done by <c>TIMESTAMPS</c>. If aggregating by <c>SEGMENTS</c>, 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 <c>DominantColors</c> isn't returned for <c>Instances</c>, although it is shown as part of the response in the sample seen below.</b></para><para> Use <c>MaxResults</c> parameter to limit the number of labels returned. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetlabelDetection</c> and populate the <c>NextToken</c> request parameter with the token value returned from the previous call to <c>GetLabelDetection</c>. </para><para> If you are retrieving results while using the Amazon Simple Notification Service, note that you will receive an "ERROR" notification if the job encounters an issue. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.AggregateBy"> <summary> <para> <para>Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.JobId"> <summary> <para> <para>Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to <c>StartlabelDetection</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.SortBy"> <summary> <para> <para>Sort to use for elements in the <c>Labels</c> array. Use <c>TIMESTAMP</c> to sort array elements by the time labels are detected. Use <c>NAME</c> to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by <c>TIMESTAMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetLabelDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetLabelDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobCmdlet"> <summary> Retrieves the results for a given media analysis job. Takes a <c>JobId</c> returned by StartMediaAnalysisJob. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobCmdlet.JobId"> <summary> <para> <para>Unique identifier for the media analysis job for which you want to retrieve results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetMediaAnalysisJobResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetMediaAnalysisJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobListCmdlet"> <summary> Returns a list of media analysis jobs. Results are sorted by <c>CreationTimestamp</c> in descending order.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value user can specify is 100. If user specifies a value greater than 100, an <c>InvalidParameterException</c> error occurs. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobListCmdlet.NextToken"> <summary> <para> <para>Pagination token, if the previous response was incomplete.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaAnalysisJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListMediaAnalysisJobsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListMediaAnalysisJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKMediaAnalysisJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet"> <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 <c>StartPersonTracking</c> which returns a job identifier (<c>JobId</c>). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <c>StartPersonTracking</c>. </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 <c>SUCCEEDED</c>. If so, call <a>GetPersonTracking</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartPersonTracking</c>. </para><para><c>GetPersonTracking</c> returns an array, <c>Persons</c>, of tracked persons and the time(s) their paths were tracked in the video. </para><note><para><c>GetPersonTracking</c> only returns the default facial attributes (<c>BoundingBox</c>, <c>Confidence</c>, <c>Landmarks</c>, <c>Pose</c>, and <c>Quality</c>). The other facial attributes listed in the <c>Face</c> 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 <c>INDEX</c> for the <c>SortBy</c> input parameter. </para><para> Use the <c>MaxResults</c> parameter to limit the number of items returned. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetPersonTracking</c> and populate the <c>NextToken</c> request parameter with the token value returned from the previous call to <c>GetPersonTracking</c>. </para><br/><br/>In the AWS.Tools.Rekognition module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.JobId"> <summary> <para> <para>The identifier for a job that tracks persons in a video. You get the <c>JobId</c> from a call to <c>StartPersonTracking</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.SortBy"> <summary> <para> <para>Sort to use for elements in the <c>Persons</c> array. Use <c>TIMESTAMP</c> to sort array elements by the time persons are detected. Use <c>INDEX</c> to sort by the tracked persons. If you sort by <c>INDEX</c>, the array elements for each person are sorted by detection confidence. The default sort is by <c>TIMESTAMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Rekognition module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetPersonTrackingResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetPersonTrackingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet"> <summary> Gets information about your Rekognition projects. <para> This operation requires permissions to perform the <c>rekognition:DescribeProjects</c> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet.Feature"> <summary> <para> <para>Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet.ProjectName"> <summary> <para> <para>A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectDescriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DescribeProjectsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DescribeProjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> Gets a list of the project policies attached to a project. </para><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 <c>rekognition:ListProjectPolicies</c> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet.ProjectArn"> <summary> <para> <para>The ARN of the project for which you want to list the project policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 5. If you specify a value greater than 5, a ValidationException error occurs. The default value is 5. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectPolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListProjectPoliciesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListProjectPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectPolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet"> <summary> Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or adapter versions in <c>ProjectVersionArns</c>. If you don't specify a value, descriptions for all model/adapter versions in the project are returned. <para> This operation requires permissions to perform the <c>rekognition:DescribeProjectVersions</c> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.ProjectArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.VersionName"> <summary> <para> <para>A list of model or project version names that you want to describe. You can add up to 10 model or project version names to the list. If you don't specify a value, all project version descriptions are returned. A version name is part of a project version ARN. For example, <c>my-model.2020-01-21T09.10.15</c> is the version name in the following ARN. <c>arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/<i>my-model.2020-01-21T09.10.15</i>/1234567890123</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectVersionDescriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DescribeProjectVersionsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DescribeProjectVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKProjectVersionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKResourceTagCmdlet"> <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 <c>rekognition:ListTagsForResource</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKResourceTagCmdlet.ResourceArn"> <summary> <para> <para> Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet"> <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 (<c>JobId</c>). 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 <c>StartSegmentDetection</c>. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. if so, call <c>GetSegmentDetection</c> and pass the job identifier (<c>JobId</c>) from the initial call of <c>StartSegmentDetection</c>. </para><para><c>GetSegmentDetection</c> returns detected segments in an array (<c>Segments</c>) of <a>SegmentDetection</a> objects. <c>Segments</c> is sorted by the segment types specified in the <c>SegmentTypes</c> input parameter of <c>StartSegmentDetection</c>. 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 <c>SelectedSegmentTypes</c> to find out the type of segment detection requested in the call to <c>StartSegmentDetection</c>. </para><para> Use the <c>MaxResults</c> parameter to limit the number of segment detections returned. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetSegmentDetection</c> and populate the <c>NextToken</c> request parameter with the token value returned from the previous call to <c>GetSegmentDetection</c>. </para><para> For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet.JobId"> <summary> <para> <para>Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to <c>StartSegmentDetection</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet.NextToken"> <summary> <para> <para>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetSegmentDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetSegmentDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKSegmentDetectionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorCmdlet"> <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> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorCmdlet.Name"> <summary> <para> <para>Name of the stream processor for which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DescribeStreamProcessorResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DescribeStreamProcessorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet"> <summary> Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamProcessors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListStreamProcessorsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListStreamProcessorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet"> <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 (<c>JobId</c>) 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 <c>StartTextDetection</c>. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. if so, call <c>GetTextDetection</c> and pass the job identifier (<c>JobId</c>) from the initial call of <c>StartLabelDetection</c>. </para><para><c>GetTextDetection</c> returns an array of detected text (<c>TextDetections</c>) sorted by the time the text was detected, up to 100 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 <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetTextDetection</c> and populate the <c>NextToken</c> request parameter with the token value returned from the previous call to <c>GetTextDetection</c>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet.JobId"> <summary> <para> <para>Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to <c>StartTextDetection</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.GetTextDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.GetTextDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKTextDetectionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet"> <summary> Returns metadata of the User such as <c>UserID</c> 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, <c>NextToken</c> is returned in the response that can be used in the subsequent request to retrieve the next set of identities.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of UsersID to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet.NextToken"> <summary> <para> <para>Pagingation token to receive the next set of UsersID.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Users'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.ListUsersResponse). Specifying the name of a property of type Amazon.Rekognition.Model.ListUsersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKUserListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.InvokeREKDistributeDatasetEntryCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. <c>DistributeDatasetEntries</c> moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image. </para><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 <c>DescribeDataset</c>. The operation is complete when the <c>Status</c> field for the training dataset and the test dataset is <c>UPDATE_COMPLETE</c>. If the dataset split fails, the value of <c>Status</c> is <c>UPDATE_FAILED</c>. </para><para> This operation requires permissions to perform the <c>rekognition:DistributeDatasetEntries</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.InvokeREKDistributeDatasetEntryCmdlet.Dataset"> <summary> <para> <para>The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to the same project. The test dataset must be empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.InvokeREKDistributeDatasetEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DistributeDatasetEntriesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.InvokeREKDistributeDatasetEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet"> <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 <c>IndexFaces</c> 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 <c>rekognition:CreateCollection</c> action. If you want to tag your collection, you also require permission to perform the <c>rekognition:TagResource</c> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.CollectionId"> <summary> <para> <para>ID for the collection that you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.Tag"> <summary> <para> <para> A set of tags (key-value pairs) that you want to attach to the collection. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateCollectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CreateCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><para> To create a training dataset for a project, specify <c>TRAIN</c> for the value of <c>DatasetType</c>. To create the test dataset for a project, specify <c>TEST</c> for the value of <c>DatasetType</c>. </para><para> The response from <c>CreateDataset</c> 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 <c>Status</c> is <c>CREATE_COMPLETE</c>. </para><para> To check if any non-terminal errors occurred, call <a>ListDatasetEntries</a> and check for the presence of <c>errors</c> lists in the JSON Lines. </para><para> Dataset creation fails if a terminal error occurs (<c>Status</c> = <c>CREATE_FAILED</c>). 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 <c>rekognition:CreateDataset</c> action. If you want to copy an existing dataset, you also require permission to perform the <c>rekognition:ListDatasetEntries</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.S3Object_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.DatasetSource_DatasetArn"> <summary> <para> <para> The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.DatasetType"> <summary> <para> <para> The type of the dataset. Specify <c>TRAIN</c> to create a training dataset. Specify <c>TEST</c> to create a test dataset. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.S3Object_Name"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.ProjectArn"> <summary> <para> <para> The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.Tag"> <summary> <para> <para>A set of tags (key-value pairs) that you want to attach to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CreateDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet"> <summary> This API operation initiates a Face Liveness session. It returns a <c>SessionId</c>, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session. <para> You can use the <c>OutputConfig</c> option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead. </para><para> You can use <c>AuditImagesLimit</c> to limit the number of audit images returned when <c>GetFaceLivenessSessionResults</c> is called. 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.Settings_AuditImagesLimit"> <summary> <para> <para>Number of audit images to be returned back. Takes an integer between 0-4. Any integer less than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it is set to 0. The limit is best effort and is based on the actual duration of the selfie-video.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple <c>CreateFaceLivenessSession</c> requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.KmsKeyId"> <summary> <para> <para> The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The path to an AWS Amazon S3 bucket used to store Face Liveness session results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.OutputConfig_S3KeyPrefix"> <summary> <para> <para>The prefix prepended to the output files for the Face Liveness session results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SessionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateFaceLivenessSessionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CreateFaceLivenessSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKFaceLivenessSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet"> <summary> Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions) that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires permissions to perform the <c>rekognition:CreateProject</c> action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.AutoUpdate"> <summary> <para> <para>Specifies whether automatic retraining should be attempted for the versions of the project. Automatic retraining is done as a best effort. Required argument for Content Moderation. Applicable only to adapters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.Feature"> <summary> <para> <para>Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.Tag"> <summary> <para> <para>A set of tags (key-value pairs) that you want to attach to the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateProjectResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CreateProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet"> <summary> Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from <c>CreateProjectVersion</c> is an Amazon Resource Name (ARN) for the project version. <para> The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling <a>DescribeProjectVersions</a>. Training completed successfully if the value of the <c>Status</c> field is <c>TRAINING_COMPLETED</c>. Once training has successfully completed, call <a>DescribeProjectVersions</a> to get the training results and evaluate the model. </para><para> This operation requires permissions to perform the <c>rekognition:CreateProjectVersion</c> action. </para><note><para><i>The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:</i></para><para> You can train a model in a project that doesn't have associated datasets by specifying manifest files in the <c>TrainingData</c> and <c>TestingData</c> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.TestingData_Asset"> <summary> <para> <para>The assets used for testing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.TrainingData_Asset"> <summary> <para> <para>A manifest file that contains references to the training images and ground-truth annotations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.TestingData_AutoCreate"> <summary> <para> <para>If specified, Rekognition splits training dataset to create a test dataset for the training job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.ContentModeration_ConfidenceThreshold"> <summary> <para> <para>The confidence level you plan to use to identify if unsafe content is present during inference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.KmsKeyId"> <summary> <para> <para>The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (<c>OutputConfig</c>).</para><para>If you choose to use your own KMS key, you need the following permissions on the KMS key.</para><ul><li><para>kms:CreateGrant</para></li><li><para>kms:DescribeKey</para></li><li><para>kms:GenerateDataKey</para></li><li><para>kms:Decrypt</para></li></ul><para>If you don't specify a value for <c>KmsKeyId</c>, images copied into the service are encrypted using a key that AWS owns and manages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.ProjectArn"> <summary> <para> <para>The ARN of the Amazon Rekognition project that will manage the project version you want to train.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The S3 bucket where training output is placed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.OutputConfig_S3KeyPrefix"> <summary> <para> <para>The prefix applied to the training output files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.Tag"> <summary> <para> <para> A set of tags (key-value pairs) that you want to attach to the project version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.VersionDescription"> <summary> <para> <para>A description applied to the project version being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.VersionName"> <summary> <para> <para>A name for the version of the project version. This value must be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateProjectVersionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CreateProjectVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VersionName parameter. The -PassThru parameter is deprecated, use -Select '^VersionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKProjectVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet"> <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 (<c>Input</c>) and a Kinesis data stream (<c>Output</c>) stream for receiving the output. You must use the <c>FaceSearch</c> option in <c>Settings</c>, 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 (<c>Input</c>), Amazon S3 bucket information (<c>Output</c>), and an Amazon SNS topic ARN (<c>NotificationChannel</c>). 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 <c>ConnectedHome</c> option in settings, and selecting one of the following: <c>PERSON</c>, <c>PET</c>, <c>PACKAGE</c>, <c>ALL</c> You can also specify where in the frame you want Amazon Rekognition to monitor with <c>RegionsOfInterest</c>. 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 <c>Name</c> to assign an identifier for the stream processor. You use <c>Name</c> to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with the <c>Name</c> field. </para><para> This operation requires permissions to perform the <c>rekognition:CreateStreamProcessor</c> action. If you want to tag your stream processor, you also require permission to perform the <c>rekognition:TagResource</c> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.KinesisVideoStream_Arn"> <summary> <para> <para>ARN of the Kinesis video stream stream that streams the source video.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.KinesisDataStream_Arn"> <summary> <para> <para>ARN of the output Amazon Kinesis Data Streams stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.S3Destination_Bucket"> <summary> <para> <para> The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.FaceSearch_CollectionId"> <summary> <para> <para>The ID of a collection that contains faces that you want to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.FaceSearch_FaceMatchThreshold"> <summary> <para> <para>Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.S3Destination_KeyPrefix"> <summary> <para> <para> The prefix value of the location within the bucket that you want the information to be published to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Using prefixes</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.KmsKeyId"> <summary> <para> <para> The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.ConnectedHome_Label"> <summary> <para> <para> Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL". </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.ConnectedHome_MinConfidence"> <summary> <para> <para> The minimum confidence required to label an object in the video. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.Name"> <summary> <para> <para>An identifier you assign to the stream processor. You can use <c>Name</c> to manage the stream processor. For example, you can get the current status of the stream processor by calling <a>DescribeStreamProcessor</a>. <c>Name</c> is idempotent. This is required for both face search and label detection stream processors. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.DataSharingPreference_OptIn"> <summary> <para> <para> If this option is set to true, you choose to share data with Rekognition to improve model performance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.RegionsOfInterest"> <summary> <para> <para> Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para> The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.Tag"> <summary> <para> <para> A set of tags (key-value pairs) that you want to attach to the stream processor. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamProcessorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateStreamProcessorResponse). Specifying the name of a property of type Amazon.Rekognition.Model.CreateStreamProcessorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet"> <summary> Creates a new User within a collection specified by <c>CollectionId</c>. Takes <c>UserId</c> as a parameter, which is a user provided ID which should be unique within the collection. The provided <c>UserId</c> will alias the system generated UUID to make the <c>UserId</c> more user friendly. <para> Uses a <c>ClientToken</c>, an idempotency token that ensures a call to <c>CreateUser</c> 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 <c>CreateUser</c> calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the request to <c>CreateUser</c>. If you use the same token with multiple <c>CreateUser</c> requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection to which the new UserID needs to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet.UserId"> <summary> <para> <para>ID for the UserID to be created. This ID needs to be unique within the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet"> <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 <c>rekognition:DeleteCollection</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet.CollectionId"> <summary> <para> <para>ID of the collection to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StatusCode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteCollectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DeleteCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKDatasetCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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 <c>Status</c> is <c>DELETE_IN_PROGRESS</c>. If you try to access the dataset after it is deleted, you get a <c>ResourceNotFoundException</c> exception. </para><para> You can't delete a dataset while it is creating (<c>Status</c> = <c>CREATE_IN_PROGRESS</c>) or if the dataset is updating (<c>Status</c> = <c>UPDATE_IN_PROGRESS</c>). </para><para> This operation requires permissions to perform the <c>rekognition:DeleteDataset</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKDatasetCmdlet.DatasetArn"> <summary> <para> <para> The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteDatasetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet"> <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 <c>rekognition:DeleteFaces</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.CollectionId"> <summary> <para> <para>Collection from which to remove the specific faces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.FaceId"> <summary> <para> <para>An array of face IDs to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeletedFaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DeleteFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FaceId parameter. The -PassThru parameter is deprecated, use -Select '^FaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectCmdlet"> <summary> Deletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or adapter, see <a>DeleteProjectVersion</a>. <para><c>DeleteProject</c> 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 <c>ProjectPolicies</c> associated with that project. </para><para> This operation requires permissions to perform the <c>rekognition:DeleteProject</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectCmdlet.ProjectArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the project that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteProjectResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DeleteProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectPolicyCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> Deletes an existing project policy. </para><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 <c>rekognition:DeleteProjectPolicy</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectPolicyCmdlet.PolicyRevisionId"> <summary> <para> <para>The ID of the project policy revision that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectPolicyCmdlet.ProjectArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the project that the project policy you want to delete is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteProjectPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectVersionCmdlet"> <summary> Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter. <para> You can't delete a project version if it is running or if it is training. To check the status of a project version, use the Status field returned from <a>DescribeProjectVersions</a>. To stop a project version call <a>StopProjectVersion</a>. If the project version is training, wait until it finishes. </para><para> This operation requires permissions to perform the <c>rekognition:DeleteProjectVersion</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectVersionCmdlet.ProjectVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the project version that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteProjectVersionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DeleteProjectVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectVersionArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectVersionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKProjectVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet"> <summary> Removes the association between a <c>Face</c> supplied in an array of <c>FaceIds</c> and the User. If the User is not present already, then a <c>ResourceNotFound</c> 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 <c>UnsuccessfulDisassociations</c>. You can remove 1 - 100 face IDs from a user at one time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the request to <c>DisassociateFaces</c>. If you use the same token with multiple <c>DisassociateFaces</c> requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection containing the UserID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.FaceId"> <summary> <para> <para>An array of face IDs to disassociate from the UserID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.UserId"> <summary> <para> <para>ID for the existing UserID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DisassociateFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DisassociateFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKREKFacesFromUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKResourceTagCmdlet"> <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 <c>rekognition:UntagResource</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKResourceTagCmdlet.ResourceArn"> <summary> <para> <para> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKResourceTagCmdlet.TagKey"> <summary> <para> <para> A list of the tags that you want to remove. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet"> <summary> Deletes the stream processor identified by <c>Name</c>. You assign the value for <c>Name</c> 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 <c>DeleteStreamProcessor</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.Name"> <summary> <para> <para>The name of the stream processor you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteStreamProcessorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet"> <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 <c>Collection</c> or <c>UserID</c> is already deleted or not found, a <c>ResourceNotFoundException</c> will be thrown. If the action is successful with a 200 response, an empty HTTP body is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the request to <c>DeleteUser</c>. If you use the same token with multiple <c>DeleteUser </c>requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection from which the UserID needs to be deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet.UserId"> <summary> <para> <para>ID for the UserID to be deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DeleteUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet"> <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 <c>SearchFacesByImage</c> 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 <c>confidence</c> 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 <c>rekognition:SearchFaces</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.CollectionId"> <summary> <para> <para>ID of the collection the face belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.FaceId"> <summary> <para> <para>ID of a face to find matches for in the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.FaceMatchThreshold"> <summary> <para> <para>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.MaxFace"> <summary> <para> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.SearchFacesResponse). Specifying the name of a property of type Amazon.Rekognition.Model.SearchFacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet"> <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 <c>DetectFaces</c> operation and use the bounding boxes in the response to make face crops, which then you can pass in to the <c>SearchFacesByImage</c> 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 <c>similarity</c> 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, <c>SearchFacesByImage</c> returns an <c>InvalidParameterException</c> error. </para><para> For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. </para><para> The <c>QualityFilter</c> 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 <c>QualityFilter</c> to set the quality bar for filtering by specifying <c>LOW</c>, <c>MEDIUM</c>, or <c>HIGH</c>. If you do not want to filter detected faces, specify <c>NONE</c>. The default value is <c>NONE</c>. </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 <c>rekognition:SearchFacesByImage</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.CollectionId"> <summary> <para> <para>ID of the collection to search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.FaceMatchThreshold"> <summary> <para> <para>(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.MaxFace"> <summary> <para> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.QualityFilter"> <summary> <para> <para>A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify <c>AUTO</c>, Amazon Rekognition chooses the quality bar. If you specify <c>LOW</c>, <c>MEDIUM</c>, or <c>HIGH</c>, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify <c>NONE</c>, no filtering is performed. The default value is <c>NONE</c>. </para><para>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.SearchFacesByImageResponse). Specifying the name of a property of type Amazon.Rekognition.Model.SearchFacesByImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet"> <summary> Searches for UserIDs within a collection based on a <c>FaceId</c> or <c>UserId</c>. 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 <c>FaceId</c> or <c>UserId</c>. The operation returns an array of UserID that match the <c>FaceId</c> or <c>UserId</c>, ordered by similarity score with the highest similarity first. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.FaceId"> <summary> <para> <para>ID for the existing face.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.MaxUser"> <summary> <para> <para>Maximum number of identities to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.UserId"> <summary> <para> <para>ID for the existing User.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.UserMatchThreshold"> <summary> <para> <para>Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.SearchUsersResponse). Specifying the name of a property of type Amazon.Rekognition.Model.SearchUsersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet"> <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 <c>UnsearchedFace</c> objects. If no valid face is detected in the image, the response will contain an empty <c>UserMatches</c> list and no <c>SearchedFace</c> object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.S3Object_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.Image_Byte"> <summary> <para> <para>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to <c>DetectCustomLabels</c> is 4MB. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection containing the UserID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.MaxUser"> <summary> <para> <para>Maximum number of UserIDs to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.S3Object_Name"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.QualityFilter"> <summary> <para> <para>A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.UserMatchThreshold"> <summary> <para> <para>Specifies the minimum confidence in the UserID match to return. Default value is 80.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.SearchUsersByImageResponse). Specifying the name of a property of type Amazon.Rekognition.Model.SearchUsersByImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKUsersByImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet"> <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. <c>StartCelebrityRecognition</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartCelebrityRecognition</c>. </para><para> For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartCelebrityRecognition</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.Video"> <summary> <para> <para>The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartCelebrityRecognitionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartCelebrityRecognitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet"> <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. <c>StartContentModeration</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. </para><para> To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetContentModeration</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartContentModeration</c>. </para><para> For more information, see Moderating content in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartContentModeration</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify <c>MinConfidence</c>, <c>GetContentModeration</c> returns labels with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.Video"> <summary> <para> <para>The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartContentModerationResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartContentModerationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet"> <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. <c>StartFaceDetection</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetFaceDetection</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartFaceDetection</c>. </para><para> For more information, see Detecting faces in a stored video in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartFaceDetection</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.FaceAttribute"> <summary> <para> <para>The face attributes you want returned.</para><para><c>DEFAULT</c> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. </para><para><c>ALL</c> - All facial attributes are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.Video"> <summary> <para> <para>The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartFaceDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartFaceDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet"> <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. <c>StartFaceSearch</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. To get the search results, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetFaceSearch</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartFaceSearch</c>. 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartFaceSearch</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.CollectionId"> <summary> <para> <para>ID of the collection that contains the faces you want to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.FaceMatchThreshold"> <summary> <para> <para>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.Video"> <summary> <para> <para>The video you want to search. The video must be stored in an Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartFaceSearchResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartFaceSearchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionId parameter. The -PassThru parameter is deprecated, use -Select '^CollectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet"> <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. <c>StartLabelDetection</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. </para><para> To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartLabelDetection</c>. </para><para><i>Optional Parameters</i></para><para><c>StartLabelDetection</c> has the <c>GENERAL_LABELS</c> Feature applied by default. This feature allows you to provide filtering criteria to the <c>Settings</c> 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 <c>MinConfidence</c> to control the confidence threshold for the labels returned. The default is 50. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartLabelDetection</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.Feature"> <summary> <para> <para>The features to return after video analysis. You can specify that GENERAL_LABELS are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.GeneralLabels_LabelCategoryExclusionFilter"> <summary> <para> <para>The label categories that should be excluded from the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.GeneralLabels_LabelCategoryInclusionFilter"> <summary> <para> <para>The label categories that should be included in the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.GeneralLabels_LabelExclusionFilter"> <summary> <para> <para>The labels that should be excluded from the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.GeneralLabels_LabelInclusionFilter"> <summary> <para> <para>The labels that should be included in the return from DetectLabels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.</para><para>If you don't specify <c>MinConfidence</c>, the operation returns labels and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.Video"> <summary> <para> <para>The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartLabelDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartLabelDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet"> <summary> Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.S3Object_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple <c>StartMediaAnalysisJobRequest</c> requests, the same response is returned. Use <c>ClientRequestToken</c> to prevent the same request from being processed more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.JobName"> <summary> <para> <para>The name of the job. Does not have to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.KmsKeyId"> <summary> <para> <para>The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.DetectModerationLabels_MinConfidence"> <summary> <para> <para>Specifies the minimum confidence level for the moderation labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.S3Object_Name"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.DetectModerationLabels_ProjectVersion"> <summary> <para> <para>Specifies the custom moderation model to be used during the label detection job. If not provided the pre-trained model is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>Specifies the Amazon S3 bucket to contain the output of the media analysis job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.OutputConfig_S3KeyPrefix"> <summary> <para> <para>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartMediaAnalysisJobResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartMediaAnalysisJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKMediaAnalysisJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet"> <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. <c>StartPersonTracking</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. </para><para> To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetPersonTracking</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartPersonTracking</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartPersonTracking</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.Video"> <summary> <para> <para>The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartPersonTrackingResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartPersonTrackingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><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> This operation requires permissions to perform the <c>rekognition:StartProjectVersion</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet.MaxInferenceUnit"> <summary> <para> <para>The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet.MinInferenceUnit"> <summary> <para> <para>The minimum number of inference units to use. A single inference unit represents 1 hour of processing. </para><para>Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet.ProjectVersionArn"> <summary> <para> <para>The Amazon Resource Name(ARN) of the model version that you want to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartProjectVersionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartProjectVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectVersionArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectVersionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKProjectVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet"> <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. <c>StartSegmentDetection</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. </para><para> You can use the <c>Filters</c> (<a>StartSegmentDetectionFilters</a>) input parameter to specify the minimum detection confidence returned in the response. Within <c>Filters</c>, use <c>ShotFilter</c> (<a>StartShotDetectionFilter</a>) to filter detected shots. Use <c>TechnicalCueFilter</c> (<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 <c>SUCCEEDED</c>. if so, call <a>GetSegmentDetection</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartSegmentDetection</c>. </para><para> For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartSegmentDetection</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.BlackFrame_MaxPixelThreshold"> <summary> <para> <para> A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video, luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range. </para><para>For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.</para><para>The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.BlackFrame_MinCoveragePercentage"> <summary> <para> <para> The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered a black frame. Luminance is calculated using the BT.709 matrix. </para><para>The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the <c>MaxPixelThreshold</c> set. You can reduce this value to allow more noise on the black frame.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.ShotFilter_MinSegmentConfidence"> <summary> <para> <para>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.</para><para>If you don't specify <c>MinSegmentConfidence</c>, the <c>GetSegmentDetection</c> returns segments with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.TechnicalCueFilter_MinSegmentConfidence"> <summary> <para> <para>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.</para><para>If you don't specify <c>MinSegmentConfidence</c>, <c>GetSegmentDetection</c> returns segments with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.SegmentType"> <summary> <para> <para>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.Video"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartSegmentDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartSegmentDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Video parameter. The -PassThru parameter is deprecated, use -Select '^Video' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKSegmentDetectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet"> <summary> Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>. To tell <c>StartStreamProcessor</c> which stream processor to start, use the value of the <c>Name</c> field specified in the call to <c>CreateStreamProcessor</c>. <para> If you are using a label detection stream processor to detect labels, you need to provide a <c>Start selector</c> and a <c>Stop selector</c> to determine the length of the stream processing time. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.KVSStreamStartSelector_FragmentNumber"> <summary> <para> <para> The unique identifier of the fragment. This value monotonically increases based on the ingestion order. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.StopSelector_MaxDurationInSecond"> <summary> <para> <para> Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.Name"> <summary> <para> <para>The name of the stream processor to start processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.KVSStreamStartSelector_ProducerTimestamp"> <summary> <para> <para> The timestamp from the producer corresponding to the fragment, in milliseconds, expressed in unix time format. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SessionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartStreamProcessorResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartStreamProcessorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet"> <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. <c>StartTextDetection</c> returns a job identifier (<c>JobId</c>) 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 <c>NotificationChannel</c>. </para><para> To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. if so, call <a>GetTextDetection</a> and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartTextDetection</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <c>StartTextDetection</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidentaly started more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use <c>JobTag</c> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.WordFilter_MinBoundingBoxHeight"> <summary> <para> <para>Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.WordFilter_MinBoundingBoxWidth"> <summary> <para> <para>Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.WordFilter_MinConfidence"> <summary> <para> <para>Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0 and 100. The default MinConfidence is 80.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.Filters_RegionsOfInterest"> <summary> <para> <para>Filter focusing on a certain area of the frame. Uses a <c>BoundingBox</c> object to set the region of the screen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.Video"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StartTextDetectionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StartTextDetectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Video parameter. The -PassThru parameter is deprecated, use -Select '^Video' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKTextDetectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StopREKProjectVersionCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> Stops a running model. The operation might take a while to complete. To check the current status, call <a>DescribeProjectVersions</a>. Only applies to Custom Labels projects. </para><para> This operation requires permissions to perform the <c>rekognition:StopProjectVersion</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKProjectVersionCmdlet.ProjectVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model version that you want to stop.</para><para>This operation requires permissions to perform the <c>rekognition:StopProjectVersion</c> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKProjectVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StopProjectVersionResponse). Specifying the name of a property of type Amazon.Rekognition.Model.StopProjectVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKProjectVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectVersionArn parameter. The -PassThru parameter is deprecated, use -Select '^ProjectVersionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKProjectVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet"> <summary> Stops a running stream processor that was created by <a>CreateStreamProcessor</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.Name"> <summary> <para> <para>The name of a stream processor created by <a>CreateStreamProcessor</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.StopStreamProcessorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.UpdateREKDatasetEntryCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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><para> If the <c>source-ref</c> field in the JSON line references an existing image, the existing image in the dataset is updated. If <c>source-ref</c> 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 <c>Changes</c> input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of <c>Changes</c> must be less than 5MB. </para><para><c>UpdateDatasetEntries</c> 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 <c>Status</c> is <c>UPDATE_COMPLETE</c>. </para><para> To check if any non-terminal errors occured, call <a>ListDatasetEntries</a> and check for the presence of <c>errors</c> lists in the JSON Lines. </para><para> Dataset update fails if a terminal error occurs (<c>Status</c> = <c>UPDATE_FAILED</c>). 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 <c>rekognition:UpdateDatasetEntries</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKDatasetEntryCmdlet.DatasetArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the dataset that you want to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKDatasetEntryCmdlet.Changes_GroundTruth"> <summary> <para> <para>A Base64-encoded binary data object containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling <a>UpdateDatasetEntries</a>. If you are using an AWS SDK to call <c>UpdateDatasetEntries</c>, you don't need to encode <c>Changes</c> as the SDK encodes the data for you. </para><para>For example JSON lines, see Image-Level labels in manifest files and and Object localization in manifest files in the <i>Amazon Rekognition Custom Labels Developer Guide</i>. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKDatasetEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.UpdateDatasetEntriesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKDatasetEntryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKDatasetEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet"> <summary> Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.ConnectedHomeForUpdate_Label"> <summary> <para> <para> Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL". </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.ConnectedHomeForUpdate_MinConfidence"> <summary> <para> <para> The minimum confidence required to label an object in the video. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.Name"> <summary> <para> <para> Name of the stream processor that you want to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.DataSharingPreferenceForUpdate_OptIn"> <summary> <para> <para> If this option is set to true, you choose to share data with Rekognition to improve model performance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.ParametersToDelete"> <summary> <para> <para> A list of parameters you want to delete from the stream processor. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.RegionsOfInterestForUpdate"> <summary> <para> <para> Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.UpdateStreamProcessorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.UpdateREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet"> <summary> <note><para> This operation applies only to Amazon Rekognition Custom Labels. </para></note><para> 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. Only applies to Custom Labels projects. </para><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 <c>PutProjectPolicy</c> 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 <c>rekognition:PutProjectPolicy</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet.PolicyDocument"> <summary> <para> <para>A resource policy to add to the model. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON policy reference</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet.PolicyName"> <summary> <para> <para>A name for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet.PolicyRevisionId"> <summary> <para> <para>The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels generates and assigns a new <c>PolicyRevisionId</c> and then deletes the previous version of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet.ProjectArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the project that the project policy is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyRevisionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.PutProjectPolicyResponse). Specifying the name of a property of type Amazon.Rekognition.Model.PutProjectPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.WriteREKProjectPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |