vendor: update all dependencies

This commit is contained in:
Nick Craig-Wood 2017-07-23 08:51:42 +01:00
parent 0b6fba34a3
commit eb87cf6f12
2008 changed files with 352633 additions and 1004750 deletions

View file

@ -138,6 +138,23 @@
{"shape":"InvalidImageFormatException"}
]
},
"GetCelebrityInfo":{
"name":"GetCelebrityInfo",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCelebrityInfoRequest"},
"output":{"shape":"GetCelebrityInfoResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ThrottlingException"},
{"shape":"ProvisionedThroughputExceededException"},
{"shape":"ResourceNotFoundException"}
]
},
"IndexFaces":{
"name":"IndexFaces",
"http":{
@ -194,6 +211,26 @@
{"shape":"ResourceNotFoundException"}
]
},
"RecognizeCelebrities":{
"name":"RecognizeCelebrities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RecognizeCelebritiesRequest"},
"output":{"shape":"RecognizeCelebritiesResponse"},
"errors":[
{"shape":"InvalidS3ObjectException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidImageFormatException"},
{"shape":"ImageTooLargeException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ThrottlingException"},
{"shape":"ProvisionedThroughputExceededException"},
{"shape":"InvalidImageFormatException"}
]
},
"SearchFaces":{
"name":"SearchFaces",
"http":{
@ -274,6 +311,20 @@
"Top":{"shape":"Float"}
}
},
"Celebrity":{
"type":"structure",
"members":{
"Urls":{"shape":"Urls"},
"Name":{"shape":"String"},
"Id":{"shape":"RekognitionUniqueId"},
"Face":{"shape":"ComparedFace"},
"MatchConfidence":{"shape":"Percent"}
}
},
"CelebrityList":{
"type":"list",
"member":{"shape":"Celebrity"}
},
"CollectionId":{
"type":"string",
"max":255,
@ -311,16 +362,30 @@
"type":"structure",
"members":{
"SourceImageFace":{"shape":"ComparedSourceImageFace"},
"FaceMatches":{"shape":"CompareFacesMatchList"}
"FaceMatches":{"shape":"CompareFacesMatchList"},
"UnmatchedFaces":{"shape":"CompareFacesUnmatchList"},
"SourceImageOrientationCorrection":{"shape":"OrientationCorrection"},
"TargetImageOrientationCorrection":{"shape":"OrientationCorrection"}
}
},
"CompareFacesUnmatchList":{
"type":"list",
"member":{"shape":"ComparedFace"}
},
"ComparedFace":{
"type":"structure",
"members":{
"BoundingBox":{"shape":"BoundingBox"},
"Confidence":{"shape":"Percent"}
"Confidence":{"shape":"Percent"},
"Landmarks":{"shape":"Landmarks"},
"Pose":{"shape":"Pose"},
"Quality":{"shape":"ImageQuality"}
}
},
"ComparedFaceList":{
"type":"list",
"member":{"shape":"ComparedFace"}
},
"ComparedSourceImageFace":{
"type":"structure",
"members":{
@ -551,6 +616,20 @@
"FEMALE"
]
},
"GetCelebrityInfoRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{"shape":"RekognitionUniqueId"}
}
},
"GetCelebrityInfoResponse":{
"type":"structure",
"members":{
"Urls":{"shape":"Urls"},
"Name":{"shape":"String"}
}
},
"Image":{
"type":"structure",
"members":{
@ -782,6 +861,25 @@
},
"exception":true
},
"RecognizeCelebritiesRequest":{
"type":"structure",
"required":["Image"],
"members":{
"Image":{"shape":"Image"}
}
},
"RecognizeCelebritiesResponse":{
"type":"structure",
"members":{
"CelebrityFaces":{"shape":"CelebrityList"},
"UnrecognizedFaces":{"shape":"ComparedFaceList"},
"OrientationCorrection":{"shape":"OrientationCorrection"}
}
},
"RekognitionUniqueId":{
"type":"string",
"pattern":"[0-9A-Za-z]*"
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
@ -884,6 +982,11 @@
"UInteger":{
"type":"integer",
"min":0
},
"Url":{"type":"string"},
"Urls":{
"type":"list",
"member":{"shape":"Url"}
}
}
}

View file

@ -2,16 +2,18 @@
"version": "2.0",
"service": "<p>This is the Amazon Rekognition API reference.</p>",
"operations": {
"CompareFaces": "<p>Compares a face in the <i>source</i> input image with each face detected in the <i>target</i> input image. </p> <note> <p> If the source image contains multiple faces, the service detects the largest face and uses it to compare with each face detected in the target image. </p> </note> <p>In response, the operation returns an array of face matches ordered by similarity score with the highest similarity scores first. For each face match, the response provides a bounding box of the face and <code>confidence</code> value (indicating the level of confidence that the bounding box contains a face). The response also provides a <code>similarity</code> score, which indicates how closely the faces match. </p> <note> <p>By default, only faces with the similarity score of greater than or equal to 80% are returned in the response. You can change this value.</p> </note> <p>In addition to the face matches, the response returns information about the face in the source image, including the bounding box of the face and confidence value.</p> <note> <p> This is a stateless API operation. That is, the operation does not persist any data.</p> </note> <p>For an example, see <a>get-started-exercise-compare-faces</a> </p> <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code> action.</p>",
"CreateCollection": "<p>Creates a collection in an AWS Region. You can add faces to the collection using the operation. </p> <p>For example, you might create collections, one for each of your application users. A user can then index faces using the <code>IndexFaces</code> operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. </p> <p>For an example, see <a>example1</a>. </p> <p>This operation requires permissions to perform the <code>rekognition:CreateCollection</code> action.</p>",
"CompareFaces": "<p>Compares a face in the <i>source</i> input image with each face detected in the <i>target</i> input image. </p> <note> <p> If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. </p> </note> <p>In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. </p> <note> <p>By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the <code>SimilarityThreshold</code> parameter.</p> </note> <p> <code>CompareFaces</code> also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.</p> <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.</p> <note> <p> This is a stateless API operation. That is, data returned by this operation doesn't persist.</p> </note> <p>For an example, see <a>get-started-exercise-compare-faces</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code> action.</p>",
"CreateCollection": "<p>Creates a collection in an AWS Region. You can add faces to the collection using the operation. </p> <p>For example, you might create collections, one for each of your application users. A user can then index faces using the <code>IndexFaces</code> operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. </p> <note> <p>Collection names are case-sensitive.</p> </note> <p>For an example, see <a>example1</a>. </p> <p>This operation requires permissions to perform the <code>rekognition:CreateCollection</code> action.</p>",
"DeleteCollection": "<p>Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see <a>example1</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:DeleteCollection</code> action.</p>",
"DeleteFaces": "<p>Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.</p> <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code> action.</p>",
"DetectFaces": "<p>Detects faces within an image (JPEG or PNG) that is provided as input.</p> <p> For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc. </p> <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence. </p> <note> <p>This is a stateless API operation. That is, the operation does not persist any data.</p> </note> <p>For an example, see <a>get-started-exercise-detect-faces</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code> action. </p>",
"DetectLabels": "<p>Detects instances of real-world labels within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see <a>get-started-exercise-detect-labels</a>.</p> <p> For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object. </p> <p> <code>{Name: lighthouse, Confidence: 98.4629}</code> </p> <p> <code>{Name: rock,Confidence: 79.2097}</code> </p> <p> <code> {Name: sea,Confidence: 75.061}</code> </p> <p> In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. </p> <p> <code>{Name: flower,Confidence: 99.0562}</code> </p> <p> <code>{Name: plant,Confidence: 99.0562}</code> </p> <p> <code>{Name: tulip,Confidence: 99.0562}</code> </p> <p>In this example, the detection algorithm more precisely identifies the flower as a tulip.</p> <p>You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to control the confidence threshold for the labels returned. The default is 50%. You can also add the <code>MaxLabels</code> parameter to limit the number of labels returned. </p> <note> <p>If the object detected is a person, the operation doesn't provide the same facial details that the <a>DetectFaces</a> operation provides.</p> </note> <p>This is a stateless API operation. That is, the operation does not persist any data.</p> <p>This operation requires permissions to perform the <code>rekognition:DetectLabels</code> action. </p>",
"DetectModerationLabels": "<p>Detects explicit or suggestive adult content in a specified .jpeg or .png image. Use <code>DetectModerationLabels</code> to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.</p> <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to determine which types of content are appropriate. For information about moderation labels, see <a>howitworks-moderateimage</a>.</p>",
"IndexFaces": "<p>Detects faces in the input image and adds them to the specified collection. </p> <p> Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations. </p> <p>If you provide the optional <code>externalImageID</code> for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. </p> <p>In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image If you request all facial attributes (using the <code>detectionAttributes</code> parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata. </p> <p>For an example, see <a>example2</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:IndexFaces</code> action.</p>",
"DetectModerationLabels": "<p>Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use <code>DetectModerationLabels</code> to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.</p> <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to determine which types of content are appropriate. For information about moderation labels, see <a>image-moderation</a>.</p>",
"GetCelebrityInfo": "<p>Gets the name and additional information about a celebrity based on his or her Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see <a>celebrity-recognition</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:GetCelebrityInfo</code> action. </p>",
"IndexFaces": "<p>Detects faces in the input image and adds them to the specified collection. </p> <p> Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations. </p> <p>If you provide the optional <code>externalImageID</code> for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. </p> <p>In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the <code>detectionAttributes</code> parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata. </p> <p>For an example, see <a>example2</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:IndexFaces</code> action.</p>",
"ListCollections": "<p>Returns list of collection IDs in your account. If the result is truncated, the response also provides a <code>NextToken</code> that you can use in the subsequent request to fetch the next set of collection IDs.</p> <p>For an example, see <a>example1</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:ListCollections</code> action.</p>",
"ListFaces": "<p>Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see <a>example3</a>. </p> <p>This operation requires permissions to perform the <code>rekognition:ListFaces</code> action.</p>",
"RecognizeCelebrities": "<p>Returns an array of celebrities recognized in the input image. The image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPEG formatted file. For more information, see <a>celebrity-recognition</a>. </p> <p> <code>RecognizeCelebrities</code> returns the 15 largest faces in the image. It lists recognized celebrities in the <code>CelebrityFaces</code> list and unrecognized faces in the <code>UnrecognizedFaces</code> list. The operation doesn't return celebrities whose face sizes are smaller than the largest 15 faces in the image.</p> <p>For each celebrity recognized, the API returns a <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity name, ID, URL links to additional information, match confidence, and a <code>ComparedFace</code> object that you can use to locate the celebrity's face on the image.</p> <p>Rekognition does not retain information about which images a celebrity has been recognized in. Your application must store this information and use the <code>Celebrity</code> ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the ID to identify the celebrity in a call to the operation.</p> <p>For an example, see <a>recognize-celebrities-tutorial</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:RecognizeCelebrities</code> operation.</p>",
"SearchFaces": "<p>For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with faces in the specified collection. </p> <note> <p>You can also search faces without indexing faces by using the <code>SearchFacesByImage</code> operation.</p> </note> <p> The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a <code>confidence</code> value for each face match, indicating the confidence that the specific face matches the input face. </p> <p>For an example, see <a>example3</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code> action.</p>",
"SearchFacesByImage": "<p>For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. </p> <note> <p> To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation. </p> <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes in the response to make face crops, which then you can pass in to the <code>SearchFacesByImage</code> operation. </p> </note> <p> The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a <code>similarity</code> indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. </p> <p>For an example, see <a>example3</a>.</p> <p>This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code> action.</p>"
},
@ -36,8 +38,8 @@
"Attributes": {
"base": null,
"refs": {
"DetectFacesRequest$Attributes": "<p>A list of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>[\"DEFAULT\"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>[\"ALL\"]</code>, all facial attributes are returned but the operation will take longer to complete.</p> <p>If you provide both, <code>[\"ALL\", \"DEFAULT\"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </p>",
"IndexFacesRequest$DetectionAttributes": "<p>A list of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>[\"DEFAULT\"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>[\"ALL\"]</code>, all facial attributes are returned but the operation will take longer to complete.</p> <p>If you provide both, <code>[\"ALL\", \"DEFAULT\"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </p>"
"DetectFacesRequest$Attributes": "<p>An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>[\"DEFAULT\"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>[\"ALL\"]</code>, all facial attributes are returned but the operation will take longer to complete.</p> <p>If you provide both, <code>[\"ALL\", \"DEFAULT\"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </p>",
"IndexFacesRequest$DetectionAttributes": "<p>An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>[\"DEFAULT\"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>[\"ALL\"]</code>, all facial attributes are returned but the operation will take longer to complete.</p> <p>If you provide both, <code>[\"ALL\", \"DEFAULT\"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </p>"
}
},
"Beard": {
@ -61,13 +63,25 @@
"BoundingBox": {
"base": "<p>Identifies the bounding box around the object or face. The <code>left</code> (x-coordinate) and <code>top</code> (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). </p> <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700) and a <code>top</code> value of 0.25 (50/200).</p> <p> The <code>width</code> and <code>height</code> values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. </p> <note> <p> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the <code>left</code> or <code>top</code> values. </p> </note>",
"refs": {
"ComparedFace$BoundingBox": null,
"ComparedSourceImageFace$BoundingBox": null,
"Face$BoundingBox": null,
"ComparedFace$BoundingBox": "<p>Bounding box of the face.</p>",
"ComparedSourceImageFace$BoundingBox": "<p>Bounding box of the face.</p>",
"Face$BoundingBox": "<p>Bounding box of the face.</p>",
"FaceDetail$BoundingBox": "<p>Bounding box of the face.</p>",
"SearchFacesByImageResponse$SearchedFaceBoundingBox": "<p>The bounding box around the face in the input image that Amazon Rekognition used for the search.</p>"
}
},
"Celebrity": {
"base": "<p>Provides information about a celebrity recognized by the operation.</p>",
"refs": {
"CelebrityList$member": null
}
},
"CelebrityList": {
"base": null,
"refs": {
"RecognizeCelebritiesResponse$CelebrityFaces": "<p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.</p>"
}
},
"CollectionId": {
"base": null,
"refs": {
@ -88,7 +102,7 @@
}
},
"CompareFacesMatch": {
"base": "<p>For the provided the bounding box, confidence level that the bounding box actually contains a face, and the similarity between the face in the bounding box and the face in the source image.</p>",
"base": "<p>Provides information about a face in a target image that matches the source image face analysed by <code>CompareFaces</code>. The <code>Face</code> property contains the bounding box of the face in the target image. The <code>Similarity</code> property is the confidence that the source image face matches the face in the bounding box.</p>",
"refs": {
"CompareFacesMatchList$member": null
}
@ -96,7 +110,7 @@
"CompareFacesMatchList": {
"base": null,
"refs": {
"CompareFacesResponse$FaceMatches": "<p>Provides an array of <code>CompareFacesMatch</code> objects. Each object provides the bounding box, confidence that the bounding box contains a face, and the similarity between the face in the bounding box and the face in the source image.</p>"
"CompareFacesResponse$FaceMatches": "<p>An array of faces in the target image that match the source image face. Each <code>CompareFacesMatch</code> object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.</p>"
}
},
"CompareFacesRequest": {
@ -109,16 +123,31 @@
"refs": {
}
},
"ComparedFace": {
"base": "<p>Provides face metadata (bounding box and confidence that the bounding box actually contains a face).</p>",
"CompareFacesUnmatchList": {
"base": null,
"refs": {
"CompareFacesMatch$Face": "<p>Provides face metadata (bounding box and confidence that the bounding box actually contains a face).</p>"
"CompareFacesResponse$UnmatchedFaces": "<p>An array of faces in the target image that did not match the source image face.</p>"
}
},
"ComparedFace": {
"base": "<p>Provides face metadata for target image faces that are analysed by <code>CompareFaces</code> and <code>RecognizeCelebrities</code>.</p>",
"refs": {
"Celebrity$Face": "<p>Provides information about the celebrity's face, such as its location on the image.</p>",
"CompareFacesMatch$Face": "<p>Provides face metadata (bounding box and confidence that the bounding box actually contains a face).</p>",
"CompareFacesUnmatchList$member": null,
"ComparedFaceList$member": null
}
},
"ComparedFaceList": {
"base": null,
"refs": {
"RecognizeCelebritiesResponse$UnrecognizedFaces": "<p>Details about each unrecognized face in the image.</p>"
}
},
"ComparedSourceImageFace": {
"base": "<p>Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison. </p>",
"refs": {
"CompareFacesResponse$SourceImageFace": "<p>The face from the source image that was used for comparison.</p>"
"CompareFacesResponse$SourceImageFace": "<p>The face in the source image that was used for comparison.</p>"
}
},
"CreateCollectionRequest": {
@ -227,18 +256,18 @@
}
},
"Face": {
"base": "<p>Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned. </p>",
"base": "<p>Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. </p>",
"refs": {
"FaceList$member": null,
"FaceMatch$Face": null,
"FaceRecord$Face": null
"FaceMatch$Face": "<p>Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.</p>",
"FaceRecord$Face": "<p>Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. </p>"
}
},
"FaceDetail": {
"base": "<p>Structure containing attributes of the face that the algorithm detected.</p>",
"refs": {
"FaceDetailList$member": null,
"FaceRecord$FaceDetail": null
"FaceRecord$FaceDetail": "<p>Structure containing attributes of the face that the algorithm detected.</p>"
}
},
"FaceDetailList": {
@ -319,16 +348,27 @@
"Gender$Value": "<p>Gender of the face.</p>"
}
},
"Image": {
"base": "<p>Provides the source image either as bytes or an S3 object.</p> <p>The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.</p> <p>You may need to Base64-encode the image bytes depending on the language you are using and whether or not you are using the AWS SDK. For more information, see <a>example4</a>.</p> <p>If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.</p> <p>For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see <a>manage-access-resource-policies</a>. </p>",
"GetCelebrityInfoRequest": {
"base": null,
"refs": {
"CompareFacesRequest$SourceImage": "<p>Source image either as bytes or an S3 object</p>",
"CompareFacesRequest$TargetImage": "<p>Target image either as bytes or an S3 object</p>",
}
},
"GetCelebrityInfoResponse": {
"base": null,
"refs": {
}
},
"Image": {
"base": "<p>Provides the input image either as bytes or an S3 object.</p> <p>You pass image bytes to a Rekognition API operation by using the <code>Bytes</code> property. For example, you would use the <code>Bytes</code> property to pass an image loaded from a local file system. Image bytes passed by using the <code>Bytes</code> property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Rekognition API operations. For more information, see <a>example4</a>.</p> <p> You pass images stored in an S3 bucket to a Rekognition API operation by using the <code>S3Object</code> property. Images stored in an S3 bucket do not need to be base64-encoded.</p> <p>The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.</p> <p>If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.</p> <p>For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see <a>manage-access-resource-policies</a>. </p>",
"refs": {
"CompareFacesRequest$SourceImage": "<p>The source image, either as bytes or as an S3 object.</p>",
"CompareFacesRequest$TargetImage": "<p>The target image, either as bytes or as an S3 object.</p>",
"DetectFacesRequest$Image": "<p>The image in which you want to detect faces. You can specify a blob or an S3 object. </p>",
"DetectLabelsRequest$Image": "<p>The input image. You can provide a blob of image bytes or an S3 object.</p>",
"DetectModerationLabelsRequest$Image": null,
"IndexFacesRequest$Image": null,
"SearchFacesByImageRequest$Image": null
"DetectModerationLabelsRequest$Image": "<p>The input image as bytes or an S3 object.</p>",
"IndexFacesRequest$Image": "<p>The input image as bytes or an S3 object.</p>",
"RecognizeCelebritiesRequest$Image": "<p>The input image to use for celebrity recognition.</p>",
"SearchFacesByImageRequest$Image": "<p>The input image as bytes or an S3 object.</p>"
}
},
"ImageBlob": {
@ -340,12 +380,13 @@
"ImageId": {
"base": null,
"refs": {
"Face$ImageId": "<p>Unique identifier that Amazon Rekognition assigns to the source image.</p>"
"Face$ImageId": "<p>Unique identifier that Amazon Rekognition assigns to the input image.</p>"
}
},
"ImageQuality": {
"base": "<p>Identifies face image brightness and sharpness. </p>",
"refs": {
"ComparedFace$Quality": "<p>Identifies face image brightness and sharpness. </p>",
"FaceDetail$Quality": "<p>Identifies image brightness and sharpness.</p>"
}
},
@ -416,7 +457,8 @@
"Landmarks": {
"base": null,
"refs": {
"FaceDetail$Landmarks": "<p>Indicates the location of the landmark on the face.</p>"
"ComparedFace$Landmarks": "<p>An array of facial landmarks.</p>",
"FaceDetail$Landmarks": "<p>Indicates the location of landmarks on the face.</p>"
}
},
"ListCollectionsRequest": {
@ -447,7 +489,7 @@
}
},
"ModerationLabel": {
"base": "<p>Provides information about a single type of moderated content found in an image. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see <a>howitworks-moderateimage</a>.</p>",
"base": "<p>Provides information about a single type of moderated content found in an image. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see <a>image-moderation</a>.</p>",
"refs": {
"ModerationLabels$member": null
}
@ -455,7 +497,7 @@
"ModerationLabels": {
"base": null,
"refs": {
"DetectModerationLabelsResponse$ModerationLabels": "<p>A list of labels for explicit or suggestive adult content found in the image. The list includes the top-level label and each child label detected in the image. This is useful for filtering specific categories of content. </p>"
"DetectModerationLabelsResponse$ModerationLabels": "<p>An array of labels for explicit or suggestive adult content found in the image. The list includes the top-level label and each child label detected in the image. This is useful for filtering specific categories of content. </p>"
}
},
"MouthOpen": {
@ -473,9 +515,12 @@
"OrientationCorrection": {
"base": null,
"refs": {
"DetectFacesResponse$OrientationCorrection": "<p>The algorithm detects the image orientation. If it detects that the image was rotated, it returns the degrees of rotation. If your application is displaying the image, you can use this value to adjust the orientation. </p> <p>For example, if the service detects that the input image was rotated by 90 degrees, it corrects orientation, performs face detection, and then returns the faces. That is, the bounding box coordinates in the response are based on the corrected orientation. </p> <note> <p>If the source image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be nil.</p> </note>",
"DetectLabelsResponse$OrientationCorrection": "<p> Amazon Rekognition returns the orientation of the input image that was detected (clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels. </p> <note> <p>If the source image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be nil.</p> </note>",
"IndexFacesResponse$OrientationCorrection": "<p>The algorithm detects the image orientation. If it detects that the image was rotated, it returns the degree of rotation. You can use this value to correct the orientation and also appropriately analyze the bounding box coordinates that are returned. </p> <note> <p>If the source image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be nil.</p> </note>"
"CompareFacesResponse$SourceImageOrientationCorrection": "<p> The orientation of the source image (counterclockwise direction). If your application displays the source image, you can use this value to correct image orientation. The bounding box coordinates returned in <code>SourceImageFace</code> represent the location of the face before the image orientation is corrected. </p> <note> <p>If the source image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If the Exif metadata for the source image populates the orientation field, the value of <code>OrientationCorrection</code> is null and the <code>SourceImageFace</code> bounding box coordinates represent the location of the face after Exif metadata is used to correct the orientation. Images in .png format don't contain Exif metadata.</p> </note>",
"CompareFacesResponse$TargetImageOrientationCorrection": "<p> The orientation of the target image (in counterclockwise direction). If your application displays the target image, you can use this value to correct the orientation of the image. The bounding box coordinates returned in <code>FaceMatches</code> and <code>UnmatchedFaces</code> represent face locations before the image orientation is corrected. </p> <note> <p>If the target image is in .jpg format, it might contain Exif metadata that includes the orientation of the image. If the Exif metadata for the target image populates the orientation field, the value of <code>OrientationCorrection</code> is null and the bounding box coordinates in <code>FaceMatches</code> and <code>UnmatchedFaces</code> represent the location of the face after Exif metadata is used to correct the orientation. Images in .png format don't contain Exif metadata.</p> </note>",
"DetectFacesResponse$OrientationCorrection": "<p> The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in <code>FaceDetails</code> represent face locations before the image orientation is corrected. </p> <note> <p>If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of <code>OrientationCorrection</code> is null and the <code>FaceDetails</code> bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.</p> </note>",
"DetectLabelsResponse$OrientationCorrection": "<p> The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels. </p> <note> <p>If the input image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be null.</p> </note>",
"IndexFacesResponse$OrientationCorrection": "<p>The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in <code>FaceRecords</code> represent face locations before the image orientation is corrected. </p> <note> <p>If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of <code>OrientationCorrection</code> is null and the bounding box coordinates in <code>FaceRecords</code> represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.</p> </note>",
"RecognizeCelebritiesResponse$OrientationCorrection": "<p>The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code> represent face locations before the image orientation is corrected. </p> <note> <p>If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of <code>OrientationCorrection</code> is null and the <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code> bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. </p> </note>"
}
},
"PageSize": {
@ -497,8 +542,9 @@
"base": null,
"refs": {
"Beard$Confidence": "<p>Level of confidence in the determination.</p>",
"Celebrity$MatchConfidence": "<p>The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.</p>",
"CompareFacesMatch$Similarity": "<p>Level of confidence that the faces match.</p>",
"CompareFacesRequest$SimilarityThreshold": "<p>The minimum level of confidence in the match you want included in the result.</p>",
"CompareFacesRequest$SimilarityThreshold": "<p>The minimum level of confidence in the face matches that a match must meet to be included in the <code>FaceMatches</code> array.</p>",
"ComparedFace$Confidence": "<p>Level of confidence that what the bounding box contains is a face.</p>",
"ComparedSourceImageFace$Confidence": "<p>Confidence level that the selected bounding box contains a face.</p>",
"DetectLabelsRequest$MinConfidence": "<p>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.</p> <p>If <code>MinConfidence</code> is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.</p>",
@ -522,9 +568,10 @@
}
},
"Pose": {
"base": "<p>Indicates the pose of the face as determined by pitch, roll, and the yaw.</p>",
"base": "<p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>",
"refs": {
"FaceDetail$Pose": "<p>Indicates the pose of the face as determined by pitch, roll, and the yaw.</p>"
"ComparedFace$Pose": "<p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>",
"FaceDetail$Pose": "<p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>"
}
},
"ProvisionedThroughputExceededException": {
@ -532,6 +579,23 @@
"refs": {
}
},
"RecognizeCelebritiesRequest": {
"base": null,
"refs": {
}
},
"RecognizeCelebritiesResponse": {
"base": null,
"refs": {
}
},
"RekognitionUniqueId": {
"base": null,
"refs": {
"Celebrity$Id": "<p>A unique identifier for the celebrity. </p>",
"GetCelebrityInfoRequest$Id": "<p>The ID for the celebrity. You get the celebrity ID from a call to the operation, which recognizes celebrities in an image. </p>"
}
},
"ResourceAlreadyExistsException": {
"base": "<p>A collection with the specified ID already exists.</p>",
"refs": {
@ -595,7 +659,9 @@
"String": {
"base": null,
"refs": {
"Celebrity$Name": "<p>The name of the celebrity.</p>",
"CreateCollectionResponse$CollectionArn": "<p>Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources. </p>",
"GetCelebrityInfoResponse$Name": "<p>The name of the celebrity.</p>",
"Label$Name": "<p>The name (label) of the object.</p>",
"ListFacesResponse$NextToken": "<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>",
"ModerationLabel$Name": "<p>The label name for the type of content detected in the image.</p>",
@ -622,6 +688,19 @@
"DeleteCollectionResponse$StatusCode": "<p>HTTP status code that indicates the result of the operation.</p>",
"DetectLabelsRequest$MaxLabels": "<p>Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. </p>"
}
},
"Url": {
"base": null,
"refs": {
"Urls$member": null
}
},
"Urls": {
"base": null,
"refs": {
"Celebrity$Urls": "<p>An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.</p>",
"GetCelebrityInfoResponse$Urls": "<p>An array of URLs pointing to additional celebrity information. </p>"
}
}
}
}