@aws-sdk/client-rekognition 3.296.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 +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CompareFacesRequest, CompareFacesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CompareFacesCommand}.
8
10
  */
9
11
  export interface CompareFacesCommandInput extends CompareFacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CompareFacesCommand}.
13
17
  */
14
18
  export interface CompareFacesCommandOutput extends CompareFacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Compares a face in the <i>source</i> input image with each of the 100
18
23
  * largest faces detected in the <i>target</i> input image. </p>
19
24
  * <p> If the source image contains multiple faces, the service detects the largest face and
@@ -75,6 +80,8 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
75
80
  * const response = await client.send(command);
76
81
  * ```
77
82
  *
83
+ * @param CompareFacesCommandInput - {@link CompareFacesCommandInput}
84
+ * @returns {@link CompareFacesCommandOutput}
78
85
  * @see {@link CompareFacesCommandInput} for command's `input` shape.
79
86
  * @see {@link CompareFacesCommandOutput} for command's `response` shape.
80
87
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -163,11 +170,20 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
163
170
  export declare class CompareFacesCommand extends $Command<CompareFacesCommandInput, CompareFacesCommandOutput, RekognitionClientResolvedConfig> {
164
171
  readonly input: CompareFacesCommandInput;
165
172
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
173
+ /**
174
+ * @public
175
+ */
166
176
  constructor(input: CompareFacesCommandInput);
167
177
  /**
168
178
  * @internal
169
179
  */
170
180
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CompareFacesCommandInput, CompareFacesCommandOutput>;
181
+ /**
182
+ * @internal
183
+ */
171
184
  private serialize;
185
+ /**
186
+ * @internal
187
+ */
172
188
  private deserialize;
173
189
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CopyProjectVersionRequest, CopyProjectVersionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CopyProjectVersionCommand}.
8
10
  */
9
11
  export interface CopyProjectVersionCommandInput extends CopyProjectVersionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CopyProjectVersionCommand}.
13
17
  */
14
18
  export interface CopyProjectVersionCommandOutput extends CopyProjectVersionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and
18
23
  * destination projects can be in different AWS accounts but must be in the same AWS Region.
19
24
  * You can't copy a model to another AWS service.
@@ -43,6 +48,8 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param CopyProjectVersionCommandInput - {@link CopyProjectVersionCommandInput}
52
+ * @returns {@link CopyProjectVersionCommandOutput}
46
53
  * @see {@link CopyProjectVersionCommandInput} for command's `input` shape.
47
54
  * @see {@link CopyProjectVersionCommandOutput} for command's `response` shape.
48
55
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -112,11 +119,20 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
112
119
  export declare class CopyProjectVersionCommand extends $Command<CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
113
120
  readonly input: CopyProjectVersionCommandInput;
114
121
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
122
+ /**
123
+ * @public
124
+ */
115
125
  constructor(input: CopyProjectVersionCommandInput);
116
126
  /**
117
127
  * @internal
118
128
  */
119
129
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput>;
130
+ /**
131
+ * @internal
132
+ */
120
133
  private serialize;
134
+ /**
135
+ * @internal
136
+ */
121
137
  private deserialize;
122
138
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateCollectionRequest, CreateCollectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCollectionCommand}.
8
10
  */
9
11
  export interface CreateCollectionCommandInput extends CreateCollectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCollectionCommand}.
13
17
  */
14
18
  export interface CreateCollectionCommandOutput extends CreateCollectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a collection in an AWS Region. You can add faces to the collection using the
18
23
  * <a>IndexFaces</a> operation. </p>
19
24
  * <p>For example, you might create collections, one for each of your application users. A
@@ -39,6 +44,8 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param CreateCollectionCommandInput - {@link CreateCollectionCommandInput}
48
+ * @returns {@link CreateCollectionCommandOutput}
42
49
  * @see {@link CreateCollectionCommandInput} for command's `input` shape.
43
50
  * @see {@link CreateCollectionCommandOutput} for command's `response` shape.
44
51
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -90,11 +97,20 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
90
97
  export declare class CreateCollectionCommand extends $Command<CreateCollectionCommandInput, CreateCollectionCommandOutput, RekognitionClientResolvedConfig> {
91
98
  readonly input: CreateCollectionCommandInput;
92
99
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
100
+ /**
101
+ * @public
102
+ */
93
103
  constructor(input: CreateCollectionCommandInput);
94
104
  /**
95
105
  * @internal
96
106
  */
97
107
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCollectionCommandInput, CreateCollectionCommandOutput>;
108
+ /**
109
+ * @internal
110
+ */
98
111
  private serialize;
112
+ /**
113
+ * @internal
114
+ */
99
115
  private deserialize;
100
116
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateDatasetRequest, CreateDatasetResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDatasetCommand}.
8
10
  */
9
11
  export interface CreateDatasetCommandInput extends CreateDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDatasetCommand}.
13
17
  */
14
18
  export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
18
23
  * an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
19
24
  * <p>To create a training dataset for a project, specify <code>train</code> for the value of
@@ -43,6 +48,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
52
+ * @returns {@link CreateDatasetCommandOutput}
46
53
  * @see {@link CreateDatasetCommandInput} for command's `input` shape.
47
54
  * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
48
55
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -83,11 +90,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
83
90
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, RekognitionClientResolvedConfig> {
84
91
  readonly input: CreateDatasetCommandInput;
85
92
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
93
+ /**
94
+ * @public
95
+ */
86
96
  constructor(input: CreateDatasetCommandInput);
87
97
  /**
88
98
  * @internal
89
99
  */
90
100
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetCommandInput, CreateDatasetCommandOutput>;
101
+ /**
102
+ * @internal
103
+ */
91
104
  private serialize;
105
+ /**
106
+ * @internal
107
+ */
92
108
  private deserialize;
93
109
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateProjectRequest, CreateProjectResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProjectCommand}.
8
10
  */
9
11
  export interface CreateProjectCommandInput extends CreateProjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProjectCommand}.
13
17
  */
14
18
  export interface CreateProjectCommandOutput extends CreateProjectResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions)
18
23
  * that you use to create and manage Amazon Rekognition Custom Labels models. </p>
19
24
  * <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>
@@ -27,6 +32,8 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateProjectCommandInput - {@link CreateProjectCommandInput}
36
+ * @returns {@link CreateProjectCommandOutput}
30
37
  * @see {@link CreateProjectCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateProjectCommandOutput} for command's `response` shape.
32
39
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
61
68
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, RekognitionClientResolvedConfig> {
62
69
  readonly input: CreateProjectCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: CreateProjectCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProjectCommandInput, CreateProjectCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateProjectVersionRequest, CreateProjectVersionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProjectVersionCommand}.
8
10
  */
9
11
  export interface CreateProjectVersionCommandInput extends CreateProjectVersionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProjectVersionCommand}.
13
17
  */
14
18
  export interface CreateProjectVersionCommandOutput extends CreateProjectVersionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new version of a model and begins training.
18
23
  * Models are managed as part of an Amazon Rekognition Custom Labels project.
19
24
  * The response from <code>CreateProjectVersion</code>
@@ -54,6 +59,8 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
54
59
  * const response = await client.send(command);
55
60
  * ```
56
61
  *
62
+ * @param CreateProjectVersionCommandInput - {@link CreateProjectVersionCommandInput}
63
+ * @returns {@link CreateProjectVersionCommandOutput}
57
64
  * @see {@link CreateProjectVersionCommandInput} for command's `input` shape.
58
65
  * @see {@link CreateProjectVersionCommandOutput} for command's `response` shape.
59
66
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -96,11 +103,20 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
96
103
  export declare class CreateProjectVersionCommand extends $Command<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
97
104
  readonly input: CreateProjectVersionCommandInput;
98
105
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
106
+ /**
107
+ * @public
108
+ */
99
109
  constructor(input: CreateProjectVersionCommandInput);
100
110
  /**
101
111
  * @internal
102
112
  */
103
113
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput>;
114
+ /**
115
+ * @internal
116
+ */
104
117
  private serialize;
118
+ /**
119
+ * @internal
120
+ */
105
121
  private deserialize;
106
122
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateStreamProcessorRequest, CreateStreamProcessorResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateStreamProcessorCommand}.
8
10
  */
9
11
  export interface CreateStreamProcessorCommandInput extends CreateStreamProcessorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateStreamProcessorCommand}.
13
17
  */
14
18
  export interface CreateStreamProcessorCommandOutput extends CreateStreamProcessorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.</p>
18
23
  * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
19
24
  * <ul>
@@ -45,6 +50,8 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param CreateStreamProcessorCommandInput - {@link CreateStreamProcessorCommandInput}
54
+ * @returns {@link CreateStreamProcessorCommandOutput}
48
55
  * @see {@link CreateStreamProcessorCommandInput} for command's `input` shape.
49
56
  * @see {@link CreateStreamProcessorCommandOutput} for command's `response` shape.
50
57
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -84,11 +91,20 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
84
91
  export declare class CreateStreamProcessorCommand extends $Command<CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
85
92
  readonly input: CreateStreamProcessorCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: CreateStreamProcessorCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteCollectionRequest, DeleteCollectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCollectionCommand}.
8
10
  */
9
11
  export interface DeleteCollectionCommandInput extends DeleteCollectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCollectionCommand}.
13
17
  */
14
18
  export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified collection. Note that this operation removes all faces in the
18
23
  * collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a
19
24
  * collection</a>.</p>
@@ -29,6 +34,8 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteCollectionCommandInput - {@link DeleteCollectionCommandInput}
38
+ * @returns {@link DeleteCollectionCommandOutput}
32
39
  * @see {@link DeleteCollectionCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteCollectionCommandOutput} for command's `response` shape.
34
41
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -74,11 +81,20 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
74
81
  export declare class DeleteCollectionCommand extends $Command<DeleteCollectionCommandInput, DeleteCollectionCommandOutput, RekognitionClientResolvedConfig> {
75
82
  readonly input: DeleteCollectionCommandInput;
76
83
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
84
+ /**
85
+ * @public
86
+ */
77
87
  constructor(input: DeleteCollectionCommandInput);
78
88
  /**
79
89
  * @internal
80
90
  */
81
91
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCollectionCommandInput, DeleteCollectionCommandOutput>;
92
+ /**
93
+ * @internal
94
+ */
82
95
  private serialize;
96
+ /**
97
+ * @internal
98
+ */
83
99
  private deserialize;
84
100
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteDatasetRequest, DeleteDatasetResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatasetCommand}.
8
10
  */
9
11
  export interface DeleteDatasetCommandInput extends DeleteDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatasetCommand}.
13
17
  */
14
18
  export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an existing Amazon Rekognition Custom Labels dataset.
18
23
  * Deleting a dataset might take while. Use <a>DescribeDataset</a> to check the
19
24
  * current status. The dataset is still deleting if the value of <code>Status</code> is
@@ -34,6 +39,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
43
+ * @returns {@link DeleteDatasetCommandOutput}
37
44
  * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
38
45
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
39
46
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -71,11 +78,20 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
71
78
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, RekognitionClientResolvedConfig> {
72
79
  readonly input: DeleteDatasetCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: DeleteDatasetCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetCommandInput, DeleteDatasetCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteFacesRequest, DeleteFacesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteFacesCommand}.
8
10
  */
9
11
  export interface DeleteFacesCommandInput extends DeleteFacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteFacesCommand}.
13
17
  */
14
18
  export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes faces from a collection. You specify a collection ID and an array of face IDs
18
23
  * to remove from the collection.</p>
19
24
  * <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>
@@ -28,6 +33,8 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteFacesCommandInput - {@link DeleteFacesCommandInput}
37
+ * @returns {@link DeleteFacesCommandOutput}
31
38
  * @see {@link DeleteFacesCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteFacesCommandOutput} for command's `response` shape.
33
40
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -78,11 +85,20 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
78
85
  export declare class DeleteFacesCommand extends $Command<DeleteFacesCommandInput, DeleteFacesCommandOutput, RekognitionClientResolvedConfig> {
79
86
  readonly input: DeleteFacesCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: DeleteFacesCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteFacesCommandInput, DeleteFacesCommandOutput>;
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 { DeleteProjectRequest, DeleteProjectResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProjectCommand}.
8
10
  */
9
11
  export interface DeleteProjectCommandInput extends DeleteProjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProjectCommand}.
13
17
  */
14
18
  export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
18
23
  * with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
19
24
  * <p>
@@ -33,6 +38,8 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DeleteProjectCommandInput - {@link DeleteProjectCommandInput}
42
+ * @returns {@link DeleteProjectCommandOutput}
36
43
  * @see {@link DeleteProjectCommandInput} for command's `input` shape.
37
44
  * @see {@link DeleteProjectCommandOutput} for command's `response` shape.
38
45
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -65,11 +72,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
65
72
  export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, RekognitionClientResolvedConfig> {
66
73
  readonly input: DeleteProjectCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: DeleteProjectCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProjectCommandInput, DeleteProjectCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteProjectPolicyRequest, DeleteProjectPolicyResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProjectPolicyCommand}.
8
10
  */
9
11
  export interface DeleteProjectPolicyCommandInput extends DeleteProjectPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProjectPolicyCommand}.
13
17
  */
14
18
  export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an existing project policy.</p>
18
23
  * <p>To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. To attach a project policy to a project, call <a>PutProjectPolicy</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteProjectPolicyCommandInput - {@link DeleteProjectPolicyCommandInput}
35
+ * @returns {@link DeleteProjectPolicyCommandOutput}
29
36
  * @see {@link DeleteProjectPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteProjectPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -71,11 +78,20 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
71
78
  export declare class DeleteProjectPolicyCommand extends $Command<DeleteProjectPolicyCommandInput, DeleteProjectPolicyCommandOutput, RekognitionClientResolvedConfig> {
72
79
  readonly input: DeleteProjectPolicyCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: DeleteProjectPolicyCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProjectPolicyCommandInput, DeleteProjectPolicyCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }