@aws-sdk/client-rekognition 3.299.0 → 3.301.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/dist-types/commands/CompareFacesCommand.d.ts +20 -0
  2. package/dist-types/commands/CopyProjectVersionCommand.d.ts +14 -0
  3. package/dist-types/commands/CreateCollectionCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +14 -0
  5. package/dist-types/commands/CreateProjectCommand.d.ts +3 -0
  6. package/dist-types/commands/CreateProjectVersionCommand.d.ts +39 -0
  7. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +56 -0
  8. package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -0
  9. package/dist-types/commands/DeleteDatasetCommand.d.ts +3 -0
  10. package/dist-types/commands/DeleteFacesCommand.d.ts +6 -0
  11. package/dist-types/commands/DeleteProjectCommand.d.ts +3 -0
  12. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +5 -0
  13. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +3 -0
  14. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +3 -0
  15. package/dist-types/commands/DescribeCollectionCommand.d.ts +3 -0
  16. package/dist-types/commands/DescribeDatasetCommand.d.ts +3 -0
  17. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +8 -0
  18. package/dist-types/commands/DescribeProjectsCommand.d.ts +7 -0
  19. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +3 -0
  20. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +13 -0
  21. package/dist-types/commands/DetectFacesCommand.d.ts +13 -0
  22. package/dist-types/commands/DetectLabelsCommand.d.ts +34 -0
  23. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +20 -0
  24. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +16 -0
  25. package/dist-types/commands/DetectTextCommand.d.ts +33 -0
  26. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +7 -0
  27. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +3 -0
  28. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +6 -0
  29. package/dist-types/commands/GetContentModerationCommand.d.ts +6 -0
  30. package/dist-types/commands/GetFaceDetectionCommand.d.ts +5 -0
  31. package/dist-types/commands/GetFaceSearchCommand.d.ts +6 -0
  32. package/dist-types/commands/GetLabelDetectionCommand.d.ts +7 -0
  33. package/dist-types/commands/GetPersonTrackingCommand.d.ts +6 -0
  34. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +5 -0
  35. package/dist-types/commands/GetTextDetectionCommand.d.ts +5 -0
  36. package/dist-types/commands/IndexFacesCommand.d.ts +17 -0
  37. package/dist-types/commands/ListCollectionsCommand.d.ts +4 -0
  38. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +11 -0
  39. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +5 -0
  40. package/dist-types/commands/ListFacesCommand.d.ts +5 -0
  41. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +5 -0
  42. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +4 -0
  43. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  44. package/dist-types/commands/PutProjectPolicyCommand.d.ts +6 -0
  45. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +10 -0
  46. package/dist-types/commands/SearchFacesByImageCommand.d.ts +14 -0
  47. package/dist-types/commands/SearchFacesCommand.d.ts +6 -0
  48. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +15 -0
  49. package/dist-types/commands/StartContentModerationCommand.d.ts +16 -0
  50. package/dist-types/commands/StartFaceDetectionCommand.d.ts +16 -0
  51. package/dist-types/commands/StartFaceSearchCommand.d.ts +17 -0
  52. package/dist-types/commands/StartLabelDetectionCommand.d.ts +35 -0
  53. package/dist-types/commands/StartPersonTrackingCommand.d.ts +15 -0
  54. package/dist-types/commands/StartProjectVersionCommand.d.ts +5 -0
  55. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +30 -0
  56. package/dist-types/commands/StartStreamProcessorCommand.d.ts +12 -0
  57. package/dist-types/commands/StartTextDetectionCommand.d.ts +38 -0
  58. package/dist-types/commands/StopProjectVersionCommand.d.ts +3 -0
  59. package/dist-types/commands/StopStreamProcessorCommand.d.ts +3 -0
  60. package/dist-types/commands/TagResourceCommand.d.ts +6 -0
  61. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  62. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +6 -0
  63. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +33 -0
  64. package/package.json +8 -8
@@ -76,6 +76,26 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
76
76
  * import { RekognitionClient, CompareFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
77
77
  * // const { RekognitionClient, CompareFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
78
78
  * const client = new RekognitionClient(config);
79
+ * const input = { // CompareFacesRequest
80
+ * SourceImage: { // Image
81
+ * Bytes: "BLOB_VALUE",
82
+ * S3Object: { // S3Object
83
+ * Bucket: "STRING_VALUE",
84
+ * Name: "STRING_VALUE",
85
+ * Version: "STRING_VALUE",
86
+ * },
87
+ * },
88
+ * TargetImage: {
89
+ * Bytes: "BLOB_VALUE",
90
+ * S3Object: {
91
+ * Bucket: "STRING_VALUE",
92
+ * Name: "STRING_VALUE",
93
+ * Version: "STRING_VALUE",
94
+ * },
95
+ * },
96
+ * SimilarityThreshold: Number("float"),
97
+ * QualityFilter: "NONE" || "AUTO" || "LOW" || "MEDIUM" || "HIGH",
98
+ * };
79
99
  * const command = new CompareFacesCommand(input);
80
100
  * const response = await client.send(command);
81
101
  * ```
@@ -44,6 +44,20 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
44
44
  * import { RekognitionClient, CopyProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
45
45
  * // const { RekognitionClient, CopyProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
46
46
  * const client = new RekognitionClient(config);
47
+ * const input = { // CopyProjectVersionRequest
48
+ * SourceProjectArn: "STRING_VALUE", // required
49
+ * SourceProjectVersionArn: "STRING_VALUE", // required
50
+ * DestinationProjectArn: "STRING_VALUE", // required
51
+ * VersionName: "STRING_VALUE", // required
52
+ * OutputConfig: { // OutputConfig
53
+ * S3Bucket: "STRING_VALUE",
54
+ * S3KeyPrefix: "STRING_VALUE",
55
+ * },
56
+ * Tags: { // TagMap
57
+ * "<keys>": "STRING_VALUE",
58
+ * },
59
+ * KmsKeyId: "STRING_VALUE",
60
+ * };
47
61
  * const command = new CopyProjectVersionCommand(input);
48
62
  * const response = await client.send(command);
49
63
  * ```
@@ -40,6 +40,12 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
40
40
  * import { RekognitionClient, CreateCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
41
41
  * // const { RekognitionClient, CreateCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
42
42
  * const client = new RekognitionClient(config);
43
+ * const input = { // CreateCollectionRequest
44
+ * CollectionId: "STRING_VALUE", // required
45
+ * Tags: { // TagMap
46
+ * "<keys>": "STRING_VALUE",
47
+ * },
48
+ * };
43
49
  * const command = new CreateCollectionCommand(input);
44
50
  * const response = await client.send(command);
45
51
  * ```
@@ -44,6 +44,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
44
44
  * import { RekognitionClient, CreateDatasetCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
45
45
  * // const { RekognitionClient, CreateDatasetCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
46
46
  * const client = new RekognitionClient(config);
47
+ * const input = { // CreateDatasetRequest
48
+ * DatasetSource: { // DatasetSource
49
+ * GroundTruthManifest: { // GroundTruthManifest
50
+ * S3Object: { // S3Object
51
+ * Bucket: "STRING_VALUE",
52
+ * Name: "STRING_VALUE",
53
+ * Version: "STRING_VALUE",
54
+ * },
55
+ * },
56
+ * DatasetArn: "STRING_VALUE",
57
+ * },
58
+ * DatasetType: "TRAIN" || "TEST", // required
59
+ * ProjectArn: "STRING_VALUE", // required
60
+ * };
47
61
  * const command = new CreateDatasetCommand(input);
48
62
  * const response = await client.send(command);
49
63
  * ```
@@ -28,6 +28,9 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
28
28
  * import { RekognitionClient, CreateProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
29
29
  * // const { RekognitionClient, CreateProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
30
30
  * const client = new RekognitionClient(config);
31
+ * const input = { // CreateProjectRequest
32
+ * ProjectName: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new CreateProjectCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -55,6 +55,45 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
55
55
  * import { RekognitionClient, CreateProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
56
56
  * // const { RekognitionClient, CreateProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
57
57
  * const client = new RekognitionClient(config);
58
+ * const input = { // CreateProjectVersionRequest
59
+ * ProjectArn: "STRING_VALUE", // required
60
+ * VersionName: "STRING_VALUE", // required
61
+ * OutputConfig: { // OutputConfig
62
+ * S3Bucket: "STRING_VALUE",
63
+ * S3KeyPrefix: "STRING_VALUE",
64
+ * },
65
+ * TrainingData: { // TrainingData
66
+ * Assets: [ // Assets
67
+ * { // Asset
68
+ * GroundTruthManifest: { // GroundTruthManifest
69
+ * S3Object: { // S3Object
70
+ * Bucket: "STRING_VALUE",
71
+ * Name: "STRING_VALUE",
72
+ * Version: "STRING_VALUE",
73
+ * },
74
+ * },
75
+ * },
76
+ * ],
77
+ * },
78
+ * TestingData: { // TestingData
79
+ * Assets: [
80
+ * {
81
+ * GroundTruthManifest: {
82
+ * S3Object: {
83
+ * Bucket: "STRING_VALUE",
84
+ * Name: "STRING_VALUE",
85
+ * Version: "STRING_VALUE",
86
+ * },
87
+ * },
88
+ * },
89
+ * ],
90
+ * AutoCreate: true || false,
91
+ * },
92
+ * Tags: { // TagMap
93
+ * "<keys>": "STRING_VALUE",
94
+ * },
95
+ * KmsKeyId: "STRING_VALUE",
96
+ * };
58
97
  * const command = new CreateProjectVersionCommand(input);
59
98
  * const response = await client.send(command);
60
99
  * ```
@@ -46,6 +46,62 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
46
46
  * import { RekognitionClient, CreateStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
47
47
  * // const { RekognitionClient, CreateStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
48
48
  * const client = new RekognitionClient(config);
49
+ * const input = { // CreateStreamProcessorRequest
50
+ * Input: { // StreamProcessorInput
51
+ * KinesisVideoStream: { // KinesisVideoStream
52
+ * Arn: "STRING_VALUE",
53
+ * },
54
+ * },
55
+ * Output: { // StreamProcessorOutput
56
+ * KinesisDataStream: { // KinesisDataStream
57
+ * Arn: "STRING_VALUE",
58
+ * },
59
+ * S3Destination: { // S3Destination
60
+ * Bucket: "STRING_VALUE",
61
+ * KeyPrefix: "STRING_VALUE",
62
+ * },
63
+ * },
64
+ * Name: "STRING_VALUE", // required
65
+ * Settings: { // StreamProcessorSettings
66
+ * FaceSearch: { // FaceSearchSettings
67
+ * CollectionId: "STRING_VALUE",
68
+ * FaceMatchThreshold: Number("float"),
69
+ * },
70
+ * ConnectedHome: { // ConnectedHomeSettings
71
+ * Labels: [ // ConnectedHomeLabels // required
72
+ * "STRING_VALUE",
73
+ * ],
74
+ * MinConfidence: Number("float"),
75
+ * },
76
+ * },
77
+ * RoleArn: "STRING_VALUE", // required
78
+ * Tags: { // TagMap
79
+ * "<keys>": "STRING_VALUE",
80
+ * },
81
+ * NotificationChannel: { // StreamProcessorNotificationChannel
82
+ * SNSTopicArn: "STRING_VALUE", // required
83
+ * },
84
+ * KmsKeyId: "STRING_VALUE",
85
+ * RegionsOfInterest: [ // RegionsOfInterest
86
+ * { // RegionOfInterest
87
+ * BoundingBox: { // BoundingBox
88
+ * Width: Number("float"),
89
+ * Height: Number("float"),
90
+ * Left: Number("float"),
91
+ * Top: Number("float"),
92
+ * },
93
+ * Polygon: [ // Polygon
94
+ * { // Point
95
+ * X: Number("float"),
96
+ * Y: Number("float"),
97
+ * },
98
+ * ],
99
+ * },
100
+ * ],
101
+ * DataSharingPreference: { // StreamProcessorDataSharingPreference
102
+ * OptIn: true || false, // required
103
+ * },
104
+ * };
49
105
  * const command = new CreateStreamProcessorCommand(input);
50
106
  * const response = await client.send(command);
51
107
  * ```
@@ -30,6 +30,9 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
30
30
  * import { RekognitionClient, DeleteCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
31
31
  * // const { RekognitionClient, DeleteCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
32
32
  * const client = new RekognitionClient(config);
33
+ * const input = { // DeleteCollectionRequest
34
+ * CollectionId: "STRING_VALUE", // required
35
+ * };
33
36
  * const command = new DeleteCollectionCommand(input);
34
37
  * const response = await client.send(command);
35
38
  * ```
@@ -35,6 +35,9 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
35
35
  * import { RekognitionClient, DeleteDatasetCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
36
36
  * // const { RekognitionClient, DeleteDatasetCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
37
37
  * const client = new RekognitionClient(config);
38
+ * const input = { // DeleteDatasetRequest
39
+ * DatasetArn: "STRING_VALUE", // required
40
+ * };
38
41
  * const command = new DeleteDatasetCommand(input);
39
42
  * const response = await client.send(command);
40
43
  * ```
@@ -29,6 +29,12 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
29
29
  * import { RekognitionClient, DeleteFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
30
30
  * // const { RekognitionClient, DeleteFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
31
31
  * const client = new RekognitionClient(config);
32
+ * const input = { // DeleteFacesRequest
33
+ * CollectionId: "STRING_VALUE", // required
34
+ * FaceIds: [ // FaceIdList // required
35
+ * "STRING_VALUE",
36
+ * ],
37
+ * };
32
38
  * const command = new DeleteFacesCommand(input);
33
39
  * const response = await client.send(command);
34
40
  * ```
@@ -34,6 +34,9 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
34
34
  * import { RekognitionClient, DeleteProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
35
35
  * // const { RekognitionClient, DeleteProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
36
36
  * const client = new RekognitionClient(config);
37
+ * const input = { // DeleteProjectRequest
38
+ * ProjectArn: "STRING_VALUE", // required
39
+ * };
37
40
  * const command = new DeleteProjectCommand(input);
38
41
  * const response = await client.send(command);
39
42
  * ```
@@ -27,6 +27,11 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
27
27
  * import { RekognitionClient, DeleteProjectPolicyCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
28
28
  * // const { RekognitionClient, DeleteProjectPolicyCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
29
29
  * const client = new RekognitionClient(config);
30
+ * const input = { // DeleteProjectPolicyRequest
31
+ * ProjectArn: "STRING_VALUE", // required
32
+ * PolicyName: "STRING_VALUE", // required
33
+ * PolicyRevisionId: "STRING_VALUE",
34
+ * };
30
35
  * const command = new DeleteProjectPolicyCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -33,6 +33,9 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
33
33
  * import { RekognitionClient, DeleteProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
34
34
  * // const { RekognitionClient, DeleteProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
35
35
  * const client = new RekognitionClient(config);
36
+ * const input = { // DeleteProjectVersionRequest
37
+ * ProjectVersionArn: "STRING_VALUE", // required
38
+ * };
36
39
  * const command = new DeleteProjectVersionCommand(input);
37
40
  * const response = await client.send(command);
38
41
  * ```
@@ -27,6 +27,9 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso
27
27
  * import { RekognitionClient, DeleteStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
28
28
  * // const { RekognitionClient, DeleteStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
29
29
  * const client = new RekognitionClient(config);
30
+ * const input = { // DeleteStreamProcessorRequest
31
+ * Name: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DeleteStreamProcessorCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -30,6 +30,9 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
30
30
  * import { RekognitionClient, DescribeCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
31
31
  * // const { RekognitionClient, DescribeCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
32
32
  * const client = new RekognitionClient(config);
33
+ * const input = { // DescribeCollectionRequest
34
+ * CollectionId: "STRING_VALUE", // required
35
+ * };
33
36
  * const command = new DescribeCollectionCommand(input);
34
37
  * const response = await client.send(command);
35
38
  * ```
@@ -30,6 +30,9 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
30
30
  * import { RekognitionClient, DescribeDatasetCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
31
31
  * // const { RekognitionClient, DescribeDatasetCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
32
32
  * const client = new RekognitionClient(config);
33
+ * const input = { // DescribeDatasetRequest
34
+ * DatasetArn: "STRING_VALUE", // required
35
+ * };
33
36
  * const command = new DescribeDatasetCommand(input);
34
37
  * const response = await client.send(command);
35
38
  * ```
@@ -30,6 +30,14 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
30
30
  * import { RekognitionClient, DescribeProjectVersionsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
31
31
  * // const { RekognitionClient, DescribeProjectVersionsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
32
32
  * const client = new RekognitionClient(config);
33
+ * const input = { // DescribeProjectVersionsRequest
34
+ * ProjectArn: "STRING_VALUE", // required
35
+ * VersionNames: [ // VersionNames
36
+ * "STRING_VALUE",
37
+ * ],
38
+ * NextToken: "STRING_VALUE",
39
+ * MaxResults: Number("int"),
40
+ * };
33
41
  * const command = new DescribeProjectVersionsCommand(input);
34
42
  * const response = await client.send(command);
35
43
  * ```
@@ -27,6 +27,13 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
27
27
  * import { RekognitionClient, DescribeProjectsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
28
28
  * // const { RekognitionClient, DescribeProjectsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
29
29
  * const client = new RekognitionClient(config);
30
+ * const input = { // DescribeProjectsRequest
31
+ * NextToken: "STRING_VALUE",
32
+ * MaxResults: Number("int"),
33
+ * ProjectNames: [ // ProjectNames
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * };
30
37
  * const command = new DescribeProjectsCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -27,6 +27,9 @@ export interface DescribeStreamProcessorCommandOutput extends DescribeStreamProc
27
27
  * import { RekognitionClient, DescribeStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
28
28
  * // const { RekognitionClient, DescribeStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
29
29
  * const client = new RekognitionClient(config);
30
+ * const input = { // DescribeStreamProcessorRequest
31
+ * Name: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeStreamProcessorCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -57,6 +57,19 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
57
57
  * import { RekognitionClient, DetectCustomLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
58
58
  * // const { RekognitionClient, DetectCustomLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
59
59
  * const client = new RekognitionClient(config);
60
+ * const input = { // DetectCustomLabelsRequest
61
+ * ProjectVersionArn: "STRING_VALUE", // required
62
+ * Image: { // Image
63
+ * Bytes: "BLOB_VALUE",
64
+ * S3Object: { // S3Object
65
+ * Bucket: "STRING_VALUE",
66
+ * Name: "STRING_VALUE",
67
+ * Version: "STRING_VALUE",
68
+ * },
69
+ * },
70
+ * MaxResults: Number("int"),
71
+ * MinConfidence: Number("float"),
72
+ * };
60
73
  * const command = new DetectCustomLabelsCommand(input);
61
74
  * const response = await client.send(command);
62
75
  * ```
@@ -44,6 +44,19 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat
44
44
  * import { RekognitionClient, DetectFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
45
45
  * // const { RekognitionClient, DetectFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
46
46
  * const client = new RekognitionClient(config);
47
+ * const input = { // DetectFacesRequest
48
+ * Image: { // Image
49
+ * Bytes: "BLOB_VALUE",
50
+ * S3Object: { // S3Object
51
+ * Bucket: "STRING_VALUE",
52
+ * Name: "STRING_VALUE",
53
+ * Version: "STRING_VALUE",
54
+ * },
55
+ * },
56
+ * Attributes: [ // Attributes
57
+ * "DEFAULT" || "ALL",
58
+ * ],
59
+ * };
47
60
  * const command = new DetectFacesCommand(input);
48
61
  * const response = await client.send(command);
49
62
  * ```
@@ -138,6 +138,40 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
138
138
  * import { RekognitionClient, DetectLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
139
139
  * // const { RekognitionClient, DetectLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
140
140
  * const client = new RekognitionClient(config);
141
+ * const input = { // DetectLabelsRequest
142
+ * Image: { // Image
143
+ * Bytes: "BLOB_VALUE",
144
+ * S3Object: { // S3Object
145
+ * Bucket: "STRING_VALUE",
146
+ * Name: "STRING_VALUE",
147
+ * Version: "STRING_VALUE",
148
+ * },
149
+ * },
150
+ * MaxLabels: Number("int"),
151
+ * MinConfidence: Number("float"),
152
+ * Features: [ // DetectLabelsFeatureList
153
+ * "GENERAL_LABELS" || "IMAGE_PROPERTIES",
154
+ * ],
155
+ * Settings: { // DetectLabelsSettings
156
+ * GeneralLabels: { // GeneralLabelsSettings
157
+ * LabelInclusionFilters: [ // GeneralLabelsFilterList
158
+ * "STRING_VALUE",
159
+ * ],
160
+ * LabelExclusionFilters: [
161
+ * "STRING_VALUE",
162
+ * ],
163
+ * LabelCategoryInclusionFilters: [
164
+ * "STRING_VALUE",
165
+ * ],
166
+ * LabelCategoryExclusionFilters: [
167
+ * "STRING_VALUE",
168
+ * ],
169
+ * },
170
+ * ImageProperties: { // DetectLabelsImagePropertiesSettings
171
+ * MaxDominantColors: Number("int"),
172
+ * },
173
+ * },
174
+ * };
141
175
  * const command = new DetectLabelsCommand(input);
142
176
  * const response = await client.send(command);
143
177
  * ```
@@ -38,6 +38,26 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
38
38
  * import { RekognitionClient, DetectModerationLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
39
39
  * // const { RekognitionClient, DetectModerationLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
40
40
  * const client = new RekognitionClient(config);
41
+ * const input = { // DetectModerationLabelsRequest
42
+ * Image: { // Image
43
+ * Bytes: "BLOB_VALUE",
44
+ * S3Object: { // S3Object
45
+ * Bucket: "STRING_VALUE",
46
+ * Name: "STRING_VALUE",
47
+ * Version: "STRING_VALUE",
48
+ * },
49
+ * },
50
+ * MinConfidence: Number("float"),
51
+ * HumanLoopConfig: { // HumanLoopConfig
52
+ * HumanLoopName: "STRING_VALUE", // required
53
+ * FlowDefinitionArn: "STRING_VALUE", // required
54
+ * DataAttributes: { // HumanLoopDataAttributes
55
+ * ContentClassifiers: [ // ContentClassifiers
56
+ * "FreeOfPersonallyIdentifiableInformation" || "FreeOfAdultContent",
57
+ * ],
58
+ * },
59
+ * },
60
+ * };
41
61
  * const command = new DetectModerationLabelsCommand(input);
42
62
  * const response = await client.send(command);
43
63
  * ```
@@ -62,6 +62,22 @@ export interface DetectProtectiveEquipmentCommandOutput extends DetectProtective
62
62
  * import { RekognitionClient, DetectProtectiveEquipmentCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
63
63
  * // const { RekognitionClient, DetectProtectiveEquipmentCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
64
64
  * const client = new RekognitionClient(config);
65
+ * const input = { // DetectProtectiveEquipmentRequest
66
+ * Image: { // Image
67
+ * Bytes: "BLOB_VALUE",
68
+ * S3Object: { // S3Object
69
+ * Bucket: "STRING_VALUE",
70
+ * Name: "STRING_VALUE",
71
+ * Version: "STRING_VALUE",
72
+ * },
73
+ * },
74
+ * SummarizationAttributes: { // ProtectiveEquipmentSummarizationAttributes
75
+ * MinConfidence: Number("float"), // required
76
+ * RequiredEquipmentTypes: [ // ProtectiveEquipmentTypes // required
77
+ * "FACE_COVER" || "HAND_COVER" || "HEAD_COVER",
78
+ * ],
79
+ * },
80
+ * };
65
81
  * const command = new DetectProtectiveEquipmentCommand(input);
66
82
  * const response = await client.send(command);
67
83
  * ```
@@ -48,6 +48,39 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB
48
48
  * import { RekognitionClient, DetectTextCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
49
49
  * // const { RekognitionClient, DetectTextCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
50
50
  * const client = new RekognitionClient(config);
51
+ * const input = { // DetectTextRequest
52
+ * Image: { // Image
53
+ * Bytes: "BLOB_VALUE",
54
+ * S3Object: { // S3Object
55
+ * Bucket: "STRING_VALUE",
56
+ * Name: "STRING_VALUE",
57
+ * Version: "STRING_VALUE",
58
+ * },
59
+ * },
60
+ * Filters: { // DetectTextFilters
61
+ * WordFilter: { // DetectionFilter
62
+ * MinConfidence: Number("float"),
63
+ * MinBoundingBoxHeight: Number("float"),
64
+ * MinBoundingBoxWidth: Number("float"),
65
+ * },
66
+ * RegionsOfInterest: [ // RegionsOfInterest
67
+ * { // RegionOfInterest
68
+ * BoundingBox: { // BoundingBox
69
+ * Width: Number("float"),
70
+ * Height: Number("float"),
71
+ * Left: Number("float"),
72
+ * Top: Number("float"),
73
+ * },
74
+ * Polygon: [ // Polygon
75
+ * { // Point
76
+ * X: Number("float"),
77
+ * Y: Number("float"),
78
+ * },
79
+ * ],
80
+ * },
81
+ * ],
82
+ * },
83
+ * };
51
84
  * const command = new DetectTextCommand(input);
52
85
  * const response = await client.send(command);
53
86
  * ```
@@ -36,6 +36,13 @@ export interface DistributeDatasetEntriesCommandOutput extends DistributeDataset
36
36
  * import { RekognitionClient, DistributeDatasetEntriesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
37
37
  * // const { RekognitionClient, DistributeDatasetEntriesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
38
38
  * const client = new RekognitionClient(config);
39
+ * const input = { // DistributeDatasetEntriesRequest
40
+ * Datasets: [ // DistributeDatasetMetadataList // required
41
+ * { // DistributeDataset
42
+ * Arn: "STRING_VALUE", // required
43
+ * },
44
+ * ],
45
+ * };
39
46
  * const command = new DistributeDatasetEntriesCommand(input);
40
47
  * const response = await client.send(command);
41
48
  * ```
@@ -32,6 +32,9 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse,
32
32
  * import { RekognitionClient, GetCelebrityInfoCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
33
33
  * // const { RekognitionClient, GetCelebrityInfoCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
34
34
  * const client = new RekognitionClient(config);
35
+ * const input = { // GetCelebrityInfoRequest
36
+ * Id: "STRING_VALUE", // required
37
+ * };
35
38
  * const command = new GetCelebrityInfoCommand(input);
36
39
  * const response = await client.send(command);
37
40
  * ```
@@ -64,6 +64,12 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
64
64
  * import { RekognitionClient, GetCelebrityRecognitionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
65
65
  * // const { RekognitionClient, GetCelebrityRecognitionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
66
66
  * const client = new RekognitionClient(config);
67
+ * const input = { // GetCelebrityRecognitionRequest
68
+ * JobId: "STRING_VALUE", // required
69
+ * MaxResults: Number("int"),
70
+ * NextToken: "STRING_VALUE",
71
+ * SortBy: "ID" || "TIMESTAMP",
72
+ * };
67
73
  * const command = new GetCelebrityRecognitionCommand(input);
68
74
  * const response = await client.send(command);
69
75
  * ```
@@ -52,6 +52,12 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
52
52
  * import { RekognitionClient, GetContentModerationCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
53
53
  * // const { RekognitionClient, GetContentModerationCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
54
54
  * const client = new RekognitionClient(config);
55
+ * const input = { // GetContentModerationRequest
56
+ * JobId: "STRING_VALUE", // required
57
+ * MaxResults: Number("int"),
58
+ * NextToken: "STRING_VALUE",
59
+ * SortBy: "NAME" || "TIMESTAMP",
60
+ * };
55
61
  * const command = new GetContentModerationCommand(input);
56
62
  * const response = await client.send(command);
57
63
  * ```
@@ -38,6 +38,11 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
38
38
  * import { RekognitionClient, GetFaceDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
39
39
  * // const { RekognitionClient, GetFaceDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
40
40
  * const client = new RekognitionClient(config);
41
+ * const input = { // GetFaceDetectionRequest
42
+ * JobId: "STRING_VALUE", // required
43
+ * MaxResults: Number("int"),
44
+ * NextToken: "STRING_VALUE",
45
+ * };
41
46
  * const command = new GetFaceDetectionCommand(input);
42
47
  * const response = await client.send(command);
43
48
  * ```
@@ -54,6 +54,12 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
54
54
  * import { RekognitionClient, GetFaceSearchCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
55
55
  * // const { RekognitionClient, GetFaceSearchCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
56
56
  * const client = new RekognitionClient(config);
57
+ * const input = { // GetFaceSearchRequest
58
+ * JobId: "STRING_VALUE", // required
59
+ * MaxResults: Number("int"),
60
+ * NextToken: "STRING_VALUE",
61
+ * SortBy: "INDEX" || "TIMESTAMP",
62
+ * };
57
63
  * const command = new GetFaceSearchCommand(input);
58
64
  * const response = await client.send(command);
59
65
  * ```
@@ -91,6 +91,13 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
91
91
  * import { RekognitionClient, GetLabelDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
92
92
  * // const { RekognitionClient, GetLabelDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
93
93
  * const client = new RekognitionClient(config);
94
+ * const input = { // GetLabelDetectionRequest
95
+ * JobId: "STRING_VALUE", // required
96
+ * MaxResults: Number("int"),
97
+ * NextToken: "STRING_VALUE",
98
+ * SortBy: "NAME" || "TIMESTAMP",
99
+ * AggregateBy: "TIMESTAMPS" || "SEGMENTS",
100
+ * };
94
101
  * const command = new GetLabelDetectionCommand(input);
95
102
  * const response = await client.send(command);
96
103
  * ```
@@ -50,6 +50,12 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons
50
50
  * import { RekognitionClient, GetPersonTrackingCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
51
51
  * // const { RekognitionClient, GetPersonTrackingCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
52
52
  * const client = new RekognitionClient(config);
53
+ * const input = { // GetPersonTrackingRequest
54
+ * JobId: "STRING_VALUE", // required
55
+ * MaxResults: Number("int"),
56
+ * NextToken: "STRING_VALUE",
57
+ * SortBy: "INDEX" || "TIMESTAMP",
58
+ * };
53
59
  * const command = new GetPersonTrackingCommand(input);
54
60
  * const response = await client.send(command);
55
61
  * ```