@aws-sdk/client-rekognition 3.295.0 → 3.297.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 (85) hide show
  1. package/dist-types/Rekognition.d.ts +70 -6
  2. package/dist-types/RekognitionClient.d.ts +24 -4
  3. package/dist-types/commands/CompareFacesCommand.d.ts +16 -0
  4. package/dist-types/commands/CopyProjectVersionCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateCollectionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateProjectVersionCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteCollectionCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteFacesCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeCollectionCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeProjectsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +16 -0
  22. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +16 -0
  23. package/dist-types/commands/DetectFacesCommand.d.ts +16 -0
  24. package/dist-types/commands/DetectLabelsCommand.d.ts +22 -6
  25. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +16 -0
  26. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +16 -0
  27. package/dist-types/commands/DetectTextCommand.d.ts +16 -0
  28. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +16 -0
  29. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +16 -0
  30. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +16 -0
  31. package/dist-types/commands/GetContentModerationCommand.d.ts +16 -0
  32. package/dist-types/commands/GetFaceDetectionCommand.d.ts +16 -0
  33. package/dist-types/commands/GetFaceSearchCommand.d.ts +16 -0
  34. package/dist-types/commands/GetLabelDetectionCommand.d.ts +16 -0
  35. package/dist-types/commands/GetPersonTrackingCommand.d.ts +16 -0
  36. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +16 -0
  37. package/dist-types/commands/GetTextDetectionCommand.d.ts +16 -0
  38. package/dist-types/commands/IndexFacesCommand.d.ts +16 -0
  39. package/dist-types/commands/ListCollectionsCommand.d.ts +16 -0
  40. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +16 -0
  41. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +16 -0
  42. package/dist-types/commands/ListFacesCommand.d.ts +16 -0
  43. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
  44. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  46. package/dist-types/commands/PutProjectPolicyCommand.d.ts +16 -0
  47. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +16 -0
  48. package/dist-types/commands/SearchFacesByImageCommand.d.ts +16 -0
  49. package/dist-types/commands/SearchFacesCommand.d.ts +16 -0
  50. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +16 -0
  51. package/dist-types/commands/StartContentModerationCommand.d.ts +16 -0
  52. package/dist-types/commands/StartFaceDetectionCommand.d.ts +16 -0
  53. package/dist-types/commands/StartFaceSearchCommand.d.ts +16 -0
  54. package/dist-types/commands/StartLabelDetectionCommand.d.ts +16 -0
  55. package/dist-types/commands/StartPersonTrackingCommand.d.ts +16 -0
  56. package/dist-types/commands/StartProjectVersionCommand.d.ts +16 -0
  57. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +16 -0
  58. package/dist-types/commands/StartStreamProcessorCommand.d.ts +16 -0
  59. package/dist-types/commands/StartTextDetectionCommand.d.ts +16 -0
  60. package/dist-types/commands/StopProjectVersionCommand.d.ts +16 -0
  61. package/dist-types/commands/StopStreamProcessorCommand.d.ts +16 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  64. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +16 -0
  65. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +16 -0
  66. package/dist-types/models/RekognitionServiceException.d.ts +2 -0
  67. package/dist-types/models/models_0.d.ts +610 -0
  68. package/dist-types/pagination/DescribeProjectVersionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/DescribeProjectsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/GetCelebrityRecognitionPaginator.d.ts +3 -0
  71. package/dist-types/pagination/GetContentModerationPaginator.d.ts +3 -0
  72. package/dist-types/pagination/GetFaceDetectionPaginator.d.ts +3 -0
  73. package/dist-types/pagination/GetFaceSearchPaginator.d.ts +3 -0
  74. package/dist-types/pagination/GetLabelDetectionPaginator.d.ts +3 -0
  75. package/dist-types/pagination/GetPersonTrackingPaginator.d.ts +3 -0
  76. package/dist-types/pagination/GetSegmentDetectionPaginator.d.ts +3 -0
  77. package/dist-types/pagination/GetTextDetectionPaginator.d.ts +3 -0
  78. package/dist-types/pagination/Interfaces.d.ts +3 -0
  79. package/dist-types/pagination/ListCollectionsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListDatasetEntriesPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListDatasetLabelsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListFacesPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListProjectPoliciesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListStreamProcessorsPaginator.d.ts +3 -0
  85. package/package.json +30 -30
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListCollectionsRequest, ListCollectionsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListCollectionsCommand}.
8
10
  */
9
11
  export interface ListCollectionsCommandInput extends ListCollectionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListCollectionsCommand}.
13
17
  */
14
18
  export interface ListCollectionsCommandOutput extends ListCollectionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns list of collection IDs in your account. If the result is truncated, the
18
23
  * response also provides a <code>NextToken</code> that you can use in the subsequent request to
19
24
  * fetch the next set of collection IDs.</p>
@@ -31,6 +36,8 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ListCollectionsCommandInput - {@link ListCollectionsCommandInput}
40
+ * @returns {@link ListCollectionsCommandOutput}
34
41
  * @see {@link ListCollectionsCommandInput} for command's `input` shape.
35
42
  * @see {@link ListCollectionsCommandOutput} for command's `response` shape.
36
43
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -79,11 +86,20 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
79
86
  export declare class ListCollectionsCommand extends $Command<ListCollectionsCommandInput, ListCollectionsCommandOutput, RekognitionClientResolvedConfig> {
80
87
  readonly input: ListCollectionsCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: ListCollectionsCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCollectionsCommandInput, ListCollectionsCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListDatasetEntriesRequest, ListDatasetEntriesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDatasetEntriesCommand}.
8
10
  */
9
11
  export interface ListDatasetEntriesCommandInput extends ListDatasetEntriesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDatasetEntriesCommand}.
13
17
  */
14
18
  export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Lists the entries (images) within a dataset. An entry is a
19
24
  * JSON Line that contains the information for a single image, including
@@ -38,6 +43,8 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param ListDatasetEntriesCommandInput - {@link ListDatasetEntriesCommandInput}
47
+ * @returns {@link ListDatasetEntriesCommandOutput}
41
48
  * @see {@link ListDatasetEntriesCommandInput} for command's `input` shape.
42
49
  * @see {@link ListDatasetEntriesCommandOutput} for command's `response` shape.
43
50
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -78,11 +85,20 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
78
85
  export declare class ListDatasetEntriesCommand extends $Command<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
79
86
  readonly input: ListDatasetEntriesCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: ListDatasetEntriesCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListDatasetLabelsRequest, ListDatasetLabelsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDatasetLabelsCommand}.
8
10
  */
9
11
  export interface ListDatasetLabelsCommandInput extends ListDatasetLabelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDatasetLabelsCommand}.
13
17
  */
14
18
  export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see
18
23
  * <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html">Labeling images</a>.
19
24
  * </p>
@@ -30,6 +35,8 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListDatasetLabelsCommandInput - {@link ListDatasetLabelsCommandInput}
39
+ * @returns {@link ListDatasetLabelsCommandOutput}
33
40
  * @see {@link ListDatasetLabelsCommandInput} for command's `input` shape.
34
41
  * @see {@link ListDatasetLabelsCommandOutput} for command's `response` shape.
35
42
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -70,11 +77,20 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
70
77
  export declare class ListDatasetLabelsCommand extends $Command<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput, RekognitionClientResolvedConfig> {
71
78
  readonly input: ListDatasetLabelsCommandInput;
72
79
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
80
+ /**
81
+ * @public
82
+ */
73
83
  constructor(input: ListDatasetLabelsCommandInput);
74
84
  /**
75
85
  * @internal
76
86
  */
77
87
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput>;
88
+ /**
89
+ * @internal
90
+ */
78
91
  private serialize;
92
+ /**
93
+ * @internal
94
+ */
79
95
  private deserialize;
80
96
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListFacesRequest, ListFacesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListFacesCommand}.
8
10
  */
9
11
  export interface ListFacesCommandInput extends ListFacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListFacesCommand}.
13
17
  */
14
18
  export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns metadata for faces in the specified collection. This metadata
18
23
  * includes information such as the bounding box coordinates, the confidence (that the bounding
19
24
  * box contains a face), and face ID. For an example, see Listing Faces in a Collection in the
@@ -30,6 +35,8 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListFacesCommandInput - {@link ListFacesCommandInput}
39
+ * @returns {@link ListFacesCommandOutput}
33
40
  * @see {@link ListFacesCommandInput} for command's `input` shape.
34
41
  * @see {@link ListFacesCommandOutput} for command's `response` shape.
35
42
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -201,11 +208,20 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
201
208
  export declare class ListFacesCommand extends $Command<ListFacesCommandInput, ListFacesCommandOutput, RekognitionClientResolvedConfig> {
202
209
  readonly input: ListFacesCommandInput;
203
210
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
211
+ /**
212
+ * @public
213
+ */
204
214
  constructor(input: ListFacesCommandInput);
205
215
  /**
206
216
  * @internal
207
217
  */
208
218
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListFacesCommandInput, ListFacesCommandOutput>;
219
+ /**
220
+ * @internal
221
+ */
209
222
  private serialize;
223
+ /**
224
+ * @internal
225
+ */
210
226
  private deserialize;
211
227
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListProjectPoliciesRequest, ListProjectPoliciesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListProjectPoliciesCommand}.
8
10
  */
9
11
  export interface ListProjectPoliciesCommandInput extends ListProjectPoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListProjectPoliciesCommand}.
13
17
  */
14
18
  export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of the project policies attached to a project.</p>
18
23
  * <p>To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListProjectPoliciesCommandInput - {@link ListProjectPoliciesCommandInput}
35
+ * @returns {@link ListProjectPoliciesCommandOutput}
29
36
  * @see {@link ListProjectPoliciesCommandInput} for command's `input` shape.
30
37
  * @see {@link ListProjectPoliciesCommandOutput} for command's `response` shape.
31
38
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -86,11 +93,20 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
86
93
  export declare class ListProjectPoliciesCommand extends $Command<ListProjectPoliciesCommandInput, ListProjectPoliciesCommandOutput, RekognitionClientResolvedConfig> {
87
94
  readonly input: ListProjectPoliciesCommandInput;
88
95
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
96
+ /**
97
+ * @public
98
+ */
89
99
  constructor(input: ListProjectPoliciesCommandInput);
90
100
  /**
91
101
  * @internal
92
102
  */
93
103
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListProjectPoliciesCommandInput, ListProjectPoliciesCommandOutput>;
104
+ /**
105
+ * @internal
106
+ */
94
107
  private serialize;
108
+ /**
109
+ * @internal
110
+ */
95
111
  private deserialize;
96
112
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListStreamProcessorsRequest, ListStreamProcessorsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListStreamProcessorsCommand}.
8
10
  */
9
11
  export interface ListStreamProcessorsCommandInput extends ListStreamProcessorsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListStreamProcessorsCommand}.
13
17
  */
14
18
  export interface ListStreamProcessorsCommandOutput extends ListStreamProcessorsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListStreamProcessorsCommandOutput extends ListStreamProcessorsR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListStreamProcessorsCommandInput - {@link ListStreamProcessorsCommandInput}
34
+ * @returns {@link ListStreamProcessorsCommandOutput}
28
35
  * @see {@link ListStreamProcessorsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListStreamProcessorsCommandOutput} for command's `response` shape.
30
37
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -54,11 +61,20 @@ export interface ListStreamProcessorsCommandOutput extends ListStreamProcessorsR
54
61
  export declare class ListStreamProcessorsCommand extends $Command<ListStreamProcessorsCommandInput, ListStreamProcessorsCommandOutput, RekognitionClientResolvedConfig> {
55
62
  readonly input: ListStreamProcessorsCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: ListStreamProcessorsCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamProcessorsCommandInput, ListStreamProcessorsCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels
18
23
  * model. </p>
19
24
  * <p>This operation requires permissions to perform the
@@ -28,6 +33,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
37
+ * @returns {@link ListTagsForResourceCommandOutput}
31
38
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
57
64
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, RekognitionClientResolvedConfig> {
58
65
  readonly input: ListTagsForResourceCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: ListTagsForResourceCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutProjectPolicyRequest, PutProjectPolicyResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutProjectPolicyCommand}.
8
10
  */
9
11
  export interface PutProjectPolicyCommandInput extends PutProjectPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutProjectPolicyCommand}.
13
17
  */
14
18
  export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A
18
23
  * project policy specifies that a trusted AWS account can copy a model version from a
19
24
  * trusting AWS account to a project in the trusted AWS account. To copy a model version you use
@@ -37,6 +42,8 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param PutProjectPolicyCommandInput - {@link PutProjectPolicyCommandInput}
46
+ * @returns {@link PutProjectPolicyCommandOutput}
40
47
  * @see {@link PutProjectPolicyCommandInput} for command's `input` shape.
41
48
  * @see {@link PutProjectPolicyCommandOutput} for command's `response` shape.
42
49
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -105,11 +112,20 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
105
112
  export declare class PutProjectPolicyCommand extends $Command<PutProjectPolicyCommandInput, PutProjectPolicyCommandOutput, RekognitionClientResolvedConfig> {
106
113
  readonly input: PutProjectPolicyCommandInput;
107
114
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
115
+ /**
116
+ * @public
117
+ */
108
118
  constructor(input: PutProjectPolicyCommandInput);
109
119
  /**
110
120
  * @internal
111
121
  */
112
122
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutProjectPolicyCommandInput, PutProjectPolicyCommandOutput>;
123
+ /**
124
+ * @internal
125
+ */
113
126
  private serialize;
127
+ /**
128
+ * @internal
129
+ */
114
130
  private deserialize;
115
131
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RecognizeCelebritiesRequest, RecognizeCelebritiesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RecognizeCelebritiesCommand}.
8
10
  */
9
11
  export interface RecognizeCelebritiesCommandInput extends RecognizeCelebritiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RecognizeCelebritiesCommand}.
13
17
  */
14
18
  export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns an array of celebrities recognized in the input image. For more
18
23
  * information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. </p>
19
24
  * <p>
@@ -51,6 +56,8 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
51
56
  * const response = await client.send(command);
52
57
  * ```
53
58
  *
59
+ * @param RecognizeCelebritiesCommandInput - {@link RecognizeCelebritiesCommandInput}
60
+ * @returns {@link RecognizeCelebritiesCommandOutput}
54
61
  * @see {@link RecognizeCelebritiesCommandInput} for command's `input` shape.
55
62
  * @see {@link RecognizeCelebritiesCommandOutput} for command's `response` shape.
56
63
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -89,11 +96,20 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
89
96
  export declare class RecognizeCelebritiesCommand extends $Command<RecognizeCelebritiesCommandInput, RecognizeCelebritiesCommandOutput, RekognitionClientResolvedConfig> {
90
97
  readonly input: RecognizeCelebritiesCommandInput;
91
98
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
99
+ /**
100
+ * @public
101
+ */
92
102
  constructor(input: RecognizeCelebritiesCommandInput);
93
103
  /**
94
104
  * @internal
95
105
  */
96
106
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RecognizeCelebritiesCommandInput, RecognizeCelebritiesCommandOutput>;
107
+ /**
108
+ * @internal
109
+ */
97
110
  private serialize;
111
+ /**
112
+ * @internal
113
+ */
98
114
  private deserialize;
99
115
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SearchFacesByImageRequest, SearchFacesByImageResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchFacesByImageCommand}.
8
10
  */
9
11
  export interface SearchFacesByImageCommandInput extends SearchFacesByImageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchFacesByImageCommand}.
13
17
  */
14
18
  export interface SearchFacesByImageCommandOutput extends SearchFacesByImageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>For a given input image, first detects the largest face in the image, and then searches
18
23
  * the specified collection for matching faces. The operation compares the features of the input
19
24
  * face with faces in the specified collection. </p>
@@ -61,6 +66,8 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
61
66
  * const response = await client.send(command);
62
67
  * ```
63
68
  *
69
+ * @param SearchFacesByImageCommandInput - {@link SearchFacesByImageCommandInput}
70
+ * @returns {@link SearchFacesByImageCommandOutput}
64
71
  * @see {@link SearchFacesByImageCommandInput} for command's `input` shape.
65
72
  * @see {@link SearchFacesByImageCommandOutput} for command's `response` shape.
66
73
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -148,11 +155,20 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
148
155
  export declare class SearchFacesByImageCommand extends $Command<SearchFacesByImageCommandInput, SearchFacesByImageCommandOutput, RekognitionClientResolvedConfig> {
149
156
  readonly input: SearchFacesByImageCommandInput;
150
157
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
158
+ /**
159
+ * @public
160
+ */
151
161
  constructor(input: SearchFacesByImageCommandInput);
152
162
  /**
153
163
  * @internal
154
164
  */
155
165
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchFacesByImageCommandInput, SearchFacesByImageCommandOutput>;
166
+ /**
167
+ * @internal
168
+ */
156
169
  private serialize;
170
+ /**
171
+ * @internal
172
+ */
157
173
  private deserialize;
158
174
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SearchFacesRequest, SearchFacesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchFacesCommand}.
8
10
  */
9
11
  export interface SearchFacesCommandInput extends SearchFacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchFacesCommand}.
13
17
  */
14
18
  export interface SearchFacesCommandOutput extends SearchFacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>For a given input face ID, searches for matching faces in the collection the face
18
23
  * 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
19
24
  * faces in the specified collection. </p>
@@ -40,6 +45,8 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
40
45
  * const response = await client.send(command);
41
46
  * ```
42
47
  *
48
+ * @param SearchFacesCommandInput - {@link SearchFacesCommandInput}
49
+ * @returns {@link SearchFacesCommandOutput}
43
50
  * @see {@link SearchFacesCommandInput} for command's `input` shape.
44
51
  * @see {@link SearchFacesCommandOutput} for command's `response` shape.
45
52
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -132,11 +139,20 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
132
139
  export declare class SearchFacesCommand extends $Command<SearchFacesCommandInput, SearchFacesCommandOutput, RekognitionClientResolvedConfig> {
133
140
  readonly input: SearchFacesCommandInput;
134
141
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
142
+ /**
143
+ * @public
144
+ */
135
145
  constructor(input: SearchFacesCommandInput);
136
146
  /**
137
147
  * @internal
138
148
  */
139
149
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchFacesCommandInput, SearchFacesCommandOutput>;
150
+ /**
151
+ * @internal
152
+ */
140
153
  private serialize;
154
+ /**
155
+ * @internal
156
+ */
141
157
  private deserialize;
142
158
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartCelebrityRecognitionRequest, StartCelebrityRecognitionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartCelebrityRecognitionCommand}.
8
10
  */
9
11
  export interface StartCelebrityRecognitionCommandInput extends StartCelebrityRecognitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartCelebrityRecognitionCommand}.
13
17
  */
14
18
  export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRecognitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts asynchronous recognition of celebrities in a stored video.</p>
18
23
  * <p>Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
19
24
  * and the filename of the video.
@@ -35,6 +40,8 @@ export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRe
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param StartCelebrityRecognitionCommandInput - {@link StartCelebrityRecognitionCommandInput}
44
+ * @returns {@link StartCelebrityRecognitionCommandOutput}
38
45
  * @see {@link StartCelebrityRecognitionCommandInput} for command's `input` shape.
39
46
  * @see {@link StartCelebrityRecognitionCommandOutput} for command's `response` shape.
40
47
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -77,11 +84,20 @@ export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRe
77
84
  export declare class StartCelebrityRecognitionCommand extends $Command<StartCelebrityRecognitionCommandInput, StartCelebrityRecognitionCommandOutput, RekognitionClientResolvedConfig> {
78
85
  readonly input: StartCelebrityRecognitionCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: StartCelebrityRecognitionCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCelebrityRecognitionCommandInput, StartCelebrityRecognitionCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }