Skip to content

Commit daf640b

Browse files
author
awstools
committed
feat(client-rekognition): This release adds ContentType and TaxonomyLevel attributes to DetectModerationLabels and GetMediaAnalysisJob API responses.
1 parent a54f8c4 commit daf640b

13 files changed

+265
-50
lines changed

‎clients/client-rekognition/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,11 @@ parameters, and common errors.</p>
9191
</li>
9292
<li>
9393
<p>
94+
<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html">GetMediaAnalysisJob</a>
95+
</p>
96+
</li>
97+
<li>
98+
<p>
9499
<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a>
95100
</p>
96101
</li>
@@ -101,6 +106,11 @@ parameters, and common errors.</p>
101106
</li>
102107
<li>
103108
<p>
109+
<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html">ListMediaAnalysisJob</a>
110+
</p>
111+
</li>
112+
<li>
113+
<p>
104114
<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a>
105115
</p>
106116
</li>
@@ -134,6 +144,11 @@ parameters, and common errors.</p>
134144
<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html">SearchUsersByImage</a>
135145
</p>
136146
</li>
147+
<li>
148+
<p>
149+
<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html">StartMediaAnalysisJob</a>
150+
</p>
151+
</li>
137152
</ul>
138153
<p>
139154
<b>Amazon Rekognition Custom Labels</b>

‎clients/client-rekognition/src/Rekognition.ts

+15
Original file line numberDiff line numberDiff line change
@@ -1651,6 +1651,11 @@ export interface Rekognition {
16511651
* </li>
16521652
* <li>
16531653
* <p>
1654+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html">GetMediaAnalysisJob</a>
1655+
* </p>
1656+
* </li>
1657+
* <li>
1658+
* <p>
16541659
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a>
16551660
* </p>
16561661
* </li>
@@ -1661,6 +1666,11 @@ export interface Rekognition {
16611666
* </li>
16621667
* <li>
16631668
* <p>
1669+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html">ListMediaAnalysisJob</a>
1670+
* </p>
1671+
* </li>
1672+
* <li>
1673+
* <p>
16641674
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a>
16651675
* </p>
16661676
* </li>
@@ -1694,6 +1704,11 @@ export interface Rekognition {
16941704
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html">SearchUsersByImage</a>
16951705
* </p>
16961706
* </li>
1707+
* <li>
1708+
* <p>
1709+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html">StartMediaAnalysisJob</a>
1710+
* </p>
1711+
* </li>
16971712
* </ul>
16981713
* <p>
16991714
* <b>Amazon Rekognition Custom Labels</b>

‎clients/client-rekognition/src/RekognitionClient.ts

+15
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,11 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
647647
* </li>
648648
* <li>
649649
* <p>
650+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html">GetMediaAnalysisJob</a>
651+
* </p>
652+
* </li>
653+
* <li>
654+
* <p>
650655
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a>
651656
* </p>
652657
* </li>
@@ -657,6 +662,11 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
657662
* </li>
658663
* <li>
659664
* <p>
665+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html">ListMediaAnalysisJob</a>
666+
* </p>
667+
* </li>
668+
* <li>
669+
* <p>
660670
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a>
661671
* </p>
662672
* </li>
@@ -690,6 +700,11 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
690700
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html">SearchUsersByImage</a>
691701
* </p>
692702
* </li>
703+
* <li>
704+
* <p>
705+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html">StartMediaAnalysisJob</a>
706+
* </p>
707+
* </li>
693708
* </ul>
694709
* <p>
695710
* <b>Amazon Rekognition Custom Labels</b>

‎clients/client-rekognition/src/commands/DetectCustomLabelsCommand.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,12 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
3838
* an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing
3939
* image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
4040
* <p> For each object that the model version detects on an image, the API returns a
41-
* (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>).
42-
* Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
43-
* of confidence that the image contains the object (<code>Confidence</code>), and
44-
* object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>
41+
* (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>). Each
42+
* <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
43+
* of confidence that the image contains the object (<code>Confidence</code>), and object
44+
* location information, if it exists, for the label on the image (<code>Geometry</code>).
45+
* Note that for the <code>DetectCustomLabelsLabels</code> operation, <code>Polygons</code>
46+
* are not returned in the <code>Geometry</code> section of the response.</p>
4547
* <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
4648
* <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
4749
* the specified value.

‎clients/client-rekognition/src/commands/DetectModerationLabelsCommand.ts

+7
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
7878
* // Confidence: Number("float"),
7979
* // Name: "STRING_VALUE",
8080
* // ParentName: "STRING_VALUE",
81+
* // TaxonomyLevel: Number("int"),
8182
* // },
8283
* // ],
8384
* // ModerationModelVersion: "STRING_VALUE",
@@ -89,6 +90,12 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
8990
* // HumanLoopActivationConditionsEvaluationResults: "STRING_VALUE",
9091
* // },
9192
* // ProjectVersion: "STRING_VALUE",
93+
* // ContentTypes: [ // ContentTypes
94+
* // { // ContentType
95+
* // Confidence: Number("float"),
96+
* // Name: "STRING_VALUE",
97+
* // },
98+
* // ],
9299
* // };
93100
*
94101
* ```

‎clients/client-rekognition/src/commands/GetContentModerationCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
8989
* // Confidence: Number("float"),
9090
* // Name: "STRING_VALUE",
9191
* // ParentName: "STRING_VALUE",
92+
* // TaxonomyLevel: Number("int"),
9293
* // },
9394
* // StartTimestampMillis: Number("long"),
9495
* // EndTimestampMillis: Number("long"),

‎clients/client-rekognition/src/commands/GetMediaAnalysisJobCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ export interface GetMediaAnalysisJobCommandOutput extends GetMediaAnalysisJobRes
7575
* // Name: "STRING_VALUE",
7676
* // Version: "STRING_VALUE",
7777
* // },
78+
* // ModelVersions: { // MediaAnalysisModelVersions
79+
* // Moderation: "STRING_VALUE",
80+
* // },
7881
* // },
7982
* // ManifestSummary: { // MediaAnalysisManifestSummary
8083
* // S3Object: {

‎clients/client-rekognition/src/commands/ListMediaAnalysisJobsCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ export interface ListMediaAnalysisJobsCommandOutput extends ListMediaAnalysisJob
7878
* // Name: "STRING_VALUE",
7979
* // Version: "STRING_VALUE",
8080
* // },
81+
* // ModelVersions: { // MediaAnalysisModelVersions
82+
* // Moderation: "STRING_VALUE",
83+
* // },
8184
* // },
8285
* // ManifestSummary: { // MediaAnalysisManifestSummary
8386
* // S3Object: {

‎clients/client-rekognition/src/index.ts

+15
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@
8686
* </li>
8787
* <li>
8888
* <p>
89+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html">GetMediaAnalysisJob</a>
90+
* </p>
91+
* </li>
92+
* <li>
93+
* <p>
8994
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a>
9095
* </p>
9196
* </li>
@@ -96,6 +101,11 @@
96101
* </li>
97102
* <li>
98103
* <p>
104+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html">ListMediaAnalysisJob</a>
105+
* </p>
106+
* </li>
107+
* <li>
108+
* <p>
99109
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a>
100110
* </p>
101111
* </li>
@@ -129,6 +139,11 @@
129139
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html">SearchUsersByImage</a>
130140
* </p>
131141
* </li>
142+
* <li>
143+
* <p>
144+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html">StartMediaAnalysisJob</a>
145+
* </p>
146+
* </li>
132147
* </ul>
133148
* <p>
134149
* <b>Amazon Rekognition Custom Labels</b>

‎clients/client-rekognition/src/models/models_0.ts

+51-40
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,8 @@ export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
241241
export interface AssociateFacesResponse {
242242
/**
243243
* @public
244-
* <p>An array of AssociatedFace objects containing FaceIDs that are successfully associated
245-
* with the UserID is returned. Returned if the AssociateFaces action is successful.</p>
244+
* <p>An array of AssociatedFace objects containing FaceIDs that have been successfully associated
245+
* with the UserID. Returned if the AssociateFaces action is successful.</p>
246246
*/
247247
AssociatedFaces?: AssociatedFace[];
248248

@@ -1975,6 +1975,12 @@ export interface ModerationLabel {
19751975
* label <code>""</code>.</p>
19761976
*/
19771977
ParentName?: string;
1978+
1979+
/**
1980+
* @public
1981+
* <p>The level of the moderation label with regard to its taxonomy, from 1 to 3.</p>
1982+
*/
1983+
TaxonomyLevel?: number;
19781984
}
19791985

19801986
/**
@@ -2031,6 +2037,24 @@ export const ContentModerationSortBy = {
20312037
*/
20322038
export type ContentModerationSortBy = (typeof ContentModerationSortBy)[keyof typeof ContentModerationSortBy];
20332039

2040+
/**
2041+
* @public
2042+
* <p>Contains information regarding the confidence and name of a detected content type.</p>
2043+
*/
2044+
export interface ContentType {
2045+
/**
2046+
* @public
2047+
* <p>The confidence level of the label given</p>
2048+
*/
2049+
Confidence?: number;
2050+
2051+
/**
2052+
* @public
2053+
* <p>The name of the label</p>
2054+
*/
2055+
Name?: string;
2056+
}
2057+
20342058
/**
20352059
* @public
20362060
* <p>The S3 bucket and folder location where training output is placed.</p>
@@ -5006,6 +5030,13 @@ export interface DetectModerationLabelsResponse {
50065030
* indicating that a base moderation detection project version was used.</p>
50075031
*/
50085032
ProjectVersion?: string;
5033+
5034+
/**
5035+
* @public
5036+
* <p>A list of predicted results for the type of content an image contains. For example,
5037+
* the image content might be from animation, sports, or a video game.</p>
5038+
*/
5039+
ContentTypes?: ContentType[];
50095040
}
50105041

50115042
/**
@@ -6654,6 +6685,18 @@ export interface MediaAnalysisOutputConfig {
66546685
S3KeyPrefix?: string;
66556686
}
66566687

6688+
/**
6689+
* @public
6690+
* <p>Object containing information about the model versions of selected features in a given job.</p>
6691+
*/
6692+
export interface MediaAnalysisModelVersions {
6693+
/**
6694+
* @public
6695+
* <p>The Moderation base model version.</p>
6696+
*/
6697+
Moderation?: string;
6698+
}
6699+
66576700
/**
66586701
* @public
66596702
* <p>Contains the results for a media analysis job created with StartMediaAnalysisJob.</p>
@@ -6669,6 +6712,12 @@ export interface MediaAnalysisResults {
66696712
* Amazon Rekognition Developer Guide. </p>
66706713
*/
66716714
S3Object?: S3Object;
6715+
6716+
/**
6717+
* @public
6718+
* <p>Information about the model versions for the features selected in a given job.</p>
6719+
*/
6720+
ModelVersions?: MediaAnalysisModelVersions;
66726721
}
66736722

66746723
/**
@@ -8181,44 +8230,6 @@ export class MalformedPolicyDocumentException extends __BaseException {
81818230
}
81828231
}
81838232

8184-
/**
8185-
* @public
8186-
* <p>Contains metadata for a UserID matched with a given face.</p>
8187-
*/
8188-
export interface MatchedUser {
8189-
/**
8190-
* @public
8191-
* <p>A provided ID for the UserID. Unique within the collection.</p>
8192-
*/
8193-
UserId?: string;
8194-
8195-
/**
8196-
* @public
8197-
* <p>The status of the user matched to a provided FaceID.</p>
8198-
*/
8199-
UserStatus?: UserStatus;
8200-
}
8201-
8202-
/**
8203-
* @public
8204-
* <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
8205-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html">Calling Amazon Rekognition Video operations</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
8206-
* For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics">Giving access to multiple Amazon SNS topics</a>.</p>
8207-
*/
8208-
export interface NotificationChannel {
8209-
/**
8210-
* @public
8211-
* <p>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</p>
8212-
*/
8213-
SNSTopicArn: string | undefined;
8214-
8215-
/**
8216-
* @public
8217-
* <p>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </p>
8218-
*/
8219-
RoleArn: string | undefined;
8220-
}
8221-
82228233
/**
82238234
* @internal
82248235
*/

0 commit comments

Comments
 (0)