@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 { DeleteProjectVersionRequest, DeleteProjectVersionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProjectVersionCommand}.
8
10
  */
9
11
  export interface DeleteProjectVersionCommandInput extends DeleteProjectVersionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProjectVersionCommand}.
13
17
  */
14
18
  export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an Amazon Rekognition Custom Labels model. </p>
18
23
  * <p>You can't delete a model if it is running or if it is training.
19
24
  * To check the status of a model, use the <code>Status</code> field returned
@@ -32,6 +37,8 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DeleteProjectVersionCommandInput - {@link DeleteProjectVersionCommandInput}
41
+ * @returns {@link DeleteProjectVersionCommandOutput}
35
42
  * @see {@link DeleteProjectVersionCommandInput} for command's `input` shape.
36
43
  * @see {@link DeleteProjectVersionCommandOutput} for command's `response` shape.
37
44
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
64
71
  export declare class DeleteProjectVersionCommand extends $Command<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
65
72
  readonly input: DeleteProjectVersionCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DeleteProjectVersionCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteStreamProcessorRequest, DeleteStreamProcessorResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteStreamProcessorCommand}.
8
10
  */
9
11
  export interface DeleteStreamProcessorCommandInput extends DeleteStreamProcessorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteStreamProcessorCommand}.
13
17
  */
14
18
  export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcessorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with
18
23
  * <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteStreamProcessorCommandInput - {@link DeleteStreamProcessorCommandInput}
35
+ * @returns {@link DeleteStreamProcessorCommandOutput}
29
36
  * @see {@link DeleteStreamProcessorCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteStreamProcessorCommandOutput} for command's `response` shape.
31
38
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso
58
65
  export declare class DeleteStreamProcessorCommand extends $Command<DeleteStreamProcessorCommandInput, DeleteStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
59
66
  readonly input: DeleteStreamProcessorCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DeleteStreamProcessorCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStreamProcessorCommandInput, DeleteStreamProcessorCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeCollectionRequest, DescribeCollectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCollectionCommand}.
8
10
  */
9
11
  export interface DescribeCollectionCommandInput extends DescribeCollectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCollectionCommand}.
13
17
  */
14
18
  export interface DescribeCollectionCommandOutput extends DescribeCollectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
18
23
  * information, such as the number of faces indexed into a collection and the version of the
19
24
  * model used by the collection for face detection.</p>
@@ -29,6 +34,8 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeCollectionCommandInput - {@link DescribeCollectionCommandInput}
38
+ * @returns {@link DescribeCollectionCommandOutput}
32
39
  * @see {@link DescribeCollectionCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeCollectionCommandOutput} for command's `response` shape.
34
41
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
58
65
  export declare class DescribeCollectionCommand extends $Command<DescribeCollectionCommandInput, DescribeCollectionCommandOutput, RekognitionClientResolvedConfig> {
59
66
  readonly input: DescribeCollectionCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DescribeCollectionCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCollectionCommandInput, DescribeCollectionCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDatasetRequest, DescribeDatasetResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDatasetCommand}.
8
10
  */
9
11
  export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDatasetCommand}.
13
17
  */
14
18
  export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and
19
24
  * statistics about the images and labels in a dataset.
@@ -29,6 +34,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
38
+ * @returns {@link DescribeDatasetCommandOutput}
32
39
  * @see {@link DescribeDatasetCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeDatasetCommandOutput} for command's `response` shape.
34
41
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
58
65
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, RekognitionClientResolvedConfig> {
59
66
  readonly input: DescribeDatasetCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DescribeDatasetCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatasetCommandInput, DescribeDatasetCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeProjectVersionsRequest, DescribeProjectVersionsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeProjectVersionsCommand}.
8
10
  */
9
11
  export interface DescribeProjectVersionsCommandInput extends DescribeProjectVersionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeProjectVersionsCommand}.
13
17
  */
14
18
  export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVersionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You
18
23
  * can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
19
24
  * you don't specify a value, descriptions for all model versions in the project are returned.</p>
@@ -29,6 +34,8 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeProjectVersionsCommandInput - {@link DescribeProjectVersionsCommandInput}
38
+ * @returns {@link DescribeProjectVersionsCommandOutput}
32
39
  * @see {@link DescribeProjectVersionsCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeProjectVersionsCommandOutput} for command's `response` shape.
34
41
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
61
68
  export declare class DescribeProjectVersionsCommand extends $Command<DescribeProjectVersionsCommandInput, DescribeProjectVersionsCommandOutput, RekognitionClientResolvedConfig> {
62
69
  readonly input: DescribeProjectVersionsCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeProjectVersionsCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeProjectVersionsCommandInput, DescribeProjectVersionsCommandOutput>;
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 { DescribeProjectsRequest, DescribeProjectsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeProjectsCommand}.
8
10
  */
9
11
  export interface DescribeProjectsCommandInput extends DescribeProjectsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeProjectsCommand}.
13
17
  */
14
18
  export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about your Amazon Rekognition Custom Labels projects. </p>
18
23
  * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeProjectsCommandInput - {@link DescribeProjectsCommandInput}
35
+ * @returns {@link DescribeProjectsCommandOutput}
29
36
  * @see {@link DescribeProjectsCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeProjectsCommandOutput} for command's `response` shape.
31
38
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -55,11 +62,20 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
55
62
  export declare class DescribeProjectsCommand extends $Command<DescribeProjectsCommandInput, DescribeProjectsCommandOutput, RekognitionClientResolvedConfig> {
56
63
  readonly input: DescribeProjectsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: DescribeProjectsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeProjectsCommandInput, DescribeProjectsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeStreamProcessorRequest, DescribeStreamProcessorResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeStreamProcessorCommand}.
8
10
  */
9
11
  export interface DescribeStreamProcessorCommandInput extends DescribeStreamProcessorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeStreamProcessorCommand}.
13
17
  */
14
18
  export interface DescribeStreamProcessorCommandOutput extends DescribeStreamProcessorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides information about a stream processor created by <a>CreateStreamProcessor</a>. You can get information about the input and output streams, the input parameters for the face recognition being performed,
18
23
  * and the current status of the stream processor.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeStreamProcessorCommandOutput extends DescribeStreamProc
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeStreamProcessorCommandInput - {@link DescribeStreamProcessorCommandInput}
35
+ * @returns {@link DescribeStreamProcessorCommandOutput}
29
36
  * @see {@link DescribeStreamProcessorCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeStreamProcessorCommandOutput} for command's `response` shape.
31
38
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -55,11 +62,20 @@ export interface DescribeStreamProcessorCommandOutput extends DescribeStreamProc
55
62
  export declare class DescribeStreamProcessorCommand extends $Command<DescribeStreamProcessorCommandInput, DescribeStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
56
63
  readonly input: DescribeStreamProcessorCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: DescribeStreamProcessorCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStreamProcessorCommandInput, DescribeStreamProcessorCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DetectCustomLabelsRequest, DetectCustomLabelsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectCustomLabelsCommand}.
8
10
  */
9
11
  export interface DetectCustomLabelsCommandInput extends DetectCustomLabelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectCustomLabelsCommand}.
13
17
  */
14
18
  export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
18
23
  * <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input
19
24
  * parameter. </p>
@@ -56,6 +61,8 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
56
61
  * const response = await client.send(command);
57
62
  * ```
58
63
  *
64
+ * @param DetectCustomLabelsCommandInput - {@link DetectCustomLabelsCommandInput}
65
+ * @returns {@link DetectCustomLabelsCommandOutput}
59
66
  * @see {@link DetectCustomLabelsCommandInput} for command's `input` shape.
60
67
  * @see {@link DetectCustomLabelsCommandOutput} for command's `response` shape.
61
68
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -107,11 +114,20 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
107
114
  export declare class DetectCustomLabelsCommand extends $Command<DetectCustomLabelsCommandInput, DetectCustomLabelsCommandOutput, RekognitionClientResolvedConfig> {
108
115
  readonly input: DetectCustomLabelsCommandInput;
109
116
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
117
+ /**
118
+ * @public
119
+ */
110
120
  constructor(input: DetectCustomLabelsCommandInput);
111
121
  /**
112
122
  * @internal
113
123
  */
114
124
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectCustomLabelsCommandInput, DetectCustomLabelsCommandOutput>;
125
+ /**
126
+ * @internal
127
+ */
115
128
  private serialize;
129
+ /**
130
+ * @internal
131
+ */
116
132
  private deserialize;
117
133
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DetectFacesRequest, DetectFacesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectFacesCommand}.
8
10
  */
9
11
  export interface DetectFacesCommandInput extends DetectFacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectFacesCommand}.
13
17
  */
14
18
  export interface DetectFacesCommandOutput extends DetectFacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects faces within an image that is provided as input.</p>
18
23
  * <p>
19
24
  * <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
@@ -43,6 +48,8 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param DetectFacesCommandInput - {@link DetectFacesCommandInput}
52
+ * @returns {@link DetectFacesCommandOutput}
46
53
  * @see {@link DetectFacesCommandInput} for command's `input` shape.
47
54
  * @see {@link DetectFacesCommandOutput} for command's `response` shape.
48
55
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -149,11 +156,20 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat
149
156
  export declare class DetectFacesCommand extends $Command<DetectFacesCommandInput, DetectFacesCommandOutput, RekognitionClientResolvedConfig> {
150
157
  readonly input: DetectFacesCommandInput;
151
158
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
159
+ /**
160
+ * @public
161
+ */
152
162
  constructor(input: DetectFacesCommandInput);
153
163
  /**
154
164
  * @internal
155
165
  */
156
166
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectFacesCommandInput, DetectFacesCommandOutput>;
167
+ /**
168
+ * @internal
169
+ */
157
170
  private serialize;
171
+ /**
172
+ * @internal
173
+ */
158
174
  private deserialize;
159
175
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DetectLabelsRequest, DetectLabelsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectLabelsCommand}.
8
10
  */
9
11
  export interface DetectLabelsCommandInput extends DetectLabelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectLabelsCommand}.
13
17
  */
14
18
  export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
18
23
  * input. This includes objects like flower, tree, and table; events like wedding, graduation,
19
24
  * and birthday party; and concepts like landscape, evening, and nature. </p>
@@ -97,25 +102,25 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
97
102
  * a lighthouse, the sea, and a rock. The response includes all three labels, one for each
98
103
  * object, as well as the confidence in the label:</p>
99
104
  * <p>
100
- * <code>{Name: lighthouse, Confidence: 98.4629}</code>
105
+ * <code>\{Name: lighthouse, Confidence: 98.4629\}</code>
101
106
  * </p>
102
107
  * <p>
103
- * <code>{Name: rock,Confidence: 79.2097}</code>
108
+ * <code>\{Name: rock,Confidence: 79.2097\}</code>
104
109
  * </p>
105
110
  * <p>
106
- * <code> {Name: sea,Confidence: 75.061}</code>
111
+ * <code> \{Name: sea,Confidence: 75.061\}</code>
107
112
  * </p>
108
113
  * <p>The list of labels can include multiple labels for the same object. For example, if the
109
114
  * input image shows a flower (for example, a tulip), the operation might return the following
110
115
  * three labels. </p>
111
116
  * <p>
112
- * <code>{Name: flower,Confidence: 99.0562}</code>
117
+ * <code>\{Name: flower,Confidence: 99.0562\}</code>
113
118
  * </p>
114
119
  * <p>
115
- * <code>{Name: plant,Confidence: 99.0562}</code>
120
+ * <code>\{Name: plant,Confidence: 99.0562\}</code>
116
121
  * </p>
117
122
  * <p>
118
- * <code>{Name: tulip,Confidence: 99.0562}</code>
123
+ * <code>\{Name: tulip,Confidence: 99.0562\}</code>
119
124
  * </p>
120
125
  * <p>In this example, the detection algorithm more precisely identifies the flower as a
121
126
  * tulip.</p>
@@ -137,6 +142,8 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
137
142
  * const response = await client.send(command);
138
143
  * ```
139
144
  *
145
+ * @param DetectLabelsCommandInput - {@link DetectLabelsCommandInput}
146
+ * @returns {@link DetectLabelsCommandOutput}
140
147
  * @see {@link DetectLabelsCommandInput} for command's `input` shape.
141
148
  * @see {@link DetectLabelsCommandOutput} for command's `response` shape.
142
149
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -207,11 +214,20 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
207
214
  export declare class DetectLabelsCommand extends $Command<DetectLabelsCommandInput, DetectLabelsCommandOutput, RekognitionClientResolvedConfig> {
208
215
  readonly input: DetectLabelsCommandInput;
209
216
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
217
+ /**
218
+ * @public
219
+ */
210
220
  constructor(input: DetectLabelsCommandInput);
211
221
  /**
212
222
  * @internal
213
223
  */
214
224
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectLabelsCommandInput, DetectLabelsCommandOutput>;
225
+ /**
226
+ * @internal
227
+ */
215
228
  private serialize;
229
+ /**
230
+ * @internal
231
+ */
216
232
  private deserialize;
217
233
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DetectModerationLabelsRequest, DetectModerationLabelsResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectModerationLabelsCommand}.
8
10
  */
9
11
  export interface DetectModerationLabelsCommandInput extends DetectModerationLabelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectModerationLabelsCommand}.
13
17
  */
14
18
  export interface DetectModerationLabelsCommandOutput extends DetectModerationLabelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects unsafe content in a specified JPEG or PNG format image. Use
18
23
  * <code>DetectModerationLabels</code> to moderate images depending on your requirements. For
19
24
  * example, you might want to filter images that contain nudity, but not images containing
@@ -37,6 +42,8 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param DetectModerationLabelsCommandInput - {@link DetectModerationLabelsCommandInput}
46
+ * @returns {@link DetectModerationLabelsCommandOutput}
40
47
  * @see {@link DetectModerationLabelsCommandInput} for command's `input` shape.
41
48
  * @see {@link DetectModerationLabelsCommandOutput} for command's `response` shape.
42
49
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -78,11 +85,20 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
78
85
  export declare class DetectModerationLabelsCommand extends $Command<DetectModerationLabelsCommandInput, DetectModerationLabelsCommandOutput, RekognitionClientResolvedConfig> {
79
86
  readonly input: DetectModerationLabelsCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: DetectModerationLabelsCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectModerationLabelsCommandInput, DetectModerationLabelsCommandOutput>;
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 { DetectProtectiveEquipmentRequest, DetectProtectiveEquipmentResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectProtectiveEquipmentCommand}.
8
10
  */
9
11
  export interface DetectProtectiveEquipmentCommandInput extends DetectProtectiveEquipmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectProtectiveEquipmentCommand}.
13
17
  */
14
18
  export interface DetectProtectiveEquipmentCommandOutput extends DetectProtectiveEquipmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the
18
23
  * following types of PPE.</p>
19
24
  * <ul>
@@ -61,6 +66,8 @@ export interface DetectProtectiveEquipmentCommandOutput extends DetectProtective
61
66
  * const response = await client.send(command);
62
67
  * ```
63
68
  *
69
+ * @param DetectProtectiveEquipmentCommandInput - {@link DetectProtectiveEquipmentCommandInput}
70
+ * @returns {@link DetectProtectiveEquipmentCommandOutput}
64
71
  * @see {@link DetectProtectiveEquipmentCommandInput} for command's `input` shape.
65
72
  * @see {@link DetectProtectiveEquipmentCommandOutput} for command's `response` shape.
66
73
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -99,11 +106,20 @@ export interface DetectProtectiveEquipmentCommandOutput extends DetectProtective
99
106
  export declare class DetectProtectiveEquipmentCommand extends $Command<DetectProtectiveEquipmentCommandInput, DetectProtectiveEquipmentCommandOutput, RekognitionClientResolvedConfig> {
100
107
  readonly input: DetectProtectiveEquipmentCommandInput;
101
108
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
102
112
  constructor(input: DetectProtectiveEquipmentCommandInput);
103
113
  /**
104
114
  * @internal
105
115
  */
106
116
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectProtectiveEquipmentCommandInput, DetectProtectiveEquipmentCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
107
120
  private serialize;
121
+ /**
122
+ * @internal
123
+ */
108
124
  private deserialize;
109
125
  }