@aws-sdk/client-voice-id 3.298.0 → 3.300.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 (87) hide show
  1. package/README.md +73 -9
  2. package/dist-cjs/VoiceID.js +120 -0
  3. package/dist-cjs/commands/AssociateFraudsterCommand.js +46 -0
  4. package/dist-cjs/commands/CreateWatchlistCommand.js +46 -0
  5. package/dist-cjs/commands/DeleteWatchlistCommand.js +45 -0
  6. package/dist-cjs/commands/DescribeWatchlistCommand.js +46 -0
  7. package/dist-cjs/commands/DisassociateFraudsterCommand.js +46 -0
  8. package/dist-cjs/commands/ListFraudstersCommand.js +45 -0
  9. package/dist-cjs/commands/ListWatchlistsCommand.js +46 -0
  10. package/dist-cjs/commands/UpdateWatchlistCommand.js +46 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/endpoint/ruleset.js +3 -3
  13. package/dist-cjs/models/models_0.js +83 -24
  14. package/dist-cjs/pagination/ListFraudstersPaginator.js +29 -0
  15. package/dist-cjs/pagination/ListWatchlistsPaginator.js +29 -0
  16. package/dist-cjs/pagination/index.js +2 -0
  17. package/dist-cjs/protocols/Aws_json1_0.js +722 -29
  18. package/dist-es/VoiceID.js +120 -0
  19. package/dist-es/commands/AssociateFraudsterCommand.js +42 -0
  20. package/dist-es/commands/CreateWatchlistCommand.js +42 -0
  21. package/dist-es/commands/DeleteWatchlistCommand.js +41 -0
  22. package/dist-es/commands/DescribeWatchlistCommand.js +42 -0
  23. package/dist-es/commands/DisassociateFraudsterCommand.js +42 -0
  24. package/dist-es/commands/ListFraudstersCommand.js +41 -0
  25. package/dist-es/commands/ListWatchlistsCommand.js +42 -0
  26. package/dist-es/commands/UpdateWatchlistCommand.js +42 -0
  27. package/dist-es/commands/index.js +8 -0
  28. package/dist-es/endpoint/ruleset.js +3 -3
  29. package/dist-es/models/models_0.js +71 -22
  30. package/dist-es/pagination/ListFraudstersPaginator.js +25 -0
  31. package/dist-es/pagination/ListWatchlistsPaginator.js +25 -0
  32. package/dist-es/pagination/index.js +2 -0
  33. package/dist-es/protocols/Aws_json1_0.js +707 -31
  34. package/dist-types/VoiceID.d.ts +74 -4
  35. package/dist-types/VoiceIDClient.d.ts +12 -4
  36. package/dist-types/commands/AssociateFraudsterCommand.d.ts +93 -0
  37. package/dist-types/commands/CreateDomainCommand.d.ts +15 -1
  38. package/dist-types/commands/CreateWatchlistCommand.d.ts +94 -0
  39. package/dist-types/commands/DeleteDomainCommand.d.ts +3 -0
  40. package/dist-types/commands/DeleteFraudsterCommand.d.ts +5 -1
  41. package/dist-types/commands/DeleteSpeakerCommand.d.ts +4 -0
  42. package/dist-types/commands/DeleteWatchlistCommand.d.ts +91 -0
  43. package/dist-types/commands/DescribeDomainCommand.d.ts +3 -0
  44. package/dist-types/commands/DescribeFraudsterCommand.d.ts +4 -0
  45. package/dist-types/commands/DescribeFraudsterRegistrationJobCommand.d.ts +4 -0
  46. package/dist-types/commands/DescribeSpeakerCommand.d.ts +4 -0
  47. package/dist-types/commands/DescribeSpeakerEnrollmentJobCommand.d.ts +4 -0
  48. package/dist-types/commands/DescribeWatchlistCommand.d.ts +85 -0
  49. package/dist-types/commands/DisassociateFraudsterCommand.d.ts +93 -0
  50. package/dist-types/commands/EvaluateSessionCommand.d.ts +4 -0
  51. package/dist-types/commands/ListDomainsCommand.d.ts +4 -0
  52. package/dist-types/commands/ListFraudsterRegistrationJobsCommand.d.ts +6 -0
  53. package/dist-types/commands/ListFraudstersCommand.d.ts +87 -0
  54. package/dist-types/commands/ListSpeakerEnrollmentJobsCommand.d.ts +6 -0
  55. package/dist-types/commands/ListSpeakersCommand.d.ts +5 -0
  56. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  57. package/dist-types/commands/ListWatchlistsCommand.d.ts +86 -0
  58. package/dist-types/commands/OptOutSpeakerCommand.d.ts +4 -0
  59. package/dist-types/commands/StartFraudsterRegistrationJobCommand.d.ts +20 -0
  60. package/dist-types/commands/StartSpeakerEnrollmentJobCommand.d.ts +23 -0
  61. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  62. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  63. package/dist-types/commands/UpdateDomainCommand.d.ts +8 -0
  64. package/dist-types/commands/UpdateWatchlistCommand.d.ts +92 -0
  65. package/dist-types/commands/index.d.ts +8 -0
  66. package/dist-types/models/models_0.d.ts +621 -214
  67. package/dist-types/pagination/ListFraudstersPaginator.d.ts +7 -0
  68. package/dist-types/pagination/ListWatchlistsPaginator.d.ts +7 -0
  69. package/dist-types/pagination/index.d.ts +2 -0
  70. package/dist-types/protocols/Aws_json1_0.d.ts +24 -0
  71. package/dist-types/ts3.4/VoiceID.d.ts +136 -0
  72. package/dist-types/ts3.4/VoiceIDClient.d.ts +50 -2
  73. package/dist-types/ts3.4/commands/AssociateFraudsterCommand.d.ts +38 -0
  74. package/dist-types/ts3.4/commands/CreateWatchlistCommand.d.ts +37 -0
  75. package/dist-types/ts3.4/commands/DeleteWatchlistCommand.d.ts +32 -0
  76. package/dist-types/ts3.4/commands/DescribeWatchlistCommand.d.ts +38 -0
  77. package/dist-types/ts3.4/commands/DisassociateFraudsterCommand.d.ts +41 -0
  78. package/dist-types/ts3.4/commands/ListFraudstersCommand.d.ts +37 -0
  79. package/dist-types/ts3.4/commands/ListWatchlistsCommand.d.ts +37 -0
  80. package/dist-types/ts3.4/commands/UpdateWatchlistCommand.d.ts +37 -0
  81. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  82. package/dist-types/ts3.4/models/models_0.d.ts +197 -69
  83. package/dist-types/ts3.4/pagination/ListFraudstersPaginator.d.ts +11 -0
  84. package/dist-types/ts3.4/pagination/ListWatchlistsPaginator.d.ts +11 -0
  85. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  86. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
  87. package/package.json +12 -12
@@ -0,0 +1,85 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DescribeWatchlistRequest, DescribeWatchlistResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, VoiceIDClientResolvedConfig } from "../VoiceIDClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link DescribeWatchlistCommand}.
10
+ */
11
+ export interface DescribeWatchlistCommandInput extends DescribeWatchlistRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link DescribeWatchlistCommand}.
17
+ */
18
+ export interface DescribeWatchlistCommandOutput extends DescribeWatchlistResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Describes the specified watchlist.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { VoiceIDClient, DescribeWatchlistCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
+ * // const { VoiceIDClient, DescribeWatchlistCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
+ * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * DomainId: "STRING_VALUE", // required
31
+ * WatchlistId: "STRING_VALUE", // required
32
+ * };
33
+ * const command = new DescribeWatchlistCommand(input);
34
+ * const response = await client.send(command);
35
+ * ```
36
+ *
37
+ * @param DescribeWatchlistCommandInput - {@link DescribeWatchlistCommandInput}
38
+ * @returns {@link DescribeWatchlistCommandOutput}
39
+ * @see {@link DescribeWatchlistCommandInput} for command's `input` shape.
40
+ * @see {@link DescribeWatchlistCommandOutput} for command's `response` shape.
41
+ * @see {@link VoiceIDClientResolvedConfig | config} for VoiceIDClient's `config` shape.
42
+ *
43
+ * @throws {@link AccessDeniedException} (client fault)
44
+ * <p>You do not have sufficient permissions to perform this action. Check the error message
45
+ * and try again.</p>
46
+ *
47
+ * @throws {@link InternalServerException} (server fault)
48
+ * <p>The request failed due to an unknown error on the server side.</p>
49
+ *
50
+ * @throws {@link ResourceNotFoundException} (client fault)
51
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
52
+ * message for more details.</p>
53
+ *
54
+ * @throws {@link ThrottlingException} (client fault)
55
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
56
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
57
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
58
+ * request again.</p>
59
+ *
60
+ * @throws {@link ValidationException} (client fault)
61
+ * <p>The request failed one or more validations; check the error message for more
62
+ * details.</p>
63
+ *
64
+ *
65
+ */
66
+ export declare class DescribeWatchlistCommand extends $Command<DescribeWatchlistCommandInput, DescribeWatchlistCommandOutput, VoiceIDClientResolvedConfig> {
67
+ readonly input: DescribeWatchlistCommandInput;
68
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
72
+ constructor(input: DescribeWatchlistCommandInput);
73
+ /**
74
+ * @internal
75
+ */
76
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VoiceIDClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWatchlistCommandInput, DescribeWatchlistCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
80
+ private serialize;
81
+ /**
82
+ * @internal
83
+ */
84
+ private deserialize;
85
+ }
@@ -0,0 +1,93 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DisassociateFraudsterRequest, DisassociateFraudsterResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, VoiceIDClientResolvedConfig } from "../VoiceIDClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link DisassociateFraudsterCommand}.
10
+ */
11
+ export interface DisassociateFraudsterCommandInput extends DisassociateFraudsterRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link DisassociateFraudsterCommand}.
17
+ */
18
+ export interface DisassociateFraudsterCommandOutput extends DisassociateFraudsterResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Disassociates the fraudsters from the watchlist specified. Voice ID always expects a
23
+ * fraudster to be a part of at least one watchlist. If
24
+ * you try to disassociate a fraudster from its only watchlist, a <code>ValidationException</code> is thrown.
25
+ * </p>
26
+ * @example
27
+ * Use a bare-bones client and the command you need to make an API call.
28
+ * ```javascript
29
+ * import { VoiceIDClient, DisassociateFraudsterCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
30
+ * // const { VoiceIDClient, DisassociateFraudsterCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
31
+ * const client = new VoiceIDClient(config);
32
+ * const input = {
33
+ * DomainId: "STRING_VALUE", // required
34
+ * WatchlistId: "STRING_VALUE", // required
35
+ * FraudsterId: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new DisassociateFraudsterCommand(input);
38
+ * const response = await client.send(command);
39
+ * ```
40
+ *
41
+ * @param DisassociateFraudsterCommandInput - {@link DisassociateFraudsterCommandInput}
42
+ * @returns {@link DisassociateFraudsterCommandOutput}
43
+ * @see {@link DisassociateFraudsterCommandInput} for command's `input` shape.
44
+ * @see {@link DisassociateFraudsterCommandOutput} for command's `response` shape.
45
+ * @see {@link VoiceIDClientResolvedConfig | config} for VoiceIDClient's `config` shape.
46
+ *
47
+ * @throws {@link AccessDeniedException} (client fault)
48
+ * <p>You do not have sufficient permissions to perform this action. Check the error message
49
+ * and try again.</p>
50
+ *
51
+ * @throws {@link ConflictException} (client fault)
52
+ * <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error
53
+ * message for more details.</p>
54
+ *
55
+ * @throws {@link InternalServerException} (server fault)
56
+ * <p>The request failed due to an unknown error on the server side.</p>
57
+ *
58
+ * @throws {@link ResourceNotFoundException} (client fault)
59
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
60
+ * message for more details.</p>
61
+ *
62
+ * @throws {@link ThrottlingException} (client fault)
63
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
64
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
65
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
66
+ * request again.</p>
67
+ *
68
+ * @throws {@link ValidationException} (client fault)
69
+ * <p>The request failed one or more validations; check the error message for more
70
+ * details.</p>
71
+ *
72
+ *
73
+ */
74
+ export declare class DisassociateFraudsterCommand extends $Command<DisassociateFraudsterCommandInput, DisassociateFraudsterCommandOutput, VoiceIDClientResolvedConfig> {
75
+ readonly input: DisassociateFraudsterCommandInput;
76
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
80
+ constructor(input: DisassociateFraudsterCommandInput);
81
+ /**
82
+ * @internal
83
+ */
84
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VoiceIDClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateFraudsterCommandInput, DisassociateFraudsterCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
88
+ private serialize;
89
+ /**
90
+ * @internal
91
+ */
92
+ private deserialize;
93
+ }
@@ -27,6 +27,10 @@ export interface EvaluateSessionCommandOutput extends EvaluateSessionResponse, _
27
27
  * import { VoiceIDClient, EvaluateSessionCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
28
28
  * // const { VoiceIDClient, EvaluateSessionCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
29
29
  * const client = new VoiceIDClient(config);
30
+ * const input = {
31
+ * DomainId: "STRING_VALUE", // required
32
+ * SessionNameOrId: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new EvaluateSessionCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,10 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat
26
26
  * import { VoiceIDClient, ListDomainsCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, ListDomainsCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * MaxResults: Number("int"),
31
+ * NextToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new ListDomainsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -28,6 +28,12 @@ export interface ListFraudsterRegistrationJobsCommandOutput extends ListFraudste
28
28
  * import { VoiceIDClient, ListFraudsterRegistrationJobsCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
29
29
  * // const { VoiceIDClient, ListFraudsterRegistrationJobsCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
30
30
  * const client = new VoiceIDClient(config);
31
+ * const input = {
32
+ * DomainId: "STRING_VALUE", // required
33
+ * JobStatus: "STRING_VALUE",
34
+ * MaxResults: Number("int"),
35
+ * NextToken: "STRING_VALUE",
36
+ * };
31
37
  * const command = new ListFraudsterRegistrationJobsCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -0,0 +1,87 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ListFraudstersRequest, ListFraudstersResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, VoiceIDClientResolvedConfig } from "../VoiceIDClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link ListFraudstersCommand}.
10
+ */
11
+ export interface ListFraudstersCommandInput extends ListFraudstersRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link ListFraudstersCommand}.
17
+ */
18
+ export interface ListFraudstersCommandOutput extends ListFraudstersResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Lists all fraudsters in a specified watchlist or domain.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { VoiceIDClient, ListFraudstersCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
+ * // const { VoiceIDClient, ListFraudstersCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
+ * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * DomainId: "STRING_VALUE", // required
31
+ * WatchlistId: "STRING_VALUE",
32
+ * MaxResults: Number("int"),
33
+ * NextToken: "STRING_VALUE",
34
+ * };
35
+ * const command = new ListFraudstersCommand(input);
36
+ * const response = await client.send(command);
37
+ * ```
38
+ *
39
+ * @param ListFraudstersCommandInput - {@link ListFraudstersCommandInput}
40
+ * @returns {@link ListFraudstersCommandOutput}
41
+ * @see {@link ListFraudstersCommandInput} for command's `input` shape.
42
+ * @see {@link ListFraudstersCommandOutput} for command's `response` shape.
43
+ * @see {@link VoiceIDClientResolvedConfig | config} for VoiceIDClient's `config` shape.
44
+ *
45
+ * @throws {@link AccessDeniedException} (client fault)
46
+ * <p>You do not have sufficient permissions to perform this action. Check the error message
47
+ * and try again.</p>
48
+ *
49
+ * @throws {@link InternalServerException} (server fault)
50
+ * <p>The request failed due to an unknown error on the server side.</p>
51
+ *
52
+ * @throws {@link ResourceNotFoundException} (client fault)
53
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
54
+ * message for more details.</p>
55
+ *
56
+ * @throws {@link ThrottlingException} (client fault)
57
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
58
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
59
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
60
+ * request again.</p>
61
+ *
62
+ * @throws {@link ValidationException} (client fault)
63
+ * <p>The request failed one or more validations; check the error message for more
64
+ * details.</p>
65
+ *
66
+ *
67
+ */
68
+ export declare class ListFraudstersCommand extends $Command<ListFraudstersCommandInput, ListFraudstersCommandOutput, VoiceIDClientResolvedConfig> {
69
+ readonly input: ListFraudstersCommandInput;
70
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
74
+ constructor(input: ListFraudstersCommandInput);
75
+ /**
76
+ * @internal
77
+ */
78
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VoiceIDClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListFraudstersCommandInput, ListFraudstersCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
82
+ private serialize;
83
+ /**
84
+ * @internal
85
+ */
86
+ private deserialize;
87
+ }
@@ -28,6 +28,12 @@ export interface ListSpeakerEnrollmentJobsCommandOutput extends ListSpeakerEnrol
28
28
  * import { VoiceIDClient, ListSpeakerEnrollmentJobsCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
29
29
  * // const { VoiceIDClient, ListSpeakerEnrollmentJobsCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
30
30
  * const client = new VoiceIDClient(config);
31
+ * const input = {
32
+ * DomainId: "STRING_VALUE", // required
33
+ * JobStatus: "STRING_VALUE",
34
+ * MaxResults: Number("int"),
35
+ * NextToken: "STRING_VALUE",
36
+ * };
31
37
  * const command = new ListSpeakerEnrollmentJobsCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -26,6 +26,11 @@ export interface ListSpeakersCommandOutput extends ListSpeakersResponse, __Metad
26
26
  * import { VoiceIDClient, ListSpeakersCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, ListSpeakersCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * DomainId: "STRING_VALUE", // required
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListSpeakersCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
26
  * import { VoiceIDClient, ListTagsForResourceCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, ListTagsForResourceCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * ResourceArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new ListTagsForResourceCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -0,0 +1,86 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ListWatchlistsRequest, ListWatchlistsResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, VoiceIDClientResolvedConfig } from "../VoiceIDClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link ListWatchlistsCommand}.
10
+ */
11
+ export interface ListWatchlistsCommandInput extends ListWatchlistsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link ListWatchlistsCommand}.
17
+ */
18
+ export interface ListWatchlistsCommandOutput extends ListWatchlistsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Lists all watchlists in a specified domain.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { VoiceIDClient, ListWatchlistsCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
+ * // const { VoiceIDClient, ListWatchlistsCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
+ * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * DomainId: "STRING_VALUE", // required
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
34
+ * const command = new ListWatchlistsCommand(input);
35
+ * const response = await client.send(command);
36
+ * ```
37
+ *
38
+ * @param ListWatchlistsCommandInput - {@link ListWatchlistsCommandInput}
39
+ * @returns {@link ListWatchlistsCommandOutput}
40
+ * @see {@link ListWatchlistsCommandInput} for command's `input` shape.
41
+ * @see {@link ListWatchlistsCommandOutput} for command's `response` shape.
42
+ * @see {@link VoiceIDClientResolvedConfig | config} for VoiceIDClient's `config` shape.
43
+ *
44
+ * @throws {@link AccessDeniedException} (client fault)
45
+ * <p>You do not have sufficient permissions to perform this action. Check the error message
46
+ * and try again.</p>
47
+ *
48
+ * @throws {@link InternalServerException} (server fault)
49
+ * <p>The request failed due to an unknown error on the server side.</p>
50
+ *
51
+ * @throws {@link ResourceNotFoundException} (client fault)
52
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
53
+ * message for more details.</p>
54
+ *
55
+ * @throws {@link ThrottlingException} (client fault)
56
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
57
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
58
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
59
+ * request again.</p>
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ * <p>The request failed one or more validations; check the error message for more
63
+ * details.</p>
64
+ *
65
+ *
66
+ */
67
+ export declare class ListWatchlistsCommand extends $Command<ListWatchlistsCommandInput, ListWatchlistsCommandOutput, VoiceIDClientResolvedConfig> {
68
+ readonly input: ListWatchlistsCommandInput;
69
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
73
+ constructor(input: ListWatchlistsCommandInput);
74
+ /**
75
+ * @internal
76
+ */
77
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VoiceIDClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWatchlistsCommandInput, ListWatchlistsCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
81
+ private serialize;
82
+ /**
83
+ * @internal
84
+ */
85
+ private deserialize;
86
+ }
@@ -31,6 +31,10 @@ export interface OptOutSpeakerCommandOutput extends OptOutSpeakerResponse, __Met
31
31
  * import { VoiceIDClient, OptOutSpeakerCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
32
32
  * // const { VoiceIDClient, OptOutSpeakerCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
33
33
  * const client = new VoiceIDClient(config);
34
+ * const input = {
35
+ * DomainId: "STRING_VALUE", // required
36
+ * SpeakerId: "STRING_VALUE", // required
37
+ * };
34
38
  * const command = new OptOutSpeakerCommand(input);
35
39
  * const response = await client.send(command);
36
40
  * ```
@@ -26,6 +26,26 @@ export interface StartFraudsterRegistrationJobCommandOutput extends StartFraudst
26
26
  * import { VoiceIDClient, StartFraudsterRegistrationJobCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, StartFraudsterRegistrationJobCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * ClientToken: "STRING_VALUE",
31
+ * JobName: "STRING_VALUE",
32
+ * DomainId: "STRING_VALUE", // required
33
+ * DataAccessRoleArn: "STRING_VALUE", // required
34
+ * RegistrationConfig: {
35
+ * DuplicateRegistrationAction: "STRING_VALUE",
36
+ * FraudsterSimilarityThreshold: Number("int"),
37
+ * WatchlistIds: [
38
+ * "STRING_VALUE",
39
+ * ],
40
+ * },
41
+ * InputDataConfig: {
42
+ * S3Uri: "STRING_VALUE", // required
43
+ * },
44
+ * OutputDataConfig: {
45
+ * S3Uri: "STRING_VALUE", // required
46
+ * KmsKeyId: "STRING_VALUE",
47
+ * },
48
+ * };
29
49
  * const command = new StartFraudsterRegistrationJobCommand(input);
30
50
  * const response = await client.send(command);
31
51
  * ```
@@ -26,6 +26,29 @@ export interface StartSpeakerEnrollmentJobCommandOutput extends StartSpeakerEnro
26
26
  * import { VoiceIDClient, StartSpeakerEnrollmentJobCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, StartSpeakerEnrollmentJobCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * ClientToken: "STRING_VALUE",
31
+ * JobName: "STRING_VALUE",
32
+ * DomainId: "STRING_VALUE", // required
33
+ * DataAccessRoleArn: "STRING_VALUE", // required
34
+ * EnrollmentConfig: {
35
+ * ExistingEnrollmentAction: "STRING_VALUE",
36
+ * FraudDetectionConfig: {
37
+ * FraudDetectionAction: "STRING_VALUE",
38
+ * RiskThreshold: Number("int"),
39
+ * WatchlistIds: [
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * },
43
+ * },
44
+ * InputDataConfig: {
45
+ * S3Uri: "STRING_VALUE", // required
46
+ * },
47
+ * OutputDataConfig: {
48
+ * S3Uri: "STRING_VALUE", // required
49
+ * KmsKeyId: "STRING_VALUE",
50
+ * },
51
+ * };
29
52
  * const command = new StartSpeakerEnrollmentJobCommand(input);
30
53
  * const response = await client.send(command);
31
54
  * ```
@@ -26,6 +26,15 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
26
  * import { VoiceIDClient, TagResourceCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, TagResourceCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * ResourceArn: "STRING_VALUE", // required
31
+ * Tags: [ // required
32
+ * {
33
+ * Key: "STRING_VALUE", // required
34
+ * Value: "STRING_VALUE", // required
35
+ * },
36
+ * ],
37
+ * };
29
38
  * const command = new TagResourceCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
26
  * import { VoiceIDClient, UntagResourceCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
27
27
  * // const { VoiceIDClient, UntagResourceCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
28
28
  * const client = new VoiceIDClient(config);
29
+ * const input = {
30
+ * ResourceArn: "STRING_VALUE", // required
31
+ * TagKeys: [ // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * };
29
35
  * const command = new UntagResourceCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -28,6 +28,14 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
28
28
  * import { VoiceIDClient, UpdateDomainCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
29
29
  * // const { VoiceIDClient, UpdateDomainCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
30
30
  * const client = new VoiceIDClient(config);
31
+ * const input = {
32
+ * DomainId: "STRING_VALUE", // required
33
+ * Name: "STRING_VALUE", // required
34
+ * Description: "STRING_VALUE",
35
+ * ServerSideEncryptionConfiguration: {
36
+ * KmsKeyId: "STRING_VALUE", // required
37
+ * },
38
+ * };
31
39
  * const command = new UpdateDomainCommand(input);
32
40
  * const response = await client.send(command);
33
41
  * ```
@@ -0,0 +1,92 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateWatchlistRequest, UpdateWatchlistResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, VoiceIDClientResolvedConfig } from "../VoiceIDClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateWatchlistCommand}.
10
+ */
11
+ export interface UpdateWatchlistCommandInput extends UpdateWatchlistRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateWatchlistCommand}.
17
+ */
18
+ export interface UpdateWatchlistCommandOutput extends UpdateWatchlistResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
23
+ * </p>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { VoiceIDClient, UpdateWatchlistCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
28
+ * // const { VoiceIDClient, UpdateWatchlistCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
29
+ * const client = new VoiceIDClient(config);
30
+ * const input = {
31
+ * DomainId: "STRING_VALUE", // required
32
+ * WatchlistId: "STRING_VALUE", // required
33
+ * Name: "STRING_VALUE",
34
+ * Description: "STRING_VALUE",
35
+ * };
36
+ * const command = new UpdateWatchlistCommand(input);
37
+ * const response = await client.send(command);
38
+ * ```
39
+ *
40
+ * @param UpdateWatchlistCommandInput - {@link UpdateWatchlistCommandInput}
41
+ * @returns {@link UpdateWatchlistCommandOutput}
42
+ * @see {@link UpdateWatchlistCommandInput} for command's `input` shape.
43
+ * @see {@link UpdateWatchlistCommandOutput} for command's `response` shape.
44
+ * @see {@link VoiceIDClientResolvedConfig | config} for VoiceIDClient's `config` shape.
45
+ *
46
+ * @throws {@link AccessDeniedException} (client fault)
47
+ * <p>You do not have sufficient permissions to perform this action. Check the error message
48
+ * and try again.</p>
49
+ *
50
+ * @throws {@link ConflictException} (client fault)
51
+ * <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error
52
+ * message for more details.</p>
53
+ *
54
+ * @throws {@link InternalServerException} (server fault)
55
+ * <p>The request failed due to an unknown error on the server side.</p>
56
+ *
57
+ * @throws {@link ResourceNotFoundException} (client fault)
58
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
59
+ * message for more details.</p>
60
+ *
61
+ * @throws {@link ThrottlingException} (client fault)
62
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
63
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
64
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
65
+ * request again.</p>
66
+ *
67
+ * @throws {@link ValidationException} (client fault)
68
+ * <p>The request failed one or more validations; check the error message for more
69
+ * details.</p>
70
+ *
71
+ *
72
+ */
73
+ export declare class UpdateWatchlistCommand extends $Command<UpdateWatchlistCommandInput, UpdateWatchlistCommandOutput, VoiceIDClientResolvedConfig> {
74
+ readonly input: UpdateWatchlistCommandInput;
75
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
79
+ constructor(input: UpdateWatchlistCommandInput);
80
+ /**
81
+ * @internal
82
+ */
83
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VoiceIDClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWatchlistCommandInput, UpdateWatchlistCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
87
+ private serialize;
88
+ /**
89
+ * @internal
90
+ */
91
+ private deserialize;
92
+ }