8309 lines
456 KiB
JSON
8309 lines
456 KiB
JSON
{
|
||
"smithy": "1.0",
|
||
"metadata": {
|
||
"suppressions": [
|
||
{
|
||
"id": "HttpMethodSemantics",
|
||
"namespace": "*"
|
||
},
|
||
{
|
||
"id": "HttpResponseCodeSemantics",
|
||
"namespace": "*"
|
||
},
|
||
{
|
||
"id": "PaginatedTrait",
|
||
"namespace": "*"
|
||
},
|
||
{
|
||
"id": "HttpHeaderTrait",
|
||
"namespace": "*"
|
||
},
|
||
{
|
||
"id": "HttpUriConflict",
|
||
"namespace": "*"
|
||
},
|
||
{
|
||
"id": "Service",
|
||
"namespace": "*"
|
||
}
|
||
]
|
||
},
|
||
"shapes": {
|
||
"com.amazonaws.rekognition#AccessDeniedException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>You are not authorized to perform the action.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#AgeRange": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Low": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The lowest estimated age.</p>"
|
||
}
|
||
},
|
||
"High": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The highest estimated age.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Structure containing the estimated age range, in years, for a face.</p>\n <p>Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age\n ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the\n face of a 6-year-old might have an estimated range of 4-8.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Asset": {
|
||
"type": "structure",
|
||
"members": {
|
||
"GroundTruthManifest": {
|
||
"target": "com.amazonaws.rekognition#GroundTruthManifest"
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Assets are the images that you use to train and evaluate a model version. \n Assets can also contain validation information that you use to debug a failed model training.\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Assets": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Asset"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Attribute": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "DEFAULT",
|
||
"name": "DEFAULT"
|
||
},
|
||
{
|
||
"value": "ALL",
|
||
"name": "ALL"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Attributes": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Attribute"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#AudioMetadata": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Codec": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The audio codec used to encode or decode the audio stream. </p>"
|
||
}
|
||
},
|
||
"DurationMillis": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The duration of the audio stream in milliseconds.</p>"
|
||
}
|
||
},
|
||
"SampleRate": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The sample rate for the audio stream.</p>"
|
||
}
|
||
},
|
||
"NumberOfChannels": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The number of audio channels in the segment.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Metadata information about an audio stream. An array of <code>AudioMetadata</code> objects\n for the audio streams found in a stored video is returned by <a>GetSegmentDetection</a>. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#AudioMetadataList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#AudioMetadata"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Beard": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the face has beard or not.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face has a beard, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#BodyPart": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "FACE",
|
||
"name": "FACE"
|
||
},
|
||
{
|
||
"value": "HEAD",
|
||
"name": "HEAD"
|
||
},
|
||
{
|
||
"value": "LEFT_HAND",
|
||
"name": "LEFT_HAND"
|
||
},
|
||
{
|
||
"value": "RIGHT_HAND",
|
||
"name": "RIGHT_HAND"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#BodyParts": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentBodyPart"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Boolean": {
|
||
"type": "boolean"
|
||
},
|
||
"com.amazonaws.rekognition#BoundingBox": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Width": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Width of the bounding box as a ratio of the overall image width.</p>"
|
||
}
|
||
},
|
||
"Height": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Height of the bounding box as a ratio of the overall image height.</p>"
|
||
}
|
||
},
|
||
"Left": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Left coordinate of the bounding box as a ratio of overall image width.</p>"
|
||
}
|
||
},
|
||
"Top": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Top coordinate of the bounding box as a ratio of overall image height.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifies the bounding box around the label, face, text or personal protective equipment.\n The <code>left</code> (x-coordinate) and <code>top</code> (y-coordinate) are coordinates representing the top and\n left sides of the bounding box. Note that the upper-left corner of the image is the origin\n (0,0). </p>\n <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700)\n and a <code>top</code> value of 0.25 (50/200).</p>\n <p>The <code>width</code> and <code>height</code> values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. </p>\n <note>\n <p> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the <code>left</code> or\n <code>top</code> values. </p>\n </note>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#BoundingBoxHeight": {
|
||
"type": "float",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 0,
|
||
"max": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#BoundingBoxWidth": {
|
||
"type": "float",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 0,
|
||
"max": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Celebrity": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Urls": {
|
||
"target": "com.amazonaws.rekognition#Urls",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of URLs pointing to additional information about the celebrity. If there is no\n additional information about the celebrity, this list is empty.</p>"
|
||
}
|
||
},
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the celebrity.</p>"
|
||
}
|
||
},
|
||
"Id": {
|
||
"target": "com.amazonaws.rekognition#RekognitionUniqueId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A unique identifier for the celebrity. </p>"
|
||
}
|
||
},
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#ComparedFace",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides information about the celebrity's face, such as its location on the\n image.</p>"
|
||
}
|
||
},
|
||
"MatchConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence, in percentage, that Amazon Rekognition has that the recognized face is the\n celebrity.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides information about a celebrity recognized by the <a>RecognizeCelebrities</a> operation.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CelebrityDetail": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Urls": {
|
||
"target": "com.amazonaws.rekognition#Urls",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of URLs pointing to additional celebrity information. </p>"
|
||
}
|
||
},
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the celebrity.</p>"
|
||
}
|
||
},
|
||
"Id": {
|
||
"target": "com.amazonaws.rekognition#RekognitionUniqueId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The unique identifier for the celebrity. </p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity. </p>"
|
||
}
|
||
},
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Bounding box around the body of a celebrity.</p>"
|
||
}
|
||
},
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#FaceDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Face details for the recognized celebrity.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a recognized celebrity.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CelebrityList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Celebrity"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CelebrityRecognition": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The time, in milliseconds from the start of the video, that the celebrity was recognized.</p>"
|
||
}
|
||
},
|
||
"Celebrity": {
|
||
"target": "com.amazonaws.rekognition#CelebrityDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a recognized celebrity.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a detected celebrity and the time the celebrity was detected in a stored video.\n For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CelebrityRecognitionSortBy": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "ID",
|
||
"name": "ID"
|
||
},
|
||
{
|
||
"value": "TIMESTAMP",
|
||
"name": "TIMESTAMP"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CelebrityRecognitions": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#CelebrityRecognition"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ClientRequestToken": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 64
|
||
},
|
||
"smithy.api#pattern": "^[a-zA-Z0-9-_]+$"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CollectionId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 255
|
||
},
|
||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CollectionIdList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#CollectionId"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CompareFaces": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#CompareFacesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#CompareFacesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Compares a face in the <i>source</i> input image with\n each of the 100 largest faces detected in the <i>target</i> input image.\n </p>\n \n <p> If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image. </p>\n \n \n <note>\n <p>CompareFaces uses machine learning algorithms, which are probabilistic. \n A false negative is an incorrect prediction that\n a face in the target image has a low similarity confidence score when compared to the face\n in the source image. To reduce the probability of false negatives, \n we recommend that you compare the target image against multiple source images.\n If you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's rights,\n privacy, or access to services, we recommend that you pass the result to a human for review and further\n validation before taking action.</p>\n </note>\n\n\n <p>You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file. </p>\n <p>In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match. </p>\n\n <note>\n <p>By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n <code>SimilarityThreshold</code> parameter.</p>\n </note>\n\n <p>\n <code>CompareFaces</code> also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.</p>\n \n <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use <code>QualityFilter</code> to set the quality bar\n by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.\n If you do not want to filter detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>. </p>\n\n <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.</p>\n <p>If no faces are detected in the source or target images, <code>CompareFaces</code> returns an \n <code>InvalidParameterException</code> error. </p>\n\n\n <note>\n <p> This is a stateless API operation. That is, data returned by this operation doesn't persist.</p>\n </note>\n\n \n <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.</p>\n <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code>\n action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CompareFacesMatch": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Similarity": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence that the faces match.</p>"
|
||
}
|
||
},
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#ComparedFace",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides face metadata (bounding box and confidence that the bounding box actually\n contains a face).</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides information about a face in a target image that matches the source image face\n analyzed by <code>CompareFaces</code>. The <code>Face</code> property contains the bounding\n box of the face in the target image. The <code>Similarity</code> property is the confidence\n that the source image face matches the face in the bounding box.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CompareFacesMatchList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#CompareFacesMatch"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CompareFacesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"SourceImage": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object.\n If you use the AWS CLI to call Amazon Rekognition operations,\n passing base64-encoded image bytes is not supported. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"TargetImage": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.\n </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"SimilarityThreshold": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The minimum level of confidence in the face matches that a match must meet to be\n included in the <code>FaceMatches</code> array.</p>"
|
||
}
|
||
},
|
||
"QualityFilter": {
|
||
"target": "com.amazonaws.rekognition#QualityFilter",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't compared. If you specify <code>AUTO</code>, Amazon Rekognition chooses the quality bar.\n If you specify <code>LOW</code>, \n <code>MEDIUM</code>, or <code>HIGH</code>, filtering removes all faces that\n don’t meet the chosen quality bar.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify <code>NONE</code>, no\n filtering is performed. The default value is <code>NONE</code>.\n </p>\n <p>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CompareFacesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"SourceImageFace": {
|
||
"target": "com.amazonaws.rekognition#ComparedSourceImageFace",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The face in the source image that was used for comparison.</p>"
|
||
}
|
||
},
|
||
"FaceMatches": {
|
||
"target": "com.amazonaws.rekognition#CompareFacesMatchList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces in the target image that match the source image face. Each\n <code>CompareFacesMatch</code> object provides the bounding box, the confidence level that\n the bounding box contains a face, and the similarity score for the face in the bounding box\n and the face in the source image.</p>"
|
||
}
|
||
},
|
||
"UnmatchedFaces": {
|
||
"target": "com.amazonaws.rekognition#CompareFacesUnmatchList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces in the target image that did not match the source image\n face.</p>"
|
||
}
|
||
},
|
||
"SourceImageOrientationCorrection": {
|
||
"target": "com.amazonaws.rekognition#OrientationCorrection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The value of <code>SourceImageOrientationCorrection</code> is always null.</p>\n <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.</p>\n <p>Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n </p>"
|
||
}
|
||
},
|
||
"TargetImageOrientationCorrection": {
|
||
"target": "com.amazonaws.rekognition#OrientationCorrection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The value of <code>TargetImageOrientationCorrection</code> is always null.</p>\n <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.</p>\n <p>Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CompareFacesUnmatchList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ComparedFace"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ComparedFace": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Bounding box of the face.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence that what the bounding box contains is a face.</p>"
|
||
}
|
||
},
|
||
"Landmarks": {
|
||
"target": "com.amazonaws.rekognition#Landmarks",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of facial landmarks.</p>"
|
||
}
|
||
},
|
||
"Pose": {
|
||
"target": "com.amazonaws.rekognition#Pose",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>"
|
||
}
|
||
},
|
||
"Quality": {
|
||
"target": "com.amazonaws.rekognition#ImageQuality",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifies face image brightness and sharpness. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides face metadata for target image faces that are analyzed by\n <code>CompareFaces</code> and <code>RecognizeCelebrities</code>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ComparedFaceList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ComparedFace"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ComparedSourceImageFace": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Bounding box of the face.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Confidence level that the selected bounding box contains a face.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Type that describes the face Amazon Rekognition chose to compare with the faces in the target.\n This contains a bounding box for the selected face and confidence level that the bounding box\n contains a face. Note that Amazon Rekognition selects the largest face in the source image for this\n comparison. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ContentClassifier": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "FreeOfPersonallyIdentifiableInformation",
|
||
"name": "FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION"
|
||
},
|
||
{
|
||
"value": "FreeOfAdultContent",
|
||
"name": "FREE_OF_ADULT_CONTENT"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ContentClassifiers": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ContentClassifier"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 256
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ContentModerationDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.</p>"
|
||
}
|
||
},
|
||
"ModerationLabel": {
|
||
"target": "com.amazonaws.rekognition#ModerationLabel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The unsafe content label detected by in the stored video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about an unsafe content label detection in a stored video.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ContentModerationDetections": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ContentModerationDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ContentModerationSortBy": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "NAME",
|
||
"name": "NAME"
|
||
},
|
||
{
|
||
"value": "TIMESTAMP",
|
||
"name": "TIMESTAMP"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CoversBodyPart": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition has in the value of <code>Value</code>.</p>"
|
||
}
|
||
},
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>True if the PPE covers the corresponding body part, otherwise false.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about an item of Personal Protective Equipment covering a corresponding body part. For more \n information, see <a>DetectProtectiveEquipment</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateCollection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#CreateCollectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#CreateCollectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceAlreadyExistsException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ServiceQuotaExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Creates a collection in an AWS Region. You can add faces to the collection using the\n <a>IndexFaces</a> operation. </p>\n <p>For example, you might create collections, one for each of your application users. A\n user can then index faces using the <code>IndexFaces</code> operation and persist results in a\n specific collection. Then, a user can search the collection for faces in the user-specific\n container. </p>\n <p>When you create a collection, it is associated with the latest version of the face model version.</p>\n <note>\n <p>Collection names are case-sensitive.</p>\n </note>\n\n <p>This operation requires permissions to perform the\n <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateCollectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID for the collection that you are creating.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Tags": {
|
||
"target": "com.amazonaws.rekognition#TagMap",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n A set of tags (key-value pairs) that you want to attach to the collection.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateCollectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"StatusCode": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>HTTP status code indicating the result of the operation.</p>"
|
||
}
|
||
},
|
||
"CollectionArn": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on\n your resources. </p>"
|
||
}
|
||
},
|
||
"FaceModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the face detection model associated with the collection you are creating.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateProject": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#CreateProjectRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#CreateProjectResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) \n and operations (training, evaluation and detection). </p>\n <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateProjectRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectName": {
|
||
"target": "com.amazonaws.rekognition#ProjectName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the project to create.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateProjectResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the new project. You can use the ARN to \n configure IAM access to the project. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateProjectVersion": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#CreateProjectVersionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#CreateProjectVersionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ServiceQuotaExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify\n one training dataset and one testing dataset. The response from <code>CreateProjectVersion</code>\n is an Amazon Resource Name (ARN) for the version of the model. </p>\n <p>Training takes a while to complete. You can get the current status by calling\n <a>DescribeProjectVersions</a>.</p>\n <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to\n get the training results and evaluate the model. \n </p>\n <p>After evaluating the model, you start the model\n by calling <a>StartProjectVersion</a>.</p>\n <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateProjectVersionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of the Amazon Rekognition Custom Labels project that \n manages the model that you want to train.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"VersionName": {
|
||
"target": "com.amazonaws.rekognition#VersionName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A name for the version of the model. This value must be unique.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"OutputConfig": {
|
||
"target": "com.amazonaws.rekognition#OutputConfig",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon S3 location to store the results of training.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"TrainingData": {
|
||
"target": "com.amazonaws.rekognition#TrainingData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The dataset to use for training. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"TestingData": {
|
||
"target": "com.amazonaws.rekognition#TestingData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The dataset to use for testing.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Tags": {
|
||
"target": "com.amazonaws.rekognition#TagMap",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n A set of tags (key-value pairs) that you want to attach to the model.\n </p>"
|
||
}
|
||
},
|
||
"KmsKeyId": {
|
||
"target": "com.amazonaws.rekognition#KmsKeyId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK).\n You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK,\n or an alias for your CMK.\n The key is used to encrypt training and test images copied into the service for model training. Your \n source images are unaffected. The key is also used to encrypt training results and manifest files written\n to the output Amazon S3 bucket (<code>OutputConfig</code>).</p>\n <p>If you don't specify a value for <code>KmsKeyId</code>, images copied into the service are encrypted\n using a key that AWS owns and manages.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateProjectVersionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of the model version that was created. Use <code>DescribeProjectVersion</code>\n to get the current status of the training operation.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateStreamProcessor": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#CreateStreamProcessorRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#CreateStreamProcessorResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ServiceQuotaExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.</p>\n <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.</p>\n <p>You provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the\n face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize.\n Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>\n to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with\n the <code>Name</code> field. </p>\n <p>After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to\n stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:CreateStreamProcessor</code> action. If you want to tag your stream processor, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateStreamProcessorRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Input": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorInput",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is <code>StreamProcessorInput</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Output": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorOutput",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is <code>StreamProcessorOutput</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you assign to the stream processor. You can use <code>Name</code> to\n manage the stream processor. For example, you can get the current status of the stream processor by calling <a>DescribeStreamProcessor</a>.\n <code>Name</code> is idempotent.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Settings": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorSettings",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face\n attributes to detect.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"RoleArn": {
|
||
"target": "com.amazonaws.rekognition#RoleArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ARN of the IAM role that allows access to the stream processor.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Tags": {
|
||
"target": "com.amazonaws.rekognition#TagMap",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n A set of tags (key-value pairs) that you want to attach to the stream processor.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CreateStreamProcessorResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"StreamProcessorArn": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ARN for the newly create stream processor.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CustomLabel": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the custom label.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that the model has in the detection of the custom label. The \n range is 0-100. A higher value indicates a higher confidence.</p>"
|
||
}
|
||
},
|
||
"Geometry": {
|
||
"target": "com.amazonaws.rekognition#Geometry",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The location of the detected object on the image that corresponds to the custom label. \n Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon\n for more accurate spatial information.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A custom label detected in an image by a call to <a>DetectCustomLabels</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#CustomLabels": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#CustomLabel"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DateTime": {
|
||
"type": "timestamp"
|
||
},
|
||
"com.amazonaws.rekognition#Degree": {
|
||
"type": "float",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": -180,
|
||
"max": 180
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteCollection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DeleteCollectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DeleteCollectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Deletes the specified collection. Note that this operation\n removes all faces in the collection. For an example, see <a>delete-collection-procedure</a>.</p>\n\n <p>This operation requires permissions to perform the\n <code>rekognition:DeleteCollection</code> action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteCollectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of the collection to delete.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteCollectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"StatusCode": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>HTTP status code that indicates the result of the operation.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteFaces": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DeleteFacesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DeleteFacesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Deletes faces from a collection. You specify a collection ID and an array of face IDs\n to remove from the collection.</p>\n <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>\n action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteFacesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Collection from which to remove the specific faces.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"FaceIds": {
|
||
"target": "com.amazonaws.rekognition#FaceIdList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of face IDs to delete.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteFacesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"DeletedFaces": {
|
||
"target": "com.amazonaws.rekognition#FaceIdList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of strings (face IDs) of the faces that were deleted.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteProject": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DeleteProjectRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DeleteProjectResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated \n with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:DeleteProject</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteProjectRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project that you want to delete.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteProjectResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#ProjectStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the delete project operation.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteProjectVersion": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DeleteProjectVersionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DeleteProjectVersionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Deletes an Amazon Rekognition Custom Labels model. </p>\n <p>You can't delete a model if it is running or if it is training. \n To check the status of a model, use the <code>Status</code> field returned\n from <a>DescribeProjectVersions</a>.\n To stop a running model call <a>StopProjectVersion</a>. If the model\n is training, wait until it finishes.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:DeleteProjectVersion</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteProjectVersionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteProjectVersionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The status of the deletion operation.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteStreamProcessor": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DeleteStreamProcessorRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DeleteStreamProcessorResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with\n <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteStreamProcessorRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the stream processor you want to delete.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DeleteStreamProcessorResponse": {
|
||
"type": "structure",
|
||
"members": {}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeCollection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DescribeCollectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DescribeCollectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Describes the specified collection. You can use <code>DescribeCollection</code> to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.</p>\n \n <p>For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeCollectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ID of the collection to describe.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeCollectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"FaceCount": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The number of faces that are indexed into the collection. To index faces into a\n collection, use <a>IndexFaces</a>.</p>"
|
||
}
|
||
},
|
||
"FaceModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The version of the face model that's used by the collection for face detection.</p>\n \n <p>For more information, see Model Versioning in the \n Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"CollectionARN": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the collection.</p>"
|
||
}
|
||
},
|
||
"CreationTimestamp": {
|
||
"target": "com.amazonaws.rekognition#DateTime",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The number of milliseconds since the Unix epoch time until the creation of the collection.\n The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeProjectVersions": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DescribeProjectVersionsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DescribeProjectVersionsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Lists and describes the models in an Amazon Rekognition Custom Labels project. You \n can specify up to 10 model versions in <code>ProjectVersionArns</code>. If\n you don't specify a value, descriptions for all models are returned.</p>\n <p>This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code>\n action.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"items": "ProjectVersionDescriptions",
|
||
"pageSize": "MaxResults"
|
||
},
|
||
"smithy.waiters#waitable": {
|
||
"ProjectVersionRunning": {
|
||
"documentation": "Wait until the ProjectVersion is running.",
|
||
"acceptors": [
|
||
{
|
||
"state": "success",
|
||
"matcher": {
|
||
"output": {
|
||
"path": "ProjectVersionDescriptions[].Status",
|
||
"expected": "RUNNING",
|
||
"comparator": "allStringEquals"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"state": "failure",
|
||
"matcher": {
|
||
"output": {
|
||
"path": "ProjectVersionDescriptions[].Status",
|
||
"expected": "FAILED",
|
||
"comparator": "anyStringEquals"
|
||
}
|
||
}
|
||
}
|
||
],
|
||
"minDelay": 30
|
||
},
|
||
"ProjectVersionTrainingCompleted": {
|
||
"documentation": "Wait until the ProjectVersion training completes.",
|
||
"acceptors": [
|
||
{
|
||
"state": "success",
|
||
"matcher": {
|
||
"output": {
|
||
"path": "ProjectVersionDescriptions[].Status",
|
||
"expected": "TRAINING_COMPLETED",
|
||
"comparator": "allStringEquals"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"state": "failure",
|
||
"matcher": {
|
||
"output": {
|
||
"path": "ProjectVersionDescriptions[].Status",
|
||
"expected": "TRAINING_FAILED",
|
||
"comparator": "anyStringEquals"
|
||
}
|
||
}
|
||
}
|
||
],
|
||
"minDelay": 120
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeProjectVersionsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project that contains the models you want to describe.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"VersionNames": {
|
||
"target": "com.amazonaws.rekognition#VersionNames",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A list of model version names that you want to describe. You can add up to 10 model version names\n to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a\n model (ProjectVersion) ARN. For example, <code>my-model.2020-01-21T09.10.15</code> is the version name in the following ARN.\n <code>arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/<i>my-model.2020-01-21T09.10.15</i>/1234567890123</code>.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#ExtendedPaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results. </p>"
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionsPageSize",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The maximum number of results to return per paginated call. \n The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeProjectVersionsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionDescriptions": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionDescriptions",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A list of model descriptions. The list is sorted by the creation date and time of\n the model versions, latest to earliest.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#ExtendedPaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeProjects": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DescribeProjectsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DescribeProjectsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Lists and gets information about your Amazon Rekognition Custom Labels projects.</p>\n <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"items": "ProjectDescriptions",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeProjectsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#ExtendedPaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results. </p>"
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#ProjectsPageSize",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeProjectsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectDescriptions": {
|
||
"target": "com.amazonaws.rekognition#ProjectDescriptions",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A list of project descriptions. The list is sorted by the date and time the projects are created.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#ExtendedPaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeStreamProcessor": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DescribeStreamProcessorRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DescribeStreamProcessorResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>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,\n and the current status of the stream processor.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeStreamProcessorRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Name of the stream processor for which you want information.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DescribeStreamProcessorResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Name of the stream processor. </p>"
|
||
}
|
||
},
|
||
"StreamProcessorArn": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ARN of the stream processor.</p>"
|
||
}
|
||
},
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Current status of the stream processor.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detailed status message about the stream processor.</p>"
|
||
}
|
||
},
|
||
"CreationTimestamp": {
|
||
"target": "com.amazonaws.rekognition#DateTime",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Date and time the stream processor was created</p>"
|
||
}
|
||
},
|
||
"LastUpdateTimestamp": {
|
||
"target": "com.amazonaws.rekognition#DateTime",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The time, in Unix format, the stream processor was last updated. For example, when the stream\n processor moves from a running state to a failed state, or when the user starts or stops the stream processor.</p>"
|
||
}
|
||
},
|
||
"Input": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorInput",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Kinesis video stream that provides the source streaming video.</p>"
|
||
}
|
||
},
|
||
"Output": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorOutput",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Kinesis data stream to which Amazon Rekognition Video puts the analysis results.</p>"
|
||
}
|
||
},
|
||
"RoleArn": {
|
||
"target": "com.amazonaws.rekognition#RoleArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ARN of the IAM role that allows access to the stream processor.</p>"
|
||
}
|
||
},
|
||
"Settings": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorSettings",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Face recognition input parameters that are being used by the stream processor.\n Includes the collection to use for face recognition and the face\n attributes to detect.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectCustomLabels": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DetectCustomLabelsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DetectCustomLabelsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotReadyException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>\n <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input\n parameter. </p> \n <p>You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>\n <p> For each object that the model version detects on an image, the API returns a \n (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>).\n Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level\n of confidence that the image contains the object (<code>Confidence</code>), and \n object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>\n <p>During training model calculates a threshold value that determines\n if a prediction for a label is true. By default, <code>DetectCustomLabels</code> doesn't\n return labels whose confidence value is below the model's calculated threshold value. To filter\n labels that are returned, specify a value for <code>MinConfidence</code> that is higher than the\n model's calculated threshold. You can get the model's calculated threshold from the model's\n training results shown in the Amazon Rekognition Custom Labels console.\n To get all labels, regardless of confidence, specify a <code>MinConfidence</code>\n value of 0. </p>\n <p>You can also add the <code>MaxResults</code> parameter\n to limit the number of labels returned. </p>\n\n <p>This is a stateless API operation. That is, the operation does not persist any\n data.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:DetectCustomLabels</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectCustomLabelsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of the model version that you want to use.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results you want the service to return in the response. \n The service returns the specified number of highest confidence labels ranked from highest confidence \n to lowest.</p>"
|
||
}
|
||
},
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence level for the labels to return. \n Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a\n value of 0, all labels are return, regardless of the default thresholds that the model version applies.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectCustomLabelsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CustomLabels": {
|
||
"target": "com.amazonaws.rekognition#CustomLabels",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of custom labels detected in the input image.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectFaces": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DetectFacesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DetectFacesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects faces within an image that is provided as input.</p>\n\n <p>\n <code>DetectFaces</code> detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth),\n presence of beard, sunglasses, and so on. </p>\n <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence. </p>\n <p>You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI\n to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file. </p>\n\n <note>\n <p>This is a stateless API operation. That is, the operation does not persist any\n data.</p>\n </note>\n\n <p>This operation requires permissions to perform the\n <code>rekognition:DetectFaces</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectFacesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Attributes": {
|
||
"target": "com.amazonaws.rekognition#Attributes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of facial attributes you want to be returned. This can be the default list of\n attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if\n you specify <code>[\"DEFAULT\"]</code>, the API returns the following subset of facial\n attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>,\n <code>Quality</code>, and <code>Landmarks</code>. If you provide <code>[\"ALL\"]</code>, all\n facial attributes are returned, but the operation takes longer to complete.</p>\n <p>If you provide both, <code>[\"ALL\", \"DEFAULT\"]</code>, the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes). </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectFacesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"FaceDetails": {
|
||
"target": "com.amazonaws.rekognition#FaceDetailList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details of each face found in the image. </p>"
|
||
}
|
||
},
|
||
"OrientationCorrection": {
|
||
"target": "com.amazonaws.rekognition#OrientationCorrection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The value of <code>OrientationCorrection</code> is always null.</p>\n <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.</p>\n <p>Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectLabels": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DetectLabelsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DetectLabelsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects instances of real-world entities within an image (JPEG or PNG)\n provided as input. This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.\n </p>\n \n <p>For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.</p> \n <note>\n \n <p>\n <code>DetectLabels</code> does not support the detection of activities. However, activity detection\n is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.</p> \n </note>\n \n <p>You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file. </p>\n <p> For each object, scene, and concept the API returns one or more labels. Each label\n provides the object name, and the level of confidence that the image contains the object. For\n example, suppose the input image has a lighthouse, the sea, and a rock. The response includes\n all three labels, one for each object. </p>\n \n <p>\n <code>{Name: lighthouse, Confidence: 98.4629}</code>\n </p>\n <p>\n <code>{Name: rock,Confidence: 79.2097}</code>\n </p>\n <p>\n <code> {Name: sea,Confidence: 75.061}</code>\n </p>\n <p>In the preceding example, the operation returns one label for each of the three\n objects. The operation can also return multiple labels for the same object in the image. For\n example, if the input image shows a flower (for example, a tulip), the operation might return\n the following three labels. </p>\n <p>\n <code>{Name: flower,Confidence: 99.0562}</code>\n </p>\n <p>\n <code>{Name: plant,Confidence: 99.0562}</code>\n </p>\n <p>\n <code>{Name: tulip,Confidence: 99.0562}</code>\n </p>\n\n <p>In this example, the detection algorithm more precisely identifies the flower as a\n tulip.</p>\n <p>In response, the API returns an array of labels. In addition, the response also\n includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to\n control the confidence threshold for the labels returned. The default is 55%. You can also add\n the <code>MaxLabels</code> parameter to limit the number of labels returned. </p>\n <note>\n <p>If the object detected is a person, the operation doesn't provide the same facial\n details that the <a>DetectFaces</a> operation provides.</p>\n </note>\n <p>\n <code>DetectLabels</code> returns bounding boxes for instances of common object labels in an array of\n <a>Instance</a> objects. An <code>Instance</code> object contains a \n <a>BoundingBox</a> object, for the location of the label on the image. It also includes \n the confidence by which the bounding box was detected.</p>\n <p>\n <code>DetectLabels</code> also returns a hierarchical taxonomy of detected labels. For example,\n a detected car might be assigned the label <i>car</i>. The label <i>car</i>\n has two parent labels: <i>Vehicle</i> (its parent) and <i>Transportation</i> (its\n grandparent). \n The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.\n In the previous example, <i>Car</i>, <i>Vehicle</i>, and <i>Transportation</i>\n are returned as unique labels in the response.\n </p>\n <p>This is a stateless API operation. That is, the operation does not persist any\n data.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:DetectLabels</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectLabelsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do\n not need to be base64-encoded.</p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxLabels": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of labels you want the service to return in the response. The service\n returns the specified number of highest confidence labels. </p>"
|
||
}
|
||
},
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with confidence lower than this specified value.</p>\n <p>If <code>MinConfidence</code> is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectLabelsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Labels": {
|
||
"target": "com.amazonaws.rekognition#Labels",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of labels for the real-world objects detected. </p>"
|
||
}
|
||
},
|
||
"OrientationCorrection": {
|
||
"target": "com.amazonaws.rekognition#OrientationCorrection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The value of <code>OrientationCorrection</code> is always null.</p>\n <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.</p>\n <p>Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n </p>"
|
||
}
|
||
},
|
||
"LabelModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the label detection model that was used to detect labels.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectModerationLabels": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DetectModerationLabelsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DetectModerationLabelsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#HumanLoopQuotaExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects unsafe content in a specified JPEG or PNG format image.\n Use <code>DetectModerationLabels</code> to moderate images depending on your requirements.\n For example, you might want to filter images that contain nudity, but not images containing\n suggestive content.</p>\n <p>To filter images, use the labels returned by <code>DetectModerationLabels</code>\n to determine which types of content are appropriate.</p>\n \n <p>For information about moderation labels,\n see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>\n <p>You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectModerationLabelsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object.\n If you use the AWS CLI to call Amazon Rekognition operations,\n passing base64-encoded image bytes is not supported. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with a confidence level lower than this specified value.</p>\n <p>If you don't specify <code>MinConfidence</code>, the operation returns labels with\n confidence values greater than or equal to 50 percent.</p>"
|
||
}
|
||
},
|
||
"HumanLoopConfig": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopConfig",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets up the configuration for human evaluation, including the FlowDefinition\n the image will be sent to.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectModerationLabelsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ModerationLabels": {
|
||
"target": "com.amazonaws.rekognition#ModerationLabels",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Array of detected Moderation labels and the time, in milliseconds from the\n start of the video, they were detected.</p>"
|
||
}
|
||
},
|
||
"ModerationModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the moderation detection model that was used to detect unsafe content.</p>"
|
||
}
|
||
},
|
||
"HumanLoopActivationOutput": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopActivationOutput",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Shows the results of the human in the loop evaluation.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectProtectiveEquipment": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DetectProtectiveEquipmentRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DetectProtectiveEquipmentResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the \n following types of PPE.</p>\n <ul>\n <li>\n <p>Face cover</p>\n </li>\n <li>\n <p>Hand cover</p>\n </li>\n <li>\n <p>Head cover</p>\n </li>\n </ul>\n \n <p>You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.\n The image must be either a PNG or JPG formatted file. </p>\n \n <p>\n <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected in an image.</p>\n <p>For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).\n For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE\n covers the body part. The API returns the confidence it has in each detection\n (person, PPE, body part and body part coverage). It also returns a bounding box (<a>BoundingBox</a>) for each detected \n person and each detected item of PPE. </p>\n <p>You can optionally request a summary of detected PPE items with the <code>SummarizationAttributes</code> input parameter.\n The summary provides the following information. </p>\n <ul>\n <li>\n <p>The persons detected as wearing all of the types of PPE that you specify.</p>\n </li>\n <li>\n <p>The persons detected as not wearing all of the types PPE that you specify.</p>\n </li>\n <li>\n <p>The persons detected where PPE adornment could not be determined. </p>\n </li>\n </ul>\n <p>This is a stateless API operation. That is, the operation does not persist any data.</p>\n \n <p>This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectProtectiveEquipmentRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can \n reference an image stored in an Amazon S3 bucket. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"SummarizationAttributes": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentSummarizationAttributes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of PPE types that you want to summarize.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectProtectiveEquipmentResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProtectiveEquipmentModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The version number of the PPE detection model used to detect PPE in the image.</p>"
|
||
}
|
||
},
|
||
"Persons": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentPersons",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of persons detected in the image (including persons not wearing PPE).</p>"
|
||
}
|
||
},
|
||
"Summary": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentSummary",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Summary information for the types of PPE specified in the <code>SummarizationAttributes</code> input\n parameter.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectText": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#DetectTextRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#DetectTextResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects text in the input image and converts it into machine-readable text.</p>\n <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file. </p>\n <p>The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each\n <code>TextDetection</code> element provides information about a single word or line of text\n that was detected in the image. </p>\n <p>A word is one or more ISO basic latin script characters that are not separated by spaces.\n <code>DetectText</code> can detect up to 50 words in an image.</p>\n <p>A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation\n returns multiple lines.</p>\n <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,\n use the <code>TextDetection</code> object <code>Type</code> field. </p>\n <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>\n \n <p>For more information, see DetectText in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectTextFilters": {
|
||
"type": "structure",
|
||
"members": {
|
||
"WordFilter": {
|
||
"target": "com.amazonaws.rekognition#DetectionFilter"
|
||
},
|
||
"RegionsOfInterest": {
|
||
"target": "com.amazonaws.rekognition#RegionsOfInterest",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p> A Filter focusing on a certain area of the image. Uses a <code>BoundingBox</code> object to set the region\n of the image.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A set of optional parameters that you can use to set the criteria that the text must meet to be included in your response. \n <code>WordFilter</code> looks at a word’s height, width, and minimum confidence. <code>RegionOfInterest</code>\n lets you set a specific region of the image to look for text in.\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectTextRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Rekognition operations, you can't pass image bytes. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Filters": {
|
||
"target": "com.amazonaws.rekognition#DetectTextFilters",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Optional parameters that let you set the criteria that the text must meet to be included in your response.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectTextResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"TextDetections": {
|
||
"target": "com.amazonaws.rekognition#TextDetectionList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of text that was detected in the input image.</p>"
|
||
}
|
||
},
|
||
"TextModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The model version used to detect text.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#DetectionFilter": {
|
||
"type": "structure",
|
||
"members": {
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets the confidence of word detection. Words with detection confidence below this will be excluded \n from the result. Values should be between 50 and 100 as Text in Video will not return any result below \n 50.</p>"
|
||
}
|
||
},
|
||
"MinBoundingBoxHeight": {
|
||
"target": "com.amazonaws.rekognition#BoundingBoxHeight",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets the minimum height of the word bounding box. Words with bounding box heights lesser than \n this value will be excluded from the result. Value is relative to the video frame height.</p>"
|
||
}
|
||
},
|
||
"MinBoundingBoxWidth": {
|
||
"target": "com.amazonaws.rekognition#BoundingBoxWidth",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than \n this value will be excluded from the result. Value is relative to the video frame width.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A set of parameters that allow you to filter out certain results from your returned results.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Emotion": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#EmotionName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Type of emotion detected.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The emotions that appear to be expressed on the face, and the confidence level in the determination. \n The API is only making a determination of the physical appearance of a person's face. It is not a determination\n of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have\n a sad face might not be sad emotionally.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#EmotionName": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "HAPPY",
|
||
"name": "HAPPY"
|
||
},
|
||
{
|
||
"value": "SAD",
|
||
"name": "SAD"
|
||
},
|
||
{
|
||
"value": "ANGRY",
|
||
"name": "ANGRY"
|
||
},
|
||
{
|
||
"value": "CONFUSED",
|
||
"name": "CONFUSED"
|
||
},
|
||
{
|
||
"value": "DISGUSTED",
|
||
"name": "DISGUSTED"
|
||
},
|
||
{
|
||
"value": "SURPRISED",
|
||
"name": "SURPRISED"
|
||
},
|
||
{
|
||
"value": "CALM",
|
||
"name": "CALM"
|
||
},
|
||
{
|
||
"value": "UNKNOWN",
|
||
"name": "UNKNOWN"
|
||
},
|
||
{
|
||
"value": "FEAR",
|
||
"name": "FEAR"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Emotions": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Emotion"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#EquipmentDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A bounding box surrounding the item of detected PPE.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition has that the bounding box (<code>BoundingBox</code>) contains an item of PPE.</p>"
|
||
}
|
||
},
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentType",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The type of detected PPE.</p>"
|
||
}
|
||
},
|
||
"CoversBodyPart": {
|
||
"target": "com.amazonaws.rekognition#CoversBodyPart",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about the body part covered by the detected PPE.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about an item of Personal Protective Equipment (PPE) detected by\n <a>DetectProtectiveEquipment</a>. For more \n information, see <a>DetectProtectiveEquipment</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#EquipmentDetections": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#EquipmentDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#EvaluationResult": {
|
||
"type": "structure",
|
||
"members": {
|
||
"F1Score": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision\n and recall performance of the model as a single value. A higher value indicates better precision\n and recall performance. A lower score indicates that precision, recall, or both are performing poorly.\n \n </p>"
|
||
}
|
||
},
|
||
"Summary": {
|
||
"target": "com.amazonaws.rekognition#Summary",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The S3 bucket that contains the training summary.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The evaluation results for the training of a model.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ExtendedPaginationToken": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 1024
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ExternalImageId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 255
|
||
},
|
||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-:]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#EyeOpen": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the eyes on the face are open.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the eyes on the face are open, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Eyeglasses": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the face is wearing eye glasses or not.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face is wearing eye glasses, and the confidence level in\n the determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Face": {
|
||
"type": "structure",
|
||
"members": {
|
||
"FaceId": {
|
||
"target": "com.amazonaws.rekognition#FaceId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Unique identifier that Amazon Rekognition assigns to the face.</p>"
|
||
}
|
||
},
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Bounding box of the face.</p>"
|
||
}
|
||
},
|
||
"ImageId": {
|
||
"target": "com.amazonaws.rekognition#ImageId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Unique identifier that Amazon Rekognition assigns to the input image.</p>"
|
||
}
|
||
},
|
||
"ExternalImageId": {
|
||
"target": "com.amazonaws.rekognition#ExternalImageId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifier that you assign to all the faces in the input image.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Confidence level that the bounding box contains a face (and not a different object such\n as a tree).</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Describes the face properties such as the bounding box, face ID, image ID of the input\n image, and external image ID that you assigned. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceAttributes": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "DEFAULT",
|
||
"name": "DEFAULT"
|
||
},
|
||
{
|
||
"value": "ALL",
|
||
"name": "ALL"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceDetail": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Bounding box of the face. Default attribute.</p>"
|
||
}
|
||
},
|
||
"AgeRange": {
|
||
"target": "com.amazonaws.rekognition#AgeRange",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The estimated age range, in years, for the face. Low represents the lowest estimated\n age and High represents the highest estimated age.</p>"
|
||
}
|
||
},
|
||
"Smile": {
|
||
"target": "com.amazonaws.rekognition#Smile",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face is smiling, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"Eyeglasses": {
|
||
"target": "com.amazonaws.rekognition#Eyeglasses",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face is wearing eye glasses, and the confidence level in\n the determination.</p>"
|
||
}
|
||
},
|
||
"Sunglasses": {
|
||
"target": "com.amazonaws.rekognition#Sunglasses",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face is wearing sunglasses, and the confidence level in\n the determination.</p>"
|
||
}
|
||
},
|
||
"Gender": {
|
||
"target": "com.amazonaws.rekognition#Gender",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The predicted gender of a detected face.\n </p>"
|
||
}
|
||
},
|
||
"Beard": {
|
||
"target": "com.amazonaws.rekognition#Beard",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face has a beard, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"Mustache": {
|
||
"target": "com.amazonaws.rekognition#Mustache",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face has a mustache, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"EyesOpen": {
|
||
"target": "com.amazonaws.rekognition#EyeOpen",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the eyes on the face are open, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"MouthOpen": {
|
||
"target": "com.amazonaws.rekognition#MouthOpen",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the mouth on the face is open, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"Emotions": {
|
||
"target": "com.amazonaws.rekognition#Emotions",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The emotions that appear to be expressed on the face, and the confidence level in the determination. \n The API is only making a determination of the physical appearance of a person's face. It is not a determination\n of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have\n a sad face might not be sad emotionally.</p>"
|
||
}
|
||
},
|
||
"Landmarks": {
|
||
"target": "com.amazonaws.rekognition#Landmarks",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates the location of landmarks on the face. Default attribute.</p>"
|
||
}
|
||
},
|
||
"Pose": {
|
||
"target": "com.amazonaws.rekognition#Pose",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.</p>"
|
||
}
|
||
},
|
||
"Quality": {
|
||
"target": "com.amazonaws.rekognition#ImageQuality",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifies image brightness and sharpness. Default attribute.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Confidence level that the bounding box contains a face (and not a different object such\n as a tree). Default attribute.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Structure containing attributes of the face that the algorithm detected.</p>\n <p>A <code>FaceDetail</code> object contains either the default facial attributes or all facial attributes. \n The default attributes are <code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>.</p>\n <p>\n <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can return a <code>FaceDetail</code> object with all attributes. \n To specify which attributes to return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>.\n The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations\n don't have a <code>FaceAttributes</code> input parameter.</p> \n <ul>\n <li>\n <p>GetCelebrityRecognition</p>\n </li>\n <li>\n <p>GetPersonTracking</p>\n </li>\n <li>\n <p>GetFaceSearch</p>\n </li>\n </ul>\n <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations\n can return all facial attributes. To specify which attributes to return, use the \n <code>Attributes</code> input parameter for <code>DetectFaces</code>. For <code>IndexFaces</code>, use the\n <code>DetectAttributes</code> input parameter.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceDetailList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#FaceDetail"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Time, in milliseconds from the start of the video, that the face was detected.</p>"
|
||
}
|
||
},
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#FaceDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The face properties for the detected face.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a face detected in a video analysis request and the time the face was detected in the video. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceDetections": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#FaceDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceIdList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#FaceId"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 4096
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Face"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceMatch": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Similarity": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Confidence in the match of this face with the input face.</p>"
|
||
}
|
||
},
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#Face",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Describes the face properties such as the bounding box, face ID, image ID of the source\n image, and external image ID that you assigned.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides face metadata. In addition, it also provides the confidence in the match of\n this face with the input face.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceMatchList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#FaceMatch"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceModelVersionList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceRecord": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#Face",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Describes the face properties such as the bounding box, face ID, image ID of the input\n image, and external image ID that you assigned. </p>"
|
||
}
|
||
},
|
||
"FaceDetail": {
|
||
"target": "com.amazonaws.rekognition#FaceDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Structure containing attributes of the face that the algorithm detected.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Object containing both the face metadata (stored in the backend database), and facial\n attributes that are detected but aren't stored in the database.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceRecordList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#FaceRecord"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceSearchSettings": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ID of a collection that contains faces that you want to search for.</p>"
|
||
}
|
||
},
|
||
"FaceMatchThreshold": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Minimum face match confidence score that must be met to return a result for a recognized face. Default is 80.\n 0 is the lowest confidence. 100 is the highest confidence.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Input face recognition parameters for an Amazon Rekognition stream processor. <code>FaceRecognitionSettings</code> is a request\n parameter for <a>CreateStreamProcessor</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FaceSearchSortBy": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "INDEX",
|
||
"name": "INDEX"
|
||
},
|
||
{
|
||
"value": "TIMESTAMP",
|
||
"name": "TIMESTAMP"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Float": {
|
||
"type": "float",
|
||
"traits": {
|
||
"smithy.api#box": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#FlowDefinitionArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 256
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Gender": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#GenderType",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The predicted gender of the face.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the prediction.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The predicted gender of a detected face. \n </p>\n \n \n <p>Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance\n of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender\n identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor\n wearing a long-haired wig and earrings for a role might be predicted as female.</p>\n \n <p>Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be \n analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform. </p>\n \n <p>We don't recommend using gender binary predictions to make decisions that impact\u2028 an individual's rights, privacy, or access to services.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GenderType": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "Male",
|
||
"name": "Male"
|
||
},
|
||
{
|
||
"value": "Female",
|
||
"name": "Female"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Geometry": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An axis-aligned coarse representation of the detected item's location on the\n image.</p>"
|
||
}
|
||
},
|
||
"Polygon": {
|
||
"target": "com.amazonaws.rekognition#Polygon",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Within the bounding box, a fine-grained polygon around the detected item.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about where an object (<a>DetectCustomLabels</a>) or text (<a>DetectText</a>) is located on\n an image.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetCelebrityInfo": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetCelebrityInfoRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetCelebrityInfoResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the name and additional information about a celebrity based on his or her\n Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no\n additional information about the celebrity, this list is empty.</p>\n \n <p>For more information, see Recognizing Celebrities in an Image in\n the Amazon Rekognition Developer Guide.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:GetCelebrityInfo</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetCelebrityInfoRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Id": {
|
||
"target": "com.amazonaws.rekognition#RekognitionUniqueId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ID for the celebrity. You get the celebrity ID from a call to the <a>RecognizeCelebrities</a> operation,\n which recognizes celebrities in an image. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetCelebrityInfoResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Urls": {
|
||
"target": "com.amazonaws.rekognition#Urls",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of URLs pointing to additional celebrity information. </p>"
|
||
}
|
||
},
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the celebrity.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetCelebrityRecognition": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetCelebrityRecognitionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetCelebrityRecognitionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n <a>StartCelebrityRecognition</a>.</p>\n <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call\n to <a>StartCelebrityRecognition</a> which returns a job identifier (<code>JobId</code>).\n When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartCelebrityRecognition</code>.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>\n \n <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>\n <p>\n <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they are detected in an array\n (<code>Celebrities</code>) of <a>CelebrityRecognition</a> \n \n objects. Each <code>CelebrityRecognition</code> contains information about the celebrity in a <a>CelebrityDetail</a>\n object and the time, <code>Timestamp</code>, the celebrity was detected.\n </p>\n <note>\n \n <p>\n <code>GetCelebrityRecognition</code> only returns the default \n facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, \n <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed\n in the <code>Face</code> object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide. </p>\n </note>\n <p>By default, the <code>Celebrities</code> array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value <code>ID</code> in the <code>SortBy</code> input parameter.</p>\n <p>The <code>CelebrityDetail</code> object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling <a>GetCelebrityInfo</a> with the celebrity identifer.</p>\n <p>No information is returned for faces not recognized as celebrities.</p>\n <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call <code>GetCelebrityDetection</code>\n and populate the <code>NextToken</code> request parameter with the token\n value returned from the previous call to <code>GetCelebrityRecognition</code>.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetCelebrityRecognitionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Job identifier for the required celebrity recognition analysis. You can get the job identifer from\n a call to <code>StartCelebrityRecognition</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of celebrities. </p>"
|
||
}
|
||
},
|
||
"SortBy": {
|
||
"target": "com.amazonaws.rekognition#CelebrityRecognitionSortBy",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sort to use for celebrities returned in <code>Celebrities</code> field. Specify <code>ID</code> to sort by the celebrity identifier,\n specify <code>TIMESTAMP</code> to sort by the time the celebrity was recognized.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetCelebrityRecognitionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the celebrity recognition job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in\n every page of paginated responses from a Amazon Rekognition Video operation.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request\n to retrieve the next set of celebrities.</p>"
|
||
}
|
||
},
|
||
"Celebrities": {
|
||
"target": "com.amazonaws.rekognition#CelebrityRecognitions",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Array of celebrities recognized in the video.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetContentModeration": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetContentModerationRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetContentModerationResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by\n <a>StartContentModeration</a>.</p>\n\n <p>Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling\n <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartContentModeration</code>.\n To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>\n \n <p>For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.</p>\n <p>\n <code>GetContentModeration</code> returns detected unsafe content labels,\n and the time they are detected, in an array, <code>ModerationLabels</code>, of\n <a>ContentModerationDetection</a> objects.\n </p>\n <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code>\n input parameter. </p>\n <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit\n the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>\n and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>\n returned from the previous call to <code>GetContentModeration</code>.</p>\n \n <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetContentModerationRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the unsafe content job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetContentModeration</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition\n returns a pagination token in the response. You can use this pagination token\n to retrieve the next set of unsafe content labels.</p>"
|
||
}
|
||
},
|
||
"SortBy": {
|
||
"target": "com.amazonaws.rekognition#ContentModerationSortBy",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sort to use for elements in the <code>ModerationLabelDetections</code> array.\n Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected.\n Use <code>NAME</code> to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by <code>TIMESTAMP</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetContentModerationResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the unsafe content analysis job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code>\n is returned in every page of paginated responses from <code>GetContentModeration</code>. </p>"
|
||
}
|
||
},
|
||
"ModerationLabels": {
|
||
"target": "com.amazonaws.rekognition#ContentModerationDetections",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The detected unsafe content labels and the time(s) they were detected.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent\n request to retrieve the next set of unsafe content labels. </p>"
|
||
}
|
||
},
|
||
"ModerationModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the moderation detection model that was used to detect unsafe content.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetFaceDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetFaceDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetFaceDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>.</p>\n <p>Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling <a>StartFaceDetection</a>\n which returns a job identifier (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to <code>StartFaceDetection</code>. To get the results\n of the face detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.\n If so, call <a>GetFaceDetection</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>\n <p>\n <code>GetFaceDetection</code> returns an array of detected faces (<code>Faces</code>) sorted by the time the faces were detected. </p>\n <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call <code>GetFaceDetection</code> and populate the <code>NextToken</code> request parameter with the token\n value returned from the previous call to <code>GetFaceDetection</code>.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetFaceDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Unique identifier for the face detection job. The <code>JobId</code> is returned from <code>StartFaceDetection</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of faces.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetFaceDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the face detection job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in\n every page of paginated responses from a Amazon Rekognition video operation.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces. </p>"
|
||
}
|
||
},
|
||
"Faces": {
|
||
"target": "com.amazonaws.rekognition#FaceDetections",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces detected in the video. Each element contains a detected face's details and the time,\n in milliseconds from the start of the video, the face was detected. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetFaceSearch": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetFaceSearchRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetFaceSearchResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the face search results for Amazon Rekognition Video face search started by\n <a>StartFaceSearch</a>. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.</p>\n <p>Face search in a video is an asynchronous operation. You start face search by calling\n to <a>StartFaceSearch</a> which returns a job identifier (<code>JobId</code>).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartFaceSearch</code>.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>.</p> \n \n <p>For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.</p>\n <p>The search results are retured in an array, <code>Persons</code>, of\n <a>PersonMatch</a> objects. Each<code>PersonMatch</code> element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.</p>\n <note>\n \n <p>\n <code>GetFaceSearch</code> only returns the default \n facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, \n <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed\n in the <code>Face</code> object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide. </p>\n </note>\n\n <p>By default, the <code>Persons</code> array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying <code>INDEX</code> for the <code>SORTBY</code> input\n parameter.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetFaceSearchRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The job identifer for the search request. You get the job identifier from an initial call to <code>StartFaceSearch</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of search results. </p>"
|
||
}
|
||
},
|
||
"SortBy": {
|
||
"target": "com.amazonaws.rekognition#FaceSearchSortBy",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sort to use for grouping faces in the response. Use <code>TIMESTAMP</code> to group faces by the time\n that they are recognized. Use <code>INDEX</code> to sort by recognized faces. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetFaceSearchResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the face search job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>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 search results. </p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code> is returned in every page of paginated responses\n from a Amazon Rekognition Video operation. </p>"
|
||
}
|
||
},
|
||
"Persons": {
|
||
"target": "com.amazonaws.rekognition#PersonMatches",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of persons, <a>PersonMatch</a>,\n in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information\n for when persons are matched in the video.\n You specify the input collection in an initial call to <code>StartFaceSearch</code>.\n Each <code>Persons</code> element includes a time the person was matched,\n face match details (<code>FaceMatches</code>) for matching faces in the collection,\n and person information (<code>Person</code>) for the matched person. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetLabelDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetLabelDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetLabelDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>\n\n <p>The label detection operation is started by a call to <a>StartLabelDetection</a>\n which returns a job identifier (<code>JobId</code>). When the label detection operation finishes, Amazon Rekognition publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. To get the results\n of the label detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.\n If so, call <a>GetLabelDetection</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>\n <p>\n <code>GetLabelDetection</code> returns an array of detected labels (<code>Labels</code>) sorted by the time\n the labels were detected. You can also sort by the label name by specifying <code>NAME</code> for the\n <code>SortBy</code> input parameter.</p>\n <p>The labels returned include the label name, the percentage confidence in the accuracy of the detected label,\n and the time the label was detected in the video.</p>\n <p>The returned labels also include bounding box information for common objects, a \n hierarchical taxonomy of detected labels, and the version of the label model used for detection.</p>\n \n <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call <code>GetlabelDetection</code> and populate the <code>NextToken</code> request parameter with the token\n value returned from the previous call to <code>GetLabelDetection</code>.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetLabelDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Job identifier for the label detection operation for which you want results returned. You get the job identifer from\n an initial call to <code>StartlabelDetection</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of labels. </p>"
|
||
}
|
||
},
|
||
"SortBy": {
|
||
"target": "com.amazonaws.rekognition#LabelDetectionSortBy",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sort to use for elements in the <code>Labels</code> array.\n Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected.\n Use <code>NAME</code> to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by <code>TIMESTAMP</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetLabelDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the label detection job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in\n every page of paginated responses from a Amazon Rekognition video operation.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request\n to retrieve the next set of labels.</p>"
|
||
}
|
||
},
|
||
"Labels": {
|
||
"target": "com.amazonaws.rekognition#LabelDetections",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of labels detected in the video. Each element contains the detected label and the time,\n in milliseconds from the start of the video, that the label was detected. </p>"
|
||
}
|
||
},
|
||
"LabelModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the label detection model that was used to detect labels.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetPersonTracking": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetPersonTrackingRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetPersonTrackingResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>\n\n <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>\n which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p>\n <p>To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.\n If so, call <a>GetPersonTracking</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>\n <p>\n <code>GetPersonTracking</code> returns an array, <code>Persons</code>, of tracked persons and the time(s) their \n paths were tracked in the video. </p>\n <note>\n <p>\n <code>GetPersonTracking</code> only returns the default \n facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, \n <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed\n in the <code>Face</code> object of the following response syntax are not returned. </p>\n \n <p>For more information, see FaceDetail in the Amazon Rekognition Developer Guide.</p>\n </note>\n\n \n <p>By default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter.</p>\n\n <p>Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token\n value returned from the previous call to <code>GetPersonTracking</code>.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetPersonTrackingRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for a job that tracks persons in a video. You get the <code>JobId</code> from a call to <code>StartPersonTracking</code>.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of persons. </p>"
|
||
}
|
||
},
|
||
"SortBy": {
|
||
"target": "com.amazonaws.rekognition#PersonTrackingSortBy",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sort to use for elements in the <code>Persons</code> array. Use <code>TIMESTAMP</code> to sort array elements\n by the time persons are detected. Use <code>INDEX</code> to sort by the tracked persons.\n If you sort by <code>INDEX</code>, the array elements for each person are sorted by detection confidence.\n The default sort is by <code>TIMESTAMP</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetPersonTrackingResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the person tracking job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in\n every page of paginated responses from a Amazon Rekognition Video operation.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>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 persons. </p>"
|
||
}
|
||
},
|
||
"Persons": {
|
||
"target": "com.amazonaws.rekognition#PersonDetections",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of the persons detected in the video and the time(s) their path was tracked throughout the video.\n An array element will exist for each time a person's path is tracked. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetSegmentDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetSegmentDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetSegmentDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the segment detection results of a Amazon Rekognition Video analysis started by <a>StartSegmentDetection</a>.</p>\n <p>Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling <a>StartSegmentDetection</a> which returns a job identifier (<code>JobId</code>).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartSegmentDetection</code>. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. \n if so, call <code>GetSegmentDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call\n of <code>StartSegmentDetection</code>.</p>\n <p>\n <code>GetSegmentDetection</code> returns detected segments in an array (<code>Segments</code>)\n of <a>SegmentDetection</a> objects. <code>Segments</code> is sorted by the segment types \n specified in the <code>SegmentTypes</code> input parameter of <code>StartSegmentDetection</code>. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.</p>\n <p>Use <code>SelectedSegmentTypes</code> to find out the type of segment detection requested in the \n call to <code>StartSegmentDetection</code>.</p>\n <p>Use the <code>MaxResults</code> parameter to limit the number of segment detections returned. If there are more results than \n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call <code>GetSegmentDetection</code>\n and populate the <code>NextToken</code> request parameter with the token value returned from the previous \n call to <code>GetSegmentDetection</code>.</p>\n \n <p>For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetSegmentDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Job identifier for the text detection operation for which you want results returned. \n You get the job identifer from an initial call to <code>StartSegmentDetection</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetSegmentDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Current status of the segment detection job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadataList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Currently, Amazon Rekognition Video returns a single object in the\n <code>VideoMetadata</code> array. The object\n contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. \n The <code>VideoMetadata</code> object includes the video codec, video format and other information.\n Video metadata is returned in each page of information returned by <code>GetSegmentDetection</code>.</p>"
|
||
}
|
||
},
|
||
"AudioMetadata": {
|
||
"target": "com.amazonaws.rekognition#AudioMetadataList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of \n objects. There can be multiple audio streams. \n Each <code>AudioMetadata</code> object contains metadata for a single audio stream.\n Audio information in an <code>AudioMetadata</code> objects includes \n the audio codec, the number of audio channels, the duration of the audio stream,\n and the sample rate. Audio metadata is returned in each page of information returned\n by <code>GetSegmentDetection</code>.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>"
|
||
}
|
||
},
|
||
"Segments": {
|
||
"target": "com.amazonaws.rekognition#SegmentDetections",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) \n specified in the <code>SegmentTypes</code> input parameter of <code>StartSegmentDetection</code>. Within\n each segment type the array is sorted by timestamp values.</p>"
|
||
}
|
||
},
|
||
"SelectedSegmentTypes": {
|
||
"target": "com.amazonaws.rekognition#SegmentTypesInfo",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array containing the segment types requested in the call to <code>StartSegmentDetection</code>.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetTextDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#GetTextDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#GetTextDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets the text detection results of a Amazon Rekognition Video analysis started by <a>StartTextDetection</a>.</p>\n <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by \n calling <a>StartTextDetection</a> which returns a job identifier (<code>JobId</code>)\n When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartTextDetection</code>. To get the results\n of the text detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. \n if so, call <code>GetTextDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call\n of <code>StartLabelDetection</code>.</p>\n <p>\n <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by \n the time the text was detected, up to 50 words per frame of video.</p>\n <p>Each element of the array includes the detected text, the precentage confidence in the acuracy \n of the detected text, the time the text was detected, bounding box information for where the text\n was located, and unique identifiers for words and their lines.</p>\n <p>Use MaxResults parameter to limit the number of text detections returned. If there are more results than \n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call <code>GetTextDetection</code>\n and populate the <code>NextToken</code> request parameter with the token value returned from the previous \n call to <code>GetTextDetection</code>.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetTextDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Job identifier for the text detection operation for which you want results returned. \n You get the job identifer from an initial call to <code>StartTextDetection</code>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GetTextDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobStatus": {
|
||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Current status of the text detection job.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||
}
|
||
},
|
||
"VideoMetadata": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata"
|
||
},
|
||
"TextDetections": {
|
||
"target": "com.amazonaws.rekognition#TextDetectionResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of text detected in the video. Each element contains the detected text, the time in milliseconds\n from the start of the video that the text was detected, and where it was detected on the screen.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.</p>"
|
||
}
|
||
},
|
||
"TextModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the text detection model that was used to detect text.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#GroundTruthManifest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"S3Object": {
|
||
"target": "com.amazonaws.rekognition#S3Object"
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file. \n</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopActivationOutput": {
|
||
"type": "structure",
|
||
"members": {
|
||
"HumanLoopArn": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the HumanLoop created.</p>"
|
||
}
|
||
},
|
||
"HumanLoopActivationReasons": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopActivationReasons",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Shows if and why human review was needed.</p>"
|
||
}
|
||
},
|
||
"HumanLoopActivationConditionsEvaluationResults": {
|
||
"target": "com.amazonaws.rekognition#SynthesizedJsonHumanLoopActivationConditionsEvaluationResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Shows the result of condition evaluations, including those conditions which activated a \n human review.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did \n not trigger human review.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopActivationReason": {
|
||
"type": "string"
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopActivationReasons": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopActivationReason"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 256
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopConfig": {
|
||
"type": "structure",
|
||
"members": {
|
||
"HumanLoopName": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the human review used for this image. This should be kept unique within a region.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"FlowDefinitionArn": {
|
||
"target": "com.amazonaws.rekognition#FlowDefinitionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker\n <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html\">CreateFlowDefinition</a>\n Operation. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"DataAttributes": {
|
||
"target": "com.amazonaws.rekognition#HumanLoopDataAttributes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets attributes of the input data.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets up the flow definition the image will be sent to if one of the conditions is met. \n You can also set certain attributes of the image before review.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopDataAttributes": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ContentClassifiers": {
|
||
"target": "com.amazonaws.rekognition#ContentClassifiers",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sets whether the input image is free of personally identifiable information.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Allows you to set attributes of the image. Currently, you can declare an image as free of\n personally identifiable information.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopName": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 63
|
||
},
|
||
"smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#HumanLoopQuotaExceededException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ResourceType": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The resource type.</p>"
|
||
}
|
||
},
|
||
"QuotaCode": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The quota code.</p>"
|
||
}
|
||
},
|
||
"ServiceCode": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The service code.</p>"
|
||
}
|
||
},
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The number of in-progress human reviews you have has exceeded the number allowed.</p>",
|
||
"smithy.api#error": "client",
|
||
"smithy.api#httpError": 402
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#IdempotentParameterMismatchException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input\n parameters is different from the previous call to the operation.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Image": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Bytes": {
|
||
"target": "com.amazonaws.rekognition#ImageBlob",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Blob of image bytes up to 5 MBs.</p>"
|
||
}
|
||
},
|
||
"S3Object": {
|
||
"target": "com.amazonaws.rekognition#S3Object",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifies an S3 object as the image source.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides the input image either as bytes or an S3 object.</p>\n <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>\n property. For example, you would use the <code>Bytes</code> property to pass an image loaded\n from a local file system. Image bytes passed by using the <code>Bytes</code> property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations. </p>\n \n <p>For more information, see Analyzing an Image Loaded from a Local File System \n in the Amazon Rekognition Developer Guide.</p>\n <p> You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n <code>S3Object</code> property. Images stored in an S3 bucket do not need to be\n base64-encoded.</p>\n <p>The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.</p>\n <p>If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.</p>\n \n <p>For Amazon Rekognition to process an S3 object, the user must have permission to access the S3\n object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ImageBlob": {
|
||
"type": "blob",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 5242880
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ImageId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ImageQuality": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Brightness": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Value representing brightness of the face. The service returns a value between 0 and\n 100 (inclusive). A higher value indicates a brighter face image.</p>"
|
||
}
|
||
},
|
||
"Sharpness": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Value representing sharpness of the face. The service returns a value between 0 and 100\n (inclusive). A higher value indicates a sharper face image.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifies face image brightness and sharpness. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ImageTooLargeException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image size exceeds the allowed limit. If you are calling\n DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#IndexFaces": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#IndexFacesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#IndexFacesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ServiceQuotaExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Detects faces in the input image and adds them to the specified collection. </p>\n <p>Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n <a>SearchFaces</a> and <a>SearchFacesByImage</a>\n operations.</p>\n \n <p>For more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.</p>\n <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>\n\n <p>If you're using version 1.0 of the face detection model, <code>IndexFaces</code>\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image. </p>\n <p>If you're using version 4 or later of the face model, image orientation information\n is not returned in the <code>OrientationCorrection</code> field. </p>\n <p>To determine which version of the model you're using, call <a>DescribeCollection</a>\n and supply the collection ID. You can also get the model version from the value of <code>FaceModelVersion</code> in the response\n from <code>IndexFaces</code>\n </p>\n \n <p>For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.</p>\n <p>If you provide the optional <code>ExternalImageId</code> for the input image you\n 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\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.</p>\n <p>You can specify the maximum number of faces to index with the <code>MaxFaces</code> input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.</p>\n <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, <code>IndexFaces</code> chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use <code>QualityFilter</code>, to set the quality bar\n by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.\n If you do not want to filter detected faces, specify <code>NONE</code>. </p>\n <note>\n <p>To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n <a>DescribeCollection</a>. </p>\n </note>\n <p>Information about faces detected in an image, but not indexed, is returned in an array of\n <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't\n indexed for reasons such as:</p>\n <ul>\n <li>\n <p>The number of faces detected exceeds the value of the <code>MaxFaces</code> request\n parameter.</p>\n </li>\n <li>\n <p>The face is too small compared to the image dimensions.</p>\n </li>\n <li>\n <p>The face is too blurry.</p>\n </li>\n <li>\n <p>The image is too dark.</p>\n </li>\n <li>\n <p>The face has an extreme pose.</p>\n </li>\n <li>\n <p>The face doesn’t have enough detail to be suitable for face search.</p>\n </li>\n </ul>\n <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for \n all detected faces, <code>FaceRecords</code>. This includes: </p>\n <ul>\n <li>\n <p>The bounding box, <code>BoundingBox</code>, of the detected face. </p>\n </li>\n <li>\n <p>A confidence value, <code>Confidence</code>, which indicates the confidence that the\n bounding box contains a face.</p>\n </li>\n <li>\n <p>A face ID, <code>FaceId</code>, assigned by the service for each face that's detected\n and stored.</p>\n </li>\n <li>\n <p>An image ID, <code>ImageId</code>, assigned by the service for the input image.</p>\n </li>\n </ul>\n <p>If you request all facial attributes (by using the <code>detectionAttributes</code>\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, and use the same external ID in the\n <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>\n \n\n <p></p>\n \n\n <p>The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>\n <p>This operation requires permissions to perform the <code>rekognition:IndexFaces</code>\n action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#IndexFacesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ID of an existing collection to which you want to add the faces that are detected\n in the input images.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes isn't supported. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ExternalImageId": {
|
||
"target": "com.amazonaws.rekognition#ExternalImageId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ID you want to assign to all the faces detected in the image.</p>"
|
||
}
|
||
},
|
||
"DetectionAttributes": {
|
||
"target": "com.amazonaws.rekognition#Attributes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of facial attributes that you want to be returned. This can be the default\n list of attributes or all attributes. If you don't specify a value for <code>Attributes</code>\n or if you specify <code>[\"DEFAULT\"]</code>, the API returns the following subset of facial\n attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>,\n <code>Quality</code>, and <code>Landmarks</code>. If you provide <code>[\"ALL\"]</code>, all\n facial attributes are returned, but the operation takes longer to complete.</p>\n <p>If you provide both, <code>[\"ALL\", \"DEFAULT\"]</code>, the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes). </p>"
|
||
}
|
||
},
|
||
"MaxFaces": {
|
||
"target": "com.amazonaws.rekognition#MaxFacesToIndex",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The maximum number of faces to index. The value of <code>MaxFaces</code> must be greater\n than or equal to 1. <code>IndexFaces</code> returns no more than 100 detected faces in an\n image, even if you specify a larger value for <code>MaxFaces</code>.</p>\n <p>If <code>IndexFaces</code> detects more faces than the value of <code>MaxFaces</code>, the\n faces with the lowest quality are filtered out first. If there are still more faces than the\n value of <code>MaxFaces</code>, the faces with the smallest bounding boxes are filtered out\n (up to the number that's needed to satisfy the value of <code>MaxFaces</code>). Information\n about the unindexed faces is available in the <code>UnindexedFaces</code> array. </p>\n <p>The faces that are returned by <code>IndexFaces</code> are sorted by the largest face\n bounding box size to the smallest size, in descending order.</p>\n <p>\n <code>MaxFaces</code> can be used with a collection associated with any version of \n the face model.</p>"
|
||
}
|
||
},
|
||
"QualityFilter": {
|
||
"target": "com.amazonaws.rekognition#QualityFilter",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't indexed. If you specify <code>AUTO</code>, Amazon Rekognition chooses the quality bar.\n If you specify <code>LOW</code>, \n <code>MEDIUM</code>, or <code>HIGH</code>, filtering removes all faces that\n don’t meet the chosen quality bar. The default value is <code>AUTO</code>.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify <code>NONE</code>, no\n filtering is performed.\n </p>\n <p>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#IndexFacesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"FaceRecords": {
|
||
"target": "com.amazonaws.rekognition#FaceRecordList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces detected and added to the collection.\n For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.\n </p>"
|
||
}
|
||
},
|
||
"OrientationCorrection": {
|
||
"target": "com.amazonaws.rekognition#OrientationCorrection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If your collection is associated with a face detection model that's later \n than version 3.0, the value of <code>OrientationCorrection</code>\n is always null and no orientation information is returned.</p>\n \n <p>If your collection is associated with a face detection model that's\n version 3.0 or earlier, the following applies:</p>\n <ul>\n <li>\n <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction - the bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata. The value of <code>OrientationCorrection</code>\n is null.</p>\n </li>\n <li>\n <p>If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns\n an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform \n image correction for images. The bounding box coordinates aren't translated and represent the \n object locations before the image is rotated.</p>\n </li>\n </ul>\n \n \n \n <p>Bounding box information is returned in the <code>FaceRecords</code> array. You can get the \n version of the face detection model by calling <a>DescribeCollection</a>. </p>"
|
||
}
|
||
},
|
||
"FaceModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The version number of the face detection model that's associated with the input\n collection (<code>CollectionId</code>).</p>"
|
||
}
|
||
},
|
||
"UnindexedFaces": {
|
||
"target": "com.amazonaws.rekognition#UnindexedFaces",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces that were detected in the image but weren't indexed. They weren't\n indexed because the quality filter identified them as low quality, or the\n <code>MaxFaces</code> request parameter filtered them out. To use the quality filter, you\n specify the <code>QualityFilter</code> request parameter.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#InferenceUnits": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Instance": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The position of the label instance on the image.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition has in the accuracy of the bounding box.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An instance of a label returned by Amazon Rekognition Image (<a>DetectLabels</a>)\n or by Amazon Rekognition Video (<a>GetLabelDetection</a>).</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Instances": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Instance"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#InternalServerError": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Amazon Rekognition experienced a service issue. Try your call again.</p>",
|
||
"smithy.api#error": "server"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#InvalidImageFormatException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The provided image format is not supported. </p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#InvalidPaginationTokenException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Pagination token in the request is not valid.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#InvalidParameterException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Input parameter violated a constraint. Validate your parameter before calling the API\n operation again.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#InvalidS3ObjectException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#JobId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 64
|
||
},
|
||
"smithy.api#pattern": "^[a-zA-Z0-9-_]+$"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#JobTag": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 256
|
||
},
|
||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-:]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#KinesisDataArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#KinesisDataStream": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Arn": {
|
||
"target": "com.amazonaws.rekognition#KinesisDataArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ARN of the output Amazon Kinesis Data Streams stream.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see\n CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#KinesisVideoArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#KinesisVideoStream": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Arn": {
|
||
"target": "com.amazonaws.rekognition#KinesisVideoArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ARN of the Kinesis video stream stream that streams the source video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see\n CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#KmsKeyId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 2048
|
||
},
|
||
"smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Label": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name (label) of the object or scene.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence.</p>"
|
||
}
|
||
},
|
||
"Instances": {
|
||
"target": "com.amazonaws.rekognition#Instances",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If <code>Label</code> represents an object, <code>Instances</code> contains the bounding boxes for each instance of the detected object.\n Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.</p>"
|
||
}
|
||
},
|
||
"Parents": {
|
||
"target": "com.amazonaws.rekognition#Parents",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The parent labels for a label. The response includes all ancestor labels.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Structure containing details about the detected label, including the name, detected instances, parent labels, and level of\n confidence.</p>\n <p>\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#LabelDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Time, in milliseconds from the start of the video, that the label was detected.</p>"
|
||
}
|
||
},
|
||
"Label": {
|
||
"target": "com.amazonaws.rekognition#Label",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details about the detected label.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a label detected in a video analysis request and the time the label was detected in the video. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#LabelDetectionSortBy": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "NAME",
|
||
"name": "NAME"
|
||
},
|
||
{
|
||
"value": "TIMESTAMP",
|
||
"name": "TIMESTAMP"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#LabelDetections": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#LabelDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Labels": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Label"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Landmark": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#LandmarkType",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Type of landmark.</p>"
|
||
}
|
||
},
|
||
"X": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The x-coordinate of the landmark expressed as a ratio of the width of the image. \n The x-coordinate is measured from the left-side of the image. \n For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. </p>"
|
||
}
|
||
},
|
||
"Y": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The y-coordinate of the landmark expressed as a ratio of the height of the image. \n The y-coordinate is measured from the top of the image. \n For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates the location of the landmark on the face.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#LandmarkType": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "eyeLeft",
|
||
"name": "eyeLeft"
|
||
},
|
||
{
|
||
"value": "eyeRight",
|
||
"name": "eyeRight"
|
||
},
|
||
{
|
||
"value": "nose",
|
||
"name": "nose"
|
||
},
|
||
{
|
||
"value": "mouthLeft",
|
||
"name": "mouthLeft"
|
||
},
|
||
{
|
||
"value": "mouthRight",
|
||
"name": "mouthRight"
|
||
},
|
||
{
|
||
"value": "leftEyeBrowLeft",
|
||
"name": "leftEyeBrowLeft"
|
||
},
|
||
{
|
||
"value": "leftEyeBrowRight",
|
||
"name": "leftEyeBrowRight"
|
||
},
|
||
{
|
||
"value": "leftEyeBrowUp",
|
||
"name": "leftEyeBrowUp"
|
||
},
|
||
{
|
||
"value": "rightEyeBrowLeft",
|
||
"name": "rightEyeBrowLeft"
|
||
},
|
||
{
|
||
"value": "rightEyeBrowRight",
|
||
"name": "rightEyeBrowRight"
|
||
},
|
||
{
|
||
"value": "rightEyeBrowUp",
|
||
"name": "rightEyeBrowUp"
|
||
},
|
||
{
|
||
"value": "leftEyeLeft",
|
||
"name": "leftEyeLeft"
|
||
},
|
||
{
|
||
"value": "leftEyeRight",
|
||
"name": "leftEyeRight"
|
||
},
|
||
{
|
||
"value": "leftEyeUp",
|
||
"name": "leftEyeUp"
|
||
},
|
||
{
|
||
"value": "leftEyeDown",
|
||
"name": "leftEyeDown"
|
||
},
|
||
{
|
||
"value": "rightEyeLeft",
|
||
"name": "rightEyeLeft"
|
||
},
|
||
{
|
||
"value": "rightEyeRight",
|
||
"name": "rightEyeRight"
|
||
},
|
||
{
|
||
"value": "rightEyeUp",
|
||
"name": "rightEyeUp"
|
||
},
|
||
{
|
||
"value": "rightEyeDown",
|
||
"name": "rightEyeDown"
|
||
},
|
||
{
|
||
"value": "noseLeft",
|
||
"name": "noseLeft"
|
||
},
|
||
{
|
||
"value": "noseRight",
|
||
"name": "noseRight"
|
||
},
|
||
{
|
||
"value": "mouthUp",
|
||
"name": "mouthUp"
|
||
},
|
||
{
|
||
"value": "mouthDown",
|
||
"name": "mouthDown"
|
||
},
|
||
{
|
||
"value": "leftPupil",
|
||
"name": "leftPupil"
|
||
},
|
||
{
|
||
"value": "rightPupil",
|
||
"name": "rightPupil"
|
||
},
|
||
{
|
||
"value": "upperJawlineLeft",
|
||
"name": "upperJawlineLeft"
|
||
},
|
||
{
|
||
"value": "midJawlineLeft",
|
||
"name": "midJawlineLeft"
|
||
},
|
||
{
|
||
"value": "chinBottom",
|
||
"name": "chinBottom"
|
||
},
|
||
{
|
||
"value": "midJawlineRight",
|
||
"name": "midJawlineRight"
|
||
},
|
||
{
|
||
"value": "upperJawlineRight",
|
||
"name": "upperJawlineRight"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Landmarks": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Landmark"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#LimitExceededException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations \n (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until\n the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListCollections": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#ListCollectionsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#ListCollectionsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Returns list of collection IDs in your account.\n If the result is truncated, the response also provides a <code>NextToken</code>\n that you can use in the subsequent request to fetch the next set of collection IDs.</p>\n \n <p>For an example, see Listing Collections in the Amazon Rekognition Developer Guide.</p>\n <p>This operation requires permissions to perform the <code>rekognition:ListCollections</code> action.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"items": "CollectionIds",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListCollectionsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Pagination token from the previous response.</p>"
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#PageSize",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of collection IDs to return. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListCollectionsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionIds": {
|
||
"target": "com.amazonaws.rekognition#CollectionIdList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of collection IDs.</p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the result is truncated, the response provides a <code>NextToken</code> that you can\n use in the subsequent request to fetch the next set of collection IDs.</p>"
|
||
}
|
||
},
|
||
"FaceModelVersions": {
|
||
"target": "com.amazonaws.rekognition#FaceModelVersionList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version numbers of the face detection models associated with the collections in the array <code>CollectionIds</code>.\n For example, the value of <code>FaceModelVersions[2]</code> is the version number for the face detection model used\n by the collection in <code>CollectionId[2]</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListFaces": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#ListFacesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#ListFacesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Returns metadata for faces in the specified collection.\n This metadata includes information such as the bounding box coordinates, the confidence\n (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection\n in the Amazon Rekognition Developer Guide.</p>\n \n \n <p>This operation requires permissions to perform the\n <code>rekognition:ListFaces</code> action.</p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"items": "Faces",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListFacesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of the collection from which to list the faces.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more data to retrieve),\n Amazon Rekognition returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of faces.</p>"
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#PageSize",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of faces to return.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListFacesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Faces": {
|
||
"target": "com.amazonaws.rekognition#FaceList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of <code>Face</code> objects. </p>"
|
||
}
|
||
},
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition returns this token that you can use in the\n subsequent request to retrieve the next set of faces.</p>"
|
||
}
|
||
},
|
||
"FaceModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListStreamProcessors": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#ListStreamProcessorsRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#ListStreamProcessorsResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidPaginationTokenException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. </p>",
|
||
"smithy.api#paginated": {
|
||
"inputToken": "NextToken",
|
||
"outputToken": "NextToken",
|
||
"pageSize": "MaxResults"
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListStreamProcessorsRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video\n returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors. </p>"
|
||
}
|
||
},
|
||
"MaxResults": {
|
||
"target": "com.amazonaws.rekognition#MaxResults",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListStreamProcessorsResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"NextToken": {
|
||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent\n request to retrieve the next set of stream processors. </p>"
|
||
}
|
||
},
|
||
"StreamProcessors": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>List of stream processors that you have created.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListTagsForResource": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#ListTagsForResourceRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#ListTagsForResourceResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.\n </p>\n <p>This operation requires permissions to perform the\n <code>rekognition:ListTagsForResource</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListTagsForResourceRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ResourceArn": {
|
||
"target": "com.amazonaws.rekognition#ResourceArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ListTagsForResourceResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Tags": {
|
||
"target": "com.amazonaws.rekognition#TagMap",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n A list of key-value tags assigned to the resource.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#MaxFaces": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 1,
|
||
"max": 4096
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#MaxFacesToIndex": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#MaxResults": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ModerationLabel": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the confidence that Amazon Rekognition has that the label has been correctly\n identified.</p>\n <p>If you don't specify the <code>MinConfidence</code> parameter in the call to\n <code>DetectModerationLabels</code>, the operation returns labels with a confidence value\n greater than or equal to 50 percent.</p>"
|
||
}
|
||
},
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The label name for the type of unsafe content detected in the image.</p>"
|
||
}
|
||
},
|
||
"ParentName": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name for the parent label. Labels at the top level of the hierarchy have the parent\n label <code>\"\"</code>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides information about a single type of unsafe content found in an image or video. Each type of\n moderated content has a label within a hierarchical taxonomy. For more information, see\n Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ModerationLabels": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ModerationLabel"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#MouthOpen": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the mouth on the face is open or not.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the mouth on the face is open, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Mustache": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the face has mustache or not.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face has a mustache, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#NotificationChannel": {
|
||
"type": "structure",
|
||
"members": {
|
||
"SNSTopicArn": {
|
||
"target": "com.amazonaws.rekognition#SNSTopicArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"RoleArn": {
|
||
"target": "com.amazonaws.rekognition#RoleArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n <a>api-video</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#OrientationCorrection": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "ROTATE_0",
|
||
"name": "ROTATE_0"
|
||
},
|
||
{
|
||
"value": "ROTATE_90",
|
||
"name": "ROTATE_90"
|
||
},
|
||
{
|
||
"value": "ROTATE_180",
|
||
"name": "ROTATE_180"
|
||
},
|
||
{
|
||
"value": "ROTATE_270",
|
||
"name": "ROTATE_270"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#OutputConfig": {
|
||
"type": "structure",
|
||
"members": {
|
||
"S3Bucket": {
|
||
"target": "com.amazonaws.rekognition#S3Bucket",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The S3 bucket where training output is placed.</p>"
|
||
}
|
||
},
|
||
"S3KeyPrefix": {
|
||
"target": "com.amazonaws.rekognition#S3KeyPrefix",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The prefix applied to the training output files. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The S3 bucket and folder location where training output is placed.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PageSize": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 0,
|
||
"max": 4096
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PaginationToken": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 255
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Parent": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the parent label.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A parent label for a label. A label can have 0, 1, or more parents. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Parents": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Parent"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Percent": {
|
||
"type": "float",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 0,
|
||
"max": 100
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PersonDetail": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Index": {
|
||
"target": "com.amazonaws.rekognition#PersonIndex",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.</p>"
|
||
}
|
||
},
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Bounding box around the detected person.</p>"
|
||
}
|
||
},
|
||
"Face": {
|
||
"target": "com.amazonaws.rekognition#FaceDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Face details for the detected person.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details about a person detected in a video analysis request.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PersonDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The time, in milliseconds from the start of the video, that the person's path was tracked.</p>"
|
||
}
|
||
},
|
||
"Person": {
|
||
"target": "com.amazonaws.rekognition#PersonDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details about a person whose path was tracked in a video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details and path tracking information for a single time a person's path is tracked in a video.\n Amazon Rekognition operations that track people's paths return an array of <code>PersonDetection</code> objects\n with elements for each time a person's path is tracked in a video. </p>\n \n <p>For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PersonDetections": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#PersonDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PersonIndex": {
|
||
"type": "long"
|
||
},
|
||
"com.amazonaws.rekognition#PersonMatch": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The time, in milliseconds from the beginning of the video, that the person was matched in the video.</p>"
|
||
}
|
||
},
|
||
"Person": {
|
||
"target": "com.amazonaws.rekognition#PersonDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about the matched person.</p>"
|
||
}
|
||
},
|
||
"FaceMatches": {
|
||
"target": "com.amazonaws.rekognition#FaceMatchList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about the faces in the input collection that match the face of a person in the video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a person whose face matches a face(s) in an Amazon Rekognition collection.\n Includes information about the faces in the Amazon Rekognition collection (<a>FaceMatch</a>), information about the person (<a>PersonDetail</a>),\n and the time stamp for when the person was detected in a video. An array of\n <code>PersonMatch</code> objects is returned by <a>GetFaceSearch</a>. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PersonMatches": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#PersonMatch"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#PersonTrackingSortBy": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "INDEX",
|
||
"name": "INDEX"
|
||
},
|
||
{
|
||
"value": "TIMESTAMP",
|
||
"name": "TIMESTAMP"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Point": {
|
||
"type": "structure",
|
||
"members": {
|
||
"X": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>"
|
||
}
|
||
},
|
||
"Y": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The X and Y coordinates of a point on an image. The X and Y values returned are ratios\n of the overall image size. For example, if the input image is 700x200 and the \n operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.</p>\n \n <p>An array of <code>Point</code> objects,\n <code>Polygon</code>, is returned by <a>DetectText</a> and by <a>DetectCustomLabels</a>. <code>Polygon</code>\n represents a fine-grained polygon around a detected item. For more information, see Geometry in the\n Amazon Rekognition Developer Guide. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Polygon": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Point"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Pose": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Roll": {
|
||
"target": "com.amazonaws.rekognition#Degree",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Value representing the face rotation on the roll axis.</p>"
|
||
}
|
||
},
|
||
"Yaw": {
|
||
"target": "com.amazonaws.rekognition#Degree",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Value representing the face rotation on the yaw axis.</p>"
|
||
}
|
||
},
|
||
"Pitch": {
|
||
"target": "com.amazonaws.rekognition#Degree",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Value representing the face rotation on the pitch axis.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 20,
|
||
"max": 2048
|
||
},
|
||
"smithy.api#pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectDescription": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project.</p>"
|
||
}
|
||
},
|
||
"CreationTimestamp": {
|
||
"target": "com.amazonaws.rekognition#DateTime",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Unix timestamp for the date and time that the project was created.</p>"
|
||
}
|
||
},
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#ProjectStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the project.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A description of a Amazon Rekognition Custom Labels project.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectDescriptions": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ProjectDescription"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectName": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 255
|
||
},
|
||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectStatus": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "CREATING",
|
||
"name": "CREATING"
|
||
},
|
||
{
|
||
"value": "CREATED",
|
||
"name": "CREATED"
|
||
},
|
||
{
|
||
"value": "DELETING",
|
||
"name": "DELETING"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectVersionArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 20,
|
||
"max": 2048
|
||
},
|
||
"smithy.api#pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/version\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectVersionDescription": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the model version. </p>"
|
||
}
|
||
},
|
||
"CreationTimestamp": {
|
||
"target": "com.amazonaws.rekognition#DateTime",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Unix datetime for the date and time that training started.</p>"
|
||
}
|
||
},
|
||
"MinInferenceUnits": {
|
||
"target": "com.amazonaws.rekognition#InferenceUnits",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The minimum number of inference units used by the model. For more information,\n see <a>StartProjectVersion</a>.</p>"
|
||
}
|
||
},
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the model version.</p>"
|
||
}
|
||
},
|
||
"StatusMessage": {
|
||
"target": "com.amazonaws.rekognition#StatusMessage",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A descriptive message for an error or warning that occurred.</p>"
|
||
}
|
||
},
|
||
"BillableTrainingTimeInSeconds": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The duration, in seconds, that the model version has been billed for training. \n This value is only returned if the model version has been successfully trained.</p>"
|
||
}
|
||
},
|
||
"TrainingEndTimestamp": {
|
||
"target": "com.amazonaws.rekognition#DateTime",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Unix date and time that training of the model ended.</p>"
|
||
}
|
||
},
|
||
"OutputConfig": {
|
||
"target": "com.amazonaws.rekognition#OutputConfig",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The location where training results are saved.</p>"
|
||
}
|
||
},
|
||
"TrainingDataResult": {
|
||
"target": "com.amazonaws.rekognition#TrainingDataResult",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Contains information about the training results.</p>"
|
||
}
|
||
},
|
||
"TestingDataResult": {
|
||
"target": "com.amazonaws.rekognition#TestingDataResult",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Contains information about the testing results.</p>"
|
||
}
|
||
},
|
||
"EvaluationResult": {
|
||
"target": "com.amazonaws.rekognition#EvaluationResult",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The training results. <code>EvaluationResult</code> is only returned if training is successful.</p>"
|
||
}
|
||
},
|
||
"ManifestSummary": {
|
||
"target": "com.amazonaws.rekognition#GroundTruthManifest",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The location of the summary manifest. The summary manifest provides aggregate data validation results for the training\n and test datasets.</p>"
|
||
}
|
||
},
|
||
"KmsKeyId": {
|
||
"target": "com.amazonaws.rekognition#KmsKeyId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifer for the AWS Key Management Service (AWS KMS) customer master key that was used to encrypt the model during training. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The description of a version of a model.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectVersionDescriptions": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionDescription"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectVersionStatus": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "TRAINING_IN_PROGRESS",
|
||
"name": "TRAINING_IN_PROGRESS"
|
||
},
|
||
{
|
||
"value": "TRAINING_COMPLETED",
|
||
"name": "TRAINING_COMPLETED"
|
||
},
|
||
{
|
||
"value": "TRAINING_FAILED",
|
||
"name": "TRAINING_FAILED"
|
||
},
|
||
{
|
||
"value": "STARTING",
|
||
"name": "STARTING"
|
||
},
|
||
{
|
||
"value": "RUNNING",
|
||
"name": "RUNNING"
|
||
},
|
||
{
|
||
"value": "FAILED",
|
||
"name": "FAILED"
|
||
},
|
||
{
|
||
"value": "STOPPING",
|
||
"name": "STOPPING"
|
||
},
|
||
{
|
||
"value": "STOPPED",
|
||
"name": "STOPPED"
|
||
},
|
||
{
|
||
"value": "DELETING",
|
||
"name": "DELETING"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectVersionsPageSize": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 1,
|
||
"max": 100
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProjectsPageSize": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 1,
|
||
"max": 100
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentBodyPart": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#BodyPart",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The detected body part.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.\n </p>"
|
||
}
|
||
},
|
||
"EquipmentDetections": {
|
||
"target": "com.amazonaws.rekognition#EquipmentDetections",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of Personal Protective Equipment items detected around a body part.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a body part detected by <a>DetectProtectiveEquipment</a> that contains PPE.\n An array of <code>ProtectiveEquipmentBodyPart</code> objects is returned for each person detected by \n <code>DetectProtectiveEquipment</code>. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentPerson": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BodyParts": {
|
||
"target": "com.amazonaws.rekognition#BodyParts",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of body parts detected on a person's body (including body parts without PPE). </p>"
|
||
}
|
||
},
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A bounding box around the detected person.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition has that the bounding box contains a person.</p>"
|
||
}
|
||
},
|
||
"Id": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the detected person. The identifier is only unique for a single call to\n <code>DetectProtectiveEquipment</code>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A person detected by a call to <a>DetectProtectiveEquipment</a>. The API returns \n all persons detected in the input\n image in an array of <code>ProtectiveEquipmentPerson</code> objects.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentPersonIds": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#UInteger"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentPersons": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentPerson"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentSummarizationAttributes": {
|
||
"type": "structure",
|
||
"members": {
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The minimum confidence level for which you want summary information. \n The confidence level applies to person detection, body part detection, equipment detection, and body part coverage.\n Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a\n default value.</p>\n <p>Specify a <code>MinConfidence</code> value that is between 50-100% as <code>DetectProtectiveEquipment</code>\n returns predictions only where the detection confidence is between 50% - 100%. \n If you specify a value that is less than 50%, the results are the same specifying a value of 50%.</p>\n <p> \n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"RequiredEquipmentTypes": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentTypes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of personal protective equipment types for which you want summary information. \n If a person is detected wearing a required requipment type, the person's ID is added to the\n <code>PersonsWithRequiredEquipment</code> array field returned in <a>ProtectiveEquipmentSummary</a>\n by <code>DetectProtectiveEquipment</code>. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies summary attributes to return from a call to <a>DetectProtectiveEquipment</a>.\n You can specify which types of PPE to summarize. You can also specify a minimum confidence value for detections.\n Summary information is returned in the <code>Summary</code> (<a>ProtectiveEquipmentSummary</a>) field of the response from \n <code>DetectProtectiveEquipment</code>.\n The summary includes which persons in an image were detected wearing the requested types of person protective equipment (PPE), which persons\n were detected as not wearing PPE, and the persons in which a determination could not be made. For more information, \n see <a>ProtectiveEquipmentSummary</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentSummary": {
|
||
"type": "structure",
|
||
"members": {
|
||
"PersonsWithRequiredEquipment": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of IDs for persons who are wearing detected personal protective equipment.\n </p>"
|
||
}
|
||
},
|
||
"PersonsWithoutRequiredEquipment": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of IDs for persons who are not wearing all of the types of PPE specified in the <code>RequiredEquipmentTypes</code> field of\n the detected personal protective equipment.\n </p>"
|
||
}
|
||
},
|
||
"PersonsIndeterminate": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.\n </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Summary information for required items of personal protective equipment (PPE) detected on persons by a call\n to <a>DetectProtectiveEquipment</a>. You specify the required type of PPE in\n the <code>SummarizationAttributes</code>\n (<a>ProtectiveEquipmentSummarizationAttributes</a>) input parameter.\n The summary includes which persons were detected wearing the required personal protective equipment\n (<code>PersonsWithRequiredEquipment</code>),\n which persons were detected as not wearing the required PPE (<code>PersonsWithoutRequiredEquipment</code>), \n and the persons in which a determination\n could not be made (<code>PersonsIndeterminate</code>).</p>\n <p>To get a total for each category, use the size of the field array. For example, \n to find out how many people were detected as wearing the specified PPE,\n use the size of the <code>PersonsWithRequiredEquipment</code> array. \n If you want to find out more about a person, such as the \n location (<a>BoundingBox</a>) of the person on the image, use the person ID in each array element. \n Each person ID matches the ID field of a <a>ProtectiveEquipmentPerson</a> object returned\n in the <code>Persons</code> array by <code>DetectProtectiveEquipment</code>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentType": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "FACE_COVER",
|
||
"name": "FACE_COVER"
|
||
},
|
||
{
|
||
"value": "HAND_COVER",
|
||
"name": "HAND_COVER"
|
||
},
|
||
{
|
||
"value": "HEAD_COVER",
|
||
"name": "HEAD_COVER"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProtectiveEquipmentTypes": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#ProtectiveEquipmentType"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ProvisionedThroughputExceededException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The number of requests exceeded your throughput limit. If you want to increase this\n limit, contact Amazon Rekognition.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#QualityFilter": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "NONE",
|
||
"name": "NONE"
|
||
},
|
||
{
|
||
"value": "AUTO",
|
||
"name": "AUTO"
|
||
},
|
||
{
|
||
"value": "LOW",
|
||
"name": "LOW"
|
||
},
|
||
{
|
||
"value": "MEDIUM",
|
||
"name": "MEDIUM"
|
||
},
|
||
{
|
||
"value": "HIGH",
|
||
"name": "HIGH"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Reason": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "EXCEEDS_MAX_FACES",
|
||
"name": "EXCEEDS_MAX_FACES"
|
||
},
|
||
{
|
||
"value": "EXTREME_POSE",
|
||
"name": "EXTREME_POSE"
|
||
},
|
||
{
|
||
"value": "LOW_BRIGHTNESS",
|
||
"name": "LOW_BRIGHTNESS"
|
||
},
|
||
{
|
||
"value": "LOW_SHARPNESS",
|
||
"name": "LOW_SHARPNESS"
|
||
},
|
||
{
|
||
"value": "LOW_CONFIDENCE",
|
||
"name": "LOW_CONFIDENCE"
|
||
},
|
||
{
|
||
"value": "SMALL_BOUNDING_BOX",
|
||
"name": "SMALL_BOUNDING_BOX"
|
||
},
|
||
{
|
||
"value": "LOW_FACE_QUALITY",
|
||
"name": "LOW_FACE_QUALITY"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Reasons": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Reason"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RecognizeCelebrities": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#RecognizeCelebritiesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#RecognizeCelebritiesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities\n in the Amazon Rekognition Developer Guide. </p>\n <p>\n <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists\n recognized celebrities in the <code>CelebrityFaces</code> array and unrecognized faces in the\n <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.</p>\n\n <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a\n <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n <code>ComparedFace</code> object that you can use to locate the celebrity's face on the\n image.</p>\n <p>Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the <code>Celebrity</code> ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the\n ID to identify the celebrity in a call to the <a>GetCelebrityInfo</a>\n operation.</p>\n <p>You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file. </p>\n\n\n\n \n <p>For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.</p>\n <p>This operation requires permissions to perform the\n <code>rekognition:RecognizeCelebrities</code> operation.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RecognizeCelebritiesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RecognizeCelebritiesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CelebrityFaces": {
|
||
"target": "com.amazonaws.rekognition#CelebrityList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64\n celebrities in an image.</p>"
|
||
}
|
||
},
|
||
"UnrecognizedFaces": {
|
||
"target": "com.amazonaws.rekognition#ComparedFaceList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details about each unrecognized face in the image.</p>"
|
||
}
|
||
},
|
||
"OrientationCorrection": {
|
||
"target": "com.amazonaws.rekognition#OrientationCorrection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The orientation of the input image (counterclockwise direction). If your application\n displays the image, you can use this value to correct the orientation. The bounding box\n coordinates returned in <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code>\n represent face locations before the image orientation is corrected. </p>\n <note>\n <p>If the input image is in .jpeg format, it might contain exchangeable image (Exif)\n metadata that includes the image's orientation. If so, and the Exif metadata for the input\n image populates the orientation field, the value of <code>OrientationCorrection</code> is\n null. The <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code> bounding box\n coordinates represent face locations after Exif metadata is used to correct the image\n orientation. Images in .png format don't contain Exif metadata. </p>\n </note>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RegionOfInterest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"BoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The box representing a region of interest on screen.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies a location within the frame that Rekognition checks for text. Uses a <code>BoundingBox</code>\n object to set a region of the screen.</p>\n <p>A word is included in the region if the word is more than half in that region. If there is more than\n one region, the word will be compared with all regions of the screen. Any word more than half in a region\n is kept in the results.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RegionsOfInterest": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#RegionOfInterest"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 10
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RekognitionService": {
|
||
"type": "service",
|
||
"version": "2016-06-27",
|
||
"operations": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#CompareFaces"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#CreateCollection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#CreateProject"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#CreateProjectVersion"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#CreateStreamProcessor"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DeleteCollection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DeleteFaces"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DeleteProject"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DeleteProjectVersion"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DeleteStreamProcessor"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DescribeCollection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DescribeProjects"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DescribeProjectVersions"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DescribeStreamProcessor"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DetectCustomLabels"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DetectFaces"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DetectLabels"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DetectModerationLabels"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DetectProtectiveEquipment"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#DetectText"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetCelebrityInfo"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetCelebrityRecognition"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetContentModeration"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetFaceDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetFaceSearch"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetLabelDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetPersonTracking"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetSegmentDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#GetTextDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IndexFaces"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ListCollections"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ListFaces"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ListStreamProcessors"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ListTagsForResource"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#RecognizeCelebrities"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#SearchFaces"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#SearchFacesByImage"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartCelebrityRecognition"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartContentModeration"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartFaceDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartFaceSearch"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartLabelDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartPersonTracking"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartProjectVersion"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartSegmentDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartStreamProcessor"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StartTextDetection"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StopProjectVersion"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#StopStreamProcessor"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#TagResource"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#UntagResource"
|
||
}
|
||
],
|
||
"traits": {
|
||
"aws.api#service": {
|
||
"sdkId": "Rekognition",
|
||
"arnNamespace": "rekognition",
|
||
"cloudFormationName": "Rekognition",
|
||
"cloudTrailEventSource": "rekognition.amazonaws.com",
|
||
"endpointPrefix": "rekognition"
|
||
},
|
||
"aws.auth#sigv4": {
|
||
"name": "rekognition"
|
||
},
|
||
"aws.protocols#awsJson1_1": {},
|
||
"smithy.api#documentation": "<p>This is the Amazon Rekognition API reference.</p>",
|
||
"smithy.api#title": "Amazon Rekognition"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RekognitionUniqueId": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "[0-9A-Za-z]*"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ResourceAlreadyExistsException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A resource with the specified ID already exists.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ResourceArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 20,
|
||
"max": 2048
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ResourceInUseException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The specified resource is already being used.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ResourceNotFoundException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The resource specified in the request cannot be found.</p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ResourceNotReadyException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The requested resource isn't ready. For example, \n this exception occurs when you call <code>DetectCustomLabels</code> with a\n model version that isn't deployed. </p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#RoleArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#S3Bucket": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 3,
|
||
"max": 255
|
||
},
|
||
"smithy.api#pattern": "[0-9A-Za-z\\.\\-_]*"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#S3KeyPrefix": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 1024
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#S3Object": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Bucket": {
|
||
"target": "com.amazonaws.rekognition#S3Bucket",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Name of the S3 bucket.</p>"
|
||
}
|
||
},
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#S3ObjectName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>S3 object key name.</p>"
|
||
}
|
||
},
|
||
"Version": {
|
||
"target": "com.amazonaws.rekognition#S3ObjectVersion",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the bucket is versioning enabled, you can specify the object version. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Provides the S3 bucket name and object name.</p>\n <p>The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.</p>\n \n <p>For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition\n Developer Guide. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#S3ObjectName": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 1024
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#S3ObjectVersion": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 1024
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SNSTopicArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "(^arn:aws:sns:.*:\\w{12}:.+$)"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SearchFaces": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#SearchFacesRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#SearchFacesResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>For a given input face ID, searches for matching faces in the collection the face\n 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\n faces in the specified collection. </p>\n <note>\n <p>You can also search faces without indexing faces by using the\n <code>SearchFacesByImage</code> operation.</p>\n </note>\n\n <p>\n The operation response returns\n an array of faces that match, ordered by similarity score with the highest\n similarity first. More specifically, it is an\n array of metadata for each face match that is found. Along with the metadata, the response also\n includes a <code>confidence</code> value for each face match, indicating the confidence\n that the specific face matches the input face.\n </p>\n \n <p>For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.</p>\n\n <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>\n action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SearchFacesByImage": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#SearchFacesByImageRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#SearchFacesByImageResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ImageTooLargeException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidImageFormatException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection. </p>\n <note>\n <p>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\n calls to the <a>SearchFaces</a> operation. </p>\n <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n <code>SearchFacesByImage</code> operation. </p>\n </note>\n\n <p>You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file. </p>\n <p>\n The response returns an array of faces that match, ordered by similarity score with the\n highest similarity first. More specifically, it is an\n array of metadata for each face match found. Along with the metadata, the response also\n includes a <code>similarity</code> indicating how similar the face is\n to the input face.\n\n In the response, the operation also returns the bounding\n box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition\n used for the input image.\n </p>\n <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an \n <code>InvalidParameterException</code> error. </p>\n \n <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.</p>\n \n <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. \n Use <code>QualityFilter</code> to set the quality bar for \n filtering by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.\n If you do not want to filter detected faces, specify <code>NONE</code>. The default\n value is <code>NONE</code>.</p>\n <note>\n <p>To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n <a>DescribeCollection</a>. </p>\n </note>\n \n <p>This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code>\n action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SearchFacesByImageRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of the collection to search.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Image": {
|
||
"target": "com.amazonaws.rekognition#Image",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The input image as base64-encoded bytes or an S3 object.\n If you use the AWS CLI to call Amazon Rekognition operations,\n passing base64-encoded image bytes is not supported. </p>\n <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the <code>Bytes</code> field. \n For more information, see Images in the Amazon Rekognition developer guide.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxFaces": {
|
||
"target": "com.amazonaws.rekognition#MaxFaces",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of faces to return. The operation returns the maximum number of faces\n with the highest confidence in the match.</p>"
|
||
}
|
||
},
|
||
"FaceMatchThreshold": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>(Optional) Specifies the minimum confidence in the face match to return. For example,\n don't return any matches where confidence in matches is less than 70%.\n The default value is 80%.</p>"
|
||
}
|
||
},
|
||
"QualityFilter": {
|
||
"target": "com.amazonaws.rekognition#QualityFilter",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't searched for in the collection. If you specify <code>AUTO</code>, Amazon Rekognition \n chooses the quality bar. If you specify <code>LOW</code>, \n <code>MEDIUM</code>, or <code>HIGH</code>, filtering removes all faces that\n don’t meet the chosen quality bar. \n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify <code>NONE</code>, no\n filtering is performed. The default value is <code>NONE</code>.\n </p>\n <p>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SearchFacesByImageResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"SearchedFaceBoundingBox": {
|
||
"target": "com.amazonaws.rekognition#BoundingBox",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The bounding box around the face in the input image that Amazon Rekognition used for the\n search.</p>"
|
||
}
|
||
},
|
||
"SearchedFaceConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The level of confidence that the <code>searchedFaceBoundingBox</code>, contains a\n face.</p>"
|
||
}
|
||
},
|
||
"FaceMatches": {
|
||
"target": "com.amazonaws.rekognition#FaceMatchList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces that match the input face, along with the confidence in the\n match.</p>"
|
||
}
|
||
},
|
||
"FaceModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SearchFacesRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of the collection the face belongs to.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"FaceId": {
|
||
"target": "com.amazonaws.rekognition#FaceId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of a face to find matches for in the collection.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MaxFaces": {
|
||
"target": "com.amazonaws.rekognition#MaxFaces",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Maximum number of faces to return. The operation returns the maximum number of faces\n with the highest confidence in the match.</p>"
|
||
}
|
||
},
|
||
"FaceMatchThreshold": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Optional value specifying the minimum confidence in the face match to return. For\n example, don't return any matches where confidence in matches is less than 70%. \n The default value is 80%.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SearchFacesResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"SearchedFaceId": {
|
||
"target": "com.amazonaws.rekognition#FaceId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of the face that was searched for matches in a collection.</p>"
|
||
}
|
||
},
|
||
"FaceMatches": {
|
||
"target": "com.amazonaws.rekognition#FaceMatchList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of faces that matched the input face, along with the confidence in the\n match.</p>"
|
||
}
|
||
},
|
||
"FaceModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentConfidence": {
|
||
"type": "float",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 50,
|
||
"max": 100
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#SegmentType",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The type of the segment. Valid values are <code>TECHNICAL_CUE</code> and <code>SHOT</code>.</p>"
|
||
}
|
||
},
|
||
"StartTimestampMillis": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The start time of the detected segment in milliseconds from the start of the video. This value\n is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of\n 100 millis.</p>"
|
||
}
|
||
},
|
||
"EndTimestampMillis": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The end time of the detected segment, in milliseconds, from the start of the video.\n This value is rounded down.</p>"
|
||
}
|
||
},
|
||
"DurationMillis": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The duration of the detected segment in milliseconds. </p>"
|
||
}
|
||
},
|
||
"StartTimecodeSMPTE": {
|
||
"target": "com.amazonaws.rekognition#Timecode",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.\n <code>StartTimecode</code> is in <i>HH:MM:SS:fr</i> format\n (and <i>;fr</i> for drop frame-rates). </p>"
|
||
}
|
||
},
|
||
"EndTimecodeSMPTE": {
|
||
"target": "com.amazonaws.rekognition#Timecode",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. \n <code>EndTimecode</code> is in <i>HH:MM:SS:fr</i> format\n (and <i>;fr</i> for drop frame-rates).</p>"
|
||
}
|
||
},
|
||
"DurationSMPTE": {
|
||
"target": "com.amazonaws.rekognition#Timecode",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The duration of the timecode for the detected segment in SMPTE format.</p>"
|
||
}
|
||
},
|
||
"TechnicalCueSegment": {
|
||
"target": "com.amazonaws.rekognition#TechnicalCueSegment",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the segment is a technical cue, contains information about the technical cue.</p>"
|
||
}
|
||
},
|
||
"ShotSegment": {
|
||
"target": "com.amazonaws.rekognition#ShotSegment",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If the segment is a shot detection, contains information about the shot detection.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A technical cue or shot detection segment detected in a video. An array\n of <code>SegmentDetection</code> objects containing all segments detected in a stored video\n is returned by <a>GetSegmentDetection</a>.\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentDetections": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#SegmentDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentType": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "TECHNICAL_CUE",
|
||
"name": "TECHNICAL_CUE"
|
||
},
|
||
{
|
||
"value": "SHOT",
|
||
"name": "SHOT"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentTypeInfo": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#SegmentType",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The type of a segment (technical cue or shot detection).</p>"
|
||
}
|
||
},
|
||
"ModelVersion": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The version of the model used to detect segments.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about the type of a segment requested in a call to <a>StartSegmentDetection</a>.\n An array of <code>SegmentTypeInfo</code> objects is returned by the response from <a>GetSegmentDetection</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentTypes": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#SegmentType"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SegmentTypesInfo": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#SegmentTypeInfo"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ServiceQuotaExceededException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p></p>\n \n \n <p>The size of the collection exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ShotSegment": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Index": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An Identifier for a shot detection segment detected in a video. </p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#SegmentConfidence",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a shot detection segment detected in a video. For more information, \n see <a>SegmentDetection</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Smile": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the face is smiling or not.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face is smiling, and the confidence level in the\n determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartCelebrityRecognition": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartCelebrityRecognitionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartCelebrityRecognitionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts asynchronous recognition of celebrities in a stored video.</p>\n <p>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\n and the filename of the video.\n <code>StartCelebrityRecognition</code>\n returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>\n \n <p>For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.</p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartCelebrityRecognitionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The video in which you want to recognize celebrities. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n celebrity recognition analysis to.</p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartCelebrityRecognitionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the celebrity recognition analysis job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetCelebrityRecognition</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartContentModeration": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartContentModerationRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartContentModerationResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p> Starts asynchronous detection of unsafe content in a stored video.</p>\n <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name\n and the filename of the video. <code>StartContentModeration</code>\n returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.\n When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>\n <p>To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>\n \n <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartContentModerationRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The video in which you want to detect unsafe content. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence\n represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level\n lower than this specified value. If you don't specify <code>MinConfidence</code>, <code>GetContentModeration</code>\n returns labels with confidence values greater than or equal to 50 percent.</p>"
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartContentModeration</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n unsafe content analysis to.</p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartContentModerationResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the unsafe content analysis job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetContentModeration</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartFaceDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartFaceDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartFaceDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts asynchronous detection of faces in a stored video.</p>\n <p>Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use <a>Video</a> to specify the bucket name and the filename of the video.\n <code>StartFaceDetection</code> returns a job identifier (<code>JobId</code>) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>\n \n <p>For more information, see Detecting Faces in a Stored Video in the \n Amazon Rekognition Developer Guide.</p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartFaceDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The video in which you want to detect faces. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n face detection operation.</p>"
|
||
}
|
||
},
|
||
"FaceAttributes": {
|
||
"target": "com.amazonaws.rekognition#FaceAttributes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The face attributes you want returned.</p>\n <p>\n <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. </p>\n <p>\n <code>ALL</code> - All facial attributes are returned.</p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartFaceDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the face detection job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetFaceDetection</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartFaceSearch": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartFaceSearchRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartFaceSearchResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.</p>\n <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name\n and the filename of the video. <code>StartFaceSearch</code>\n returns a job identifier (<code>JobId</code>) which you use to get the search results once the search has completed.\n When searching is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see\n <a>procedure-person-search-videos</a>.</p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartFaceSearchRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The video you want to search. The video must be stored in an Amazon S3 bucket. </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"FaceMatchThreshold": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.\n The default value is 80%.</p>"
|
||
}
|
||
},
|
||
"CollectionId": {
|
||
"target": "com.amazonaws.rekognition#CollectionId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>ID of the collection that contains the faces you want to search for.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. </p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartFaceSearchResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the search job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetFaceSearch</code>. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartLabelDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartLabelDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartLabelDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts asynchronous detection of labels in a stored video.</p>\n <p>Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.\n This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities\n like a person getting out of a car or a person skiing.</p>\n\n <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name\n and the filename of the video.\n <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the\n results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>\n <p>To get the results of the label detection operation, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>\n <p></p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartLabelDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The video in which you want to detect labels. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartLabelDetection</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"MinConfidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence\n represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level\n lower than this specified value.</p>\n <p>If you don't specify <code>MinConfidence</code>, the operation returns labels with confidence\n values greater than or equal to 50 percent.</p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection\n operation to. </p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartLabelDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the label detection job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetLabelDetection</code>. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartPersonTracking": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartPersonTrackingRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartPersonTrackingResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts the asynchronous tracking of a person's path in a stored video.</p>\n <p>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\n and the filename of the video. <code>StartPersonTracking</code>\n returns a job identifier (<code>JobId</code>) which you use to get the results of the operation.\n When label detection is finished, Amazon Rekognition publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </p>\n <p>To get the results of the person detection operation, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartPersonTrackingRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The video in which you want to detect people. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartPersonTracking</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection\n operation to.</p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartPersonTrackingResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the person detection job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetPersonTracking</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartProjectVersion": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartProjectVersionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartProjectVersionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use <a>DescribeProjectVersions</a>.</p>\n <p>Once the model is running, you can detect custom labels in new images by calling \n <a>DetectCustomLabels</a>.</p>\n <note>\n <p>You are charged for the amount of time that the model is running. To stop a running\n model, call <a>StopProjectVersion</a>.</p>\n </note>\n <p>This operation requires permissions to perform the \n <code>rekognition:StartProjectVersion</code> action.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartProjectVersionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name(ARN) of the model version that you want to start.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"MinInferenceUnits": {
|
||
"target": "com.amazonaws.rekognition#InferenceUnits",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS).\n Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartProjectVersionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current running status of the model. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartSegmentDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartSegmentDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartSegmentDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts asynchronous detection of segment detection in a stored video.</p>\n <p>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 \n the filename of the video. <code>StartSegmentDetection</code> returns a job identifier (<code>JobId</code>) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in <code>NotificationChannel</code>.</p>\n <p>You can use the <code>Filters</code> (<a>StartSegmentDetectionFilters</a>) \n input parameter to specify the minimum detection confidence returned in the response. \n Within <code>Filters</code>, use <code>ShotFilter</code> (<a>StartShotDetectionFilter</a>)\n to filter detected shots. Use <code>TechnicalCueFilter</code> (<a>StartTechnicalCueDetectionFilter</a>)\n to filter technical cues. </p>\n <p>To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is <code>SUCCEEDED</code>. if so, call <a>GetSegmentDetection</a> and pass the job identifier (<code>JobId</code>) \n from the initial call to <code>StartSegmentDetection</code>. </p>\n\n \n <p>For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.</p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartSegmentDetectionFilters": {
|
||
"type": "structure",
|
||
"members": {
|
||
"TechnicalCueFilter": {
|
||
"target": "com.amazonaws.rekognition#StartTechnicalCueDetectionFilter",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters that are specific to technical cues.</p>"
|
||
}
|
||
},
|
||
"ShotFilter": {
|
||
"target": "com.amazonaws.rekognition#StartShotDetectionFilter",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters that are specific to shot detections.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters applied to the technical cue or shot detection segments. \n For more information, see <a>StartSegmentDetection</a>.\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartSegmentDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple\n <code>StartSegmentDetection</code> requests, the same <code>JobId</code> is returned. Use\n <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n segment detection operation.</p>"
|
||
}
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||
}
|
||
},
|
||
"Filters": {
|
||
"target": "com.amazonaws.rekognition#StartSegmentDetectionFilters",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters for technical cue or shot detection.</p>"
|
||
}
|
||
},
|
||
"SegmentTypes": {
|
||
"target": "com.amazonaws.rekognition#SegmentTypes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartSegmentDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Unique identifier for the segment detection job. The <code>JobId</code> is returned from <code>StartSegmentDetection</code>.\n </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartShotDetectionFilter": {
|
||
"type": "structure",
|
||
"members": {
|
||
"MinSegmentConfidence": {
|
||
"target": "com.amazonaws.rekognition#SegmentConfidence",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence\n represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level\n lower than this specified value.</p>\n <p>If you don't specify <code>MinSegmentConfidence</code>, the <code>GetSegmentDetection</code> returns \n segments with confidence values greater than or equal to 50 percent.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters for the shot detection segments returned by <code>GetSegmentDetection</code>. \n For more information, see <a>StartSegmentDetectionFilters</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartStreamProcessor": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartStreamProcessorRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartStreamProcessorResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.\n To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to\n <code>CreateStreamProcessor</code>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartStreamProcessorRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of the stream processor to start processing.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartStreamProcessorResponse": {
|
||
"type": "structure",
|
||
"members": {}
|
||
},
|
||
"com.amazonaws.rekognition#StartTechnicalCueDetectionFilter": {
|
||
"type": "structure",
|
||
"members": {
|
||
"MinSegmentConfidence": {
|
||
"target": "com.amazonaws.rekognition#SegmentConfidence",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence\n represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level\n lower than this specified value.</p>\n <p>If you don't specify <code>MinSegmentConfidence</code>, <code>GetSegmentDetection</code> returns \n segments with confidence values greater than or equal to 50 percent.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters for the technical segments returned by <a>GetSegmentDetection</a>. For more information,\n see <a>StartSegmentDetectionFilters</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartTextDetection": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StartTextDetectionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StartTextDetectionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#IdempotentParameterMismatchException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidS3ObjectException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#LimitExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#VideoTooLargeException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Starts asynchronous detection of text in a stored video.</p>\n <p>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 \n the filename of the video. <code>StartTextDetection</code> returns a job identifier (<code>JobId</code>) which you use to get \n the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in <code>NotificationChannel</code>.</p>\n <p>To get the results of the text detection operation, first check that the status value published to the Amazon SNS \n topic is <code>SUCCEEDED</code>. if so, call <a>GetTextDetection</a> and pass the job identifier (<code>JobId</code>) \n from the initial call to <code>StartTextDetection</code>. </p>",
|
||
"smithy.api#idempotent": {}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartTextDetectionFilters": {
|
||
"type": "structure",
|
||
"members": {
|
||
"WordFilter": {
|
||
"target": "com.amazonaws.rekognition#DetectionFilter",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filters focusing on qualities of the text, such as confidence or size.</p>"
|
||
}
|
||
},
|
||
"RegionsOfInterest": {
|
||
"target": "com.amazonaws.rekognition#RegionsOfInterest",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Filter focusing on a certain area of the frame. Uses a <code>BoundingBox</code> object to set the region\n of the screen.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Set of optional parameters that let you set the criteria text must meet to be included in your response. \n <code>WordFilter</code> looks at a word's height, width and minimum confidence. <code>RegionOfInterest</code>\n lets you set a specific region of the screen to look for text in.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartTextDetectionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Video": {
|
||
"target": "com.amazonaws.rekognition#Video",
|
||
"traits": {
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"ClientRequestToken": {
|
||
"target": "com.amazonaws.rekognition#ClientRequestToken",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartTextDetection</code>\n requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job \n from being accidentaly started more than once.</p>"
|
||
}
|
||
},
|
||
"NotificationChannel": {
|
||
"target": "com.amazonaws.rekognition#NotificationChannel"
|
||
},
|
||
"JobTag": {
|
||
"target": "com.amazonaws.rekognition#JobTag",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs\n and identify them in the completion notification.</p>"
|
||
}
|
||
},
|
||
"Filters": {
|
||
"target": "com.amazonaws.rekognition#StartTextDetectionFilters",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Optional parameters that let you set criteria the text must meet to be included in your response.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StartTextDetectionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"JobId": {
|
||
"target": "com.amazonaws.rekognition#JobId",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Identifier for the text detection job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetTextDetection</code>.</p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StatusMessage": {
|
||
"type": "string"
|
||
},
|
||
"com.amazonaws.rekognition#StopProjectVersion": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StopProjectVersionRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StopProjectVersionResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Stops a running model. The operation might take a while to complete. To\n check the current status, call <a>DescribeProjectVersions</a>. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StopProjectVersionRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ProjectVersionArn": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>\n <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StopProjectVersionResponse": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#ProjectVersionStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The current status of the stop operation. </p>"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StopStreamProcessor": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#StopStreamProcessorRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#StopStreamProcessorResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceInUseException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Stops a running stream processor that was created by <a>CreateStreamProcessor</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StopStreamProcessorRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The name of a stream processor created by <a>CreateStreamProcessor</a>.</p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StopStreamProcessorResponse": {
|
||
"type": "structure",
|
||
"members": {}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessor": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Name": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorName",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Name of the Amazon Rekognition stream processor. </p>"
|
||
}
|
||
},
|
||
"Status": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessorStatus",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Current status of the Amazon Rekognition stream processor.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to <a>CreateStreamProcessor</a>. The request\n parameters for <code>CreateStreamProcessor</code> describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.\n\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorArn": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:streamprocessor\\/.+$)"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorInput": {
|
||
"type": "structure",
|
||
"members": {
|
||
"KinesisVideoStream": {
|
||
"target": "com.amazonaws.rekognition#KinesisVideoStream",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Kinesis video stream input stream for the source streaming video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about the source streaming video. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#StreamProcessor"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorName": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 128
|
||
},
|
||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorOutput": {
|
||
"type": "structure",
|
||
"members": {
|
||
"KinesisDataStream": {
|
||
"target": "com.amazonaws.rekognition#KinesisDataStream",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more\n information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorSettings": {
|
||
"type": "structure",
|
||
"members": {
|
||
"FaceSearch": {
|
||
"target": "com.amazonaws.rekognition#FaceSearchSettings",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Face search settings to use on a streaming video. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#StreamProcessorStatus": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "STOPPED",
|
||
"name": "STOPPED"
|
||
},
|
||
{
|
||
"value": "STARTING",
|
||
"name": "STARTING"
|
||
},
|
||
{
|
||
"value": "RUNNING",
|
||
"name": "RUNNING"
|
||
},
|
||
{
|
||
"value": "FAILED",
|
||
"name": "FAILED"
|
||
},
|
||
{
|
||
"value": "STOPPING",
|
||
"name": "STOPPING"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#String": {
|
||
"type": "string"
|
||
},
|
||
"com.amazonaws.rekognition#Summary": {
|
||
"type": "structure",
|
||
"members": {
|
||
"S3Object": {
|
||
"target": "com.amazonaws.rekognition#S3Object"
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The S3 bucket that contains the training summary. The training summary includes\n aggregated evaluation metrics for the entire testing dataset and metrics for each \n individual label. </p>\n <p>You get the training summary S3 bucket location by calling <a>DescribeProjectVersions</a>.\n </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Sunglasses": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Value": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Boolean value that indicates whether the face is wearing sunglasses or not.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Level of confidence in the determination.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Indicates whether or not the face is wearing sunglasses, and the confidence level in\n the determination.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#SynthesizedJsonHumanLoopActivationConditionsEvaluationResults": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 10240
|
||
},
|
||
"smithy.api#mediaType": "application/json"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TagKey": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 128
|
||
},
|
||
"smithy.api#pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TagKeyList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#TagKey"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 200
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TagMap": {
|
||
"type": "map",
|
||
"key": {
|
||
"target": "com.amazonaws.rekognition#TagKey"
|
||
},
|
||
"value": {
|
||
"target": "com.amazonaws.rekognition#TagValue"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 200
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TagResource": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#TagResourceRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#TagResourceResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ServiceQuotaExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n 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>.\n </p>\n <p>This operation requires permissions to perform the\n <code>rekognition:TagResource</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TagResourceRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ResourceArn": {
|
||
"target": "com.amazonaws.rekognition#ResourceArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"Tags": {
|
||
"target": "com.amazonaws.rekognition#TagMap",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n The key-value tags to assign to the resource.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TagResourceResponse": {
|
||
"type": "structure",
|
||
"members": {}
|
||
},
|
||
"com.amazonaws.rekognition#TagValue": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 0,
|
||
"max": 256
|
||
},
|
||
"smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TechnicalCueSegment": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#TechnicalCueType",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The type of the technical cue.</p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#SegmentConfidence",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a technical cue segment. For more information, see <a>SegmentDetection</a>.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TechnicalCueType": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "ColorBars",
|
||
"name": "COLOR_BARS"
|
||
},
|
||
{
|
||
"value": "EndCredits",
|
||
"name": "END_CREDITS"
|
||
},
|
||
{
|
||
"value": "BlackFrames",
|
||
"name": "BLACK_FRAMES"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TestingData": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Assets": {
|
||
"target": "com.amazonaws.rekognition#Assets",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The assets used for testing.</p>"
|
||
}
|
||
},
|
||
"AutoCreate": {
|
||
"target": "com.amazonaws.rekognition#Boolean",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>If specified, Amazon Rekognition Custom Labels creates a testing dataset with an 80/20 split of the training dataset.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The dataset used for testing. Optionally, if <code>AutoCreate</code> is set, Amazon Rekognition Custom Labels creates a \n testing dataset using an 80/20 split of the training dataset.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TestingDataResult": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Input": {
|
||
"target": "com.amazonaws.rekognition#TestingData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The testing dataset that was supplied for training.</p>"
|
||
}
|
||
},
|
||
"Output": {
|
||
"target": "com.amazonaws.rekognition#TestingData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The subset of the dataset that was actually tested. Some images (assets) might not be tested due to \n file formatting and other issues. </p>"
|
||
}
|
||
},
|
||
"Validation": {
|
||
"target": "com.amazonaws.rekognition#ValidationData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TextDetection": {
|
||
"type": "structure",
|
||
"members": {
|
||
"DetectedText": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The word or line of text recognized by Amazon Rekognition. </p>"
|
||
}
|
||
},
|
||
"Type": {
|
||
"target": "com.amazonaws.rekognition#TextTypes",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The type of text that was detected.</p>"
|
||
}
|
||
},
|
||
"Id": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The identifier for the detected text. The identifier is only unique for a single call\n to <code>DetectText</code>. </p>"
|
||
}
|
||
},
|
||
"ParentId": {
|
||
"target": "com.amazonaws.rekognition#UInteger",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Parent identifier for the detected text identified by the value of <code>ID</code>.\n If the type of detected text is <code>LINE</code>, the value of <code>ParentId</code> is\n <code>Null</code>. </p>"
|
||
}
|
||
},
|
||
"Confidence": {
|
||
"target": "com.amazonaws.rekognition#Percent",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy\n of the geometry points around the detected text.</p>"
|
||
}
|
||
},
|
||
"Geometry": {
|
||
"target": "com.amazonaws.rekognition#Geometry",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The location of the detected text on the image. Includes an axis aligned coarse\n bounding box surrounding the text and a finer grain polygon for more accurate spatial\n information.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a word or line of text detected by <a>DetectText</a>.</p>\n <p>The <code>DetectedText</code> field contains the text that Amazon Rekognition detected in the\n image. </p>\n <p>Every word and line has an identifier (<code>Id</code>). Each word belongs to a line\n and has a parent identifier (<code>ParentId</code>) that identifies the line of text in which\n the word appears. The word <code>Id</code> is also an index for the word within a line of\n words. </p>\n \n <p>For more information, see Detecting Text in the Amazon Rekognition Developer Guide.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TextDetectionList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#TextDetection"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TextDetectionResult": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Timestamp": {
|
||
"target": "com.amazonaws.rekognition#Timestamp",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The time, in milliseconds from the start of the video, that the text was detected.</p>"
|
||
}
|
||
},
|
||
"TextDetection": {
|
||
"target": "com.amazonaws.rekognition#TextDetection",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Details about text detected in a video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about text detected in a video. Incudes the detected text, \n the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TextDetectionResults": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#TextDetectionResult"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TextTypes": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "LINE",
|
||
"name": "LINE"
|
||
},
|
||
{
|
||
"value": "WORD",
|
||
"name": "WORD"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ThrottlingException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>",
|
||
"smithy.api#error": "server"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Timecode": {
|
||
"type": "string"
|
||
},
|
||
"com.amazonaws.rekognition#Timestamp": {
|
||
"type": "long"
|
||
},
|
||
"com.amazonaws.rekognition#TrainingData": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Assets": {
|
||
"target": "com.amazonaws.rekognition#Assets",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A Sagemaker GroundTruth manifest file that contains the training images (assets).</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The dataset used for training.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#TrainingDataResult": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Input": {
|
||
"target": "com.amazonaws.rekognition#TrainingData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The training assets that you supplied for training.</p>"
|
||
}
|
||
},
|
||
"Output": {
|
||
"target": "com.amazonaws.rekognition#TrainingData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The images (assets) that were actually trained by Amazon Rekognition Custom Labels. </p>"
|
||
}
|
||
},
|
||
"Validation": {
|
||
"target": "com.amazonaws.rekognition#ValidationData",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#UInteger": {
|
||
"type": "integer",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 0
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ULong": {
|
||
"type": "long",
|
||
"traits": {
|
||
"smithy.api#box": {},
|
||
"smithy.api#range": {
|
||
"min": 0
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#UnindexedFace": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Reasons": {
|
||
"target": "com.amazonaws.rekognition#Reasons",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>An array of reasons that specify why a face wasn't indexed. </p>\n <ul>\n <li>\n <p>EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned\n too far away from the camera.</p>\n </li>\n <li>\n <p>EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the \n <code>MaxFaces</code> input parameter for <code>IndexFaces</code>.</p>\n </li>\n <li>\n <p>LOW_BRIGHTNESS - The image is too dark.</p>\n </li>\n <li>\n <p>LOW_SHARPNESS - The image is too blurry.</p>\n </li>\n <li>\n <p>LOW_CONFIDENCE - The face was detected with a low confidence.</p>\n </li>\n <li>\n <p>SMALL_BOUNDING_BOX - The bounding box around the face is too small.</p>\n </li>\n </ul>"
|
||
}
|
||
},
|
||
"FaceDetail": {
|
||
"target": "com.amazonaws.rekognition#FaceDetail",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The\n structure that contains attributes of a face that\n <code>IndexFaces</code>detected, but didn't index. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A face that <a>IndexFaces</a> detected, but didn't index. Use the\n <code>Reasons</code> response attribute to determine why a face wasn't indexed.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#UnindexedFaces": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#UnindexedFace"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#UntagResource": {
|
||
"type": "operation",
|
||
"input": {
|
||
"target": "com.amazonaws.rekognition#UntagResourceRequest"
|
||
},
|
||
"output": {
|
||
"target": "com.amazonaws.rekognition#UntagResourceResponse"
|
||
},
|
||
"errors": [
|
||
{
|
||
"target": "com.amazonaws.rekognition#AccessDeniedException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InternalServerError"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#InvalidParameterException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ResourceNotFoundException"
|
||
},
|
||
{
|
||
"target": "com.amazonaws.rekognition#ThrottlingException"
|
||
}
|
||
],
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.\n </p>\n <p>This operation requires permissions to perform the\n <code>rekognition:UntagResource</code> action. </p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#UntagResourceRequest": {
|
||
"type": "structure",
|
||
"members": {
|
||
"ResourceArn": {
|
||
"target": "com.amazonaws.rekognition#ResourceArn",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
},
|
||
"TagKeys": {
|
||
"target": "com.amazonaws.rekognition#TagKeyList",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>\n A list of the tags that you want to remove.\n </p>",
|
||
"smithy.api#required": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#UntagResourceResponse": {
|
||
"type": "structure",
|
||
"members": {}
|
||
},
|
||
"com.amazonaws.rekognition#Url": {
|
||
"type": "string"
|
||
},
|
||
"com.amazonaws.rekognition#Urls": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#Url"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#ValidationData": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Assets": {
|
||
"target": "com.amazonaws.rekognition#Assets",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The assets that comprise the validation data. </p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Contains the Amazon S3 bucket location of the validation data for a model training job. </p>\n \n <p>The validation data includes error information for individual \n JSON lines in the dataset. \n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide. </p>\n <p>You get the <code>ValidationData</code> object for the training dataset (<a>TrainingDataResult</a>)\n and the test dataset (<a>TestingDataResult</a>) by calling <a>DescribeProjectVersions</a>. </p>\n <p>The assets array contains a single <a>Asset</a> object. \n The <a>GroundTruthManifest</a> field of the Asset object contains the S3 bucket location of\n the validation data. \n</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#VersionName": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 255
|
||
},
|
||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#VersionNames": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#VersionName"
|
||
},
|
||
"traits": {
|
||
"smithy.api#length": {
|
||
"min": 1,
|
||
"max": 10
|
||
}
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#Video": {
|
||
"type": "structure",
|
||
"members": {
|
||
"S3Object": {
|
||
"target": "com.amazonaws.rekognition#S3Object",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The Amazon S3 bucket name and file name for the video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to\n specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#VideoJobStatus": {
|
||
"type": "string",
|
||
"traits": {
|
||
"smithy.api#enum": [
|
||
{
|
||
"value": "IN_PROGRESS",
|
||
"name": "IN_PROGRESS"
|
||
},
|
||
{
|
||
"value": "SUCCEEDED",
|
||
"name": "SUCCEEDED"
|
||
},
|
||
{
|
||
"value": "FAILED",
|
||
"name": "FAILED"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#VideoMetadata": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Codec": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Type of compression used in the analyzed video. </p>"
|
||
}
|
||
},
|
||
"DurationMillis": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Length of the video in milliseconds.</p>"
|
||
}
|
||
},
|
||
"Format": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Format of the analyzed video. Possible values are MP4, MOV and AVI. </p>"
|
||
}
|
||
},
|
||
"FrameRate": {
|
||
"target": "com.amazonaws.rekognition#Float",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Number of frames per second in the video.</p>"
|
||
}
|
||
},
|
||
"FrameHeight": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Vertical pixel dimension of the video.</p>"
|
||
}
|
||
},
|
||
"FrameWidth": {
|
||
"target": "com.amazonaws.rekognition#ULong",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Horizontal pixel dimension of the video.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code> is returned in\n every page of paginated responses from a Amazon Rekognition video operation.</p>"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#VideoMetadataList": {
|
||
"type": "list",
|
||
"member": {
|
||
"target": "com.amazonaws.rekognition#VideoMetadata"
|
||
}
|
||
},
|
||
"com.amazonaws.rekognition#VideoTooLargeException": {
|
||
"type": "structure",
|
||
"members": {
|
||
"Message": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Code": {
|
||
"target": "com.amazonaws.rekognition#String"
|
||
},
|
||
"Logref": {
|
||
"target": "com.amazonaws.rekognition#String",
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>A universally unique identifier (UUID) for the request.</p>"
|
||
}
|
||
}
|
||
},
|
||
"traits": {
|
||
"smithy.api#documentation": "<p>The file size or duration of the supplied media is too large. The maximum file size is 10GB.\n The maximum duration is 6 hours. </p>",
|
||
"smithy.api#error": "client"
|
||
}
|
||
}
|
||
}
|
||
}
|