@aws-sdk/client-polly 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,6 +10,7 @@ import { StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOu
10
10
  import { SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput } from "./commands/SynthesizeSpeechCommand";
11
11
  import { PollyClient } from "./PollyClient";
12
12
  /**
13
+ * @public
13
14
  * <p>Amazon Polly is a web service that makes it easy to synthesize speech from
14
15
  * text.</p>
15
16
  * <p>The Amazon Polly service provides API operations for synthesizing
@@ -19,6 +20,7 @@ import { PollyClient } from "./PollyClient";
19
20
  */
20
21
  export declare class Polly extends PollyClient {
21
22
  /**
23
+ * @public
22
24
  * <p>Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for
23
25
  * speech synthesis, nor is it possible to retrieve it using either the
24
26
  * <code>GetLexicon</code> or <code>ListLexicon</code> APIs.</p>
@@ -28,6 +30,7 @@ export declare class Polly extends PollyClient {
28
30
  deleteLexicon(args: DeleteLexiconCommandInput, cb: (err: any, data?: DeleteLexiconCommandOutput) => void): void;
29
31
  deleteLexicon(args: DeleteLexiconCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLexiconCommandOutput) => void): void;
30
32
  /**
33
+ * @public
31
34
  * <p>Returns the list of voices that are available for use when
32
35
  * requesting speech synthesis. Each voice speaks a specified language, is
33
36
  * either male or female, and is identified by an ID, which is the ASCII
@@ -49,6 +52,7 @@ export declare class Polly extends PollyClient {
49
52
  describeVoices(args: DescribeVoicesCommandInput, cb: (err: any, data?: DescribeVoicesCommandOutput) => void): void;
50
53
  describeVoices(args: DescribeVoicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVoicesCommandOutput) => void): void;
51
54
  /**
55
+ * @public
52
56
  * <p>Returns the content of the specified pronunciation lexicon stored
53
57
  * in an Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
54
58
  */
@@ -56,6 +60,7 @@ export declare class Polly extends PollyClient {
56
60
  getLexicon(args: GetLexiconCommandInput, cb: (err: any, data?: GetLexiconCommandOutput) => void): void;
57
61
  getLexicon(args: GetLexiconCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLexiconCommandOutput) => void): void;
58
62
  /**
63
+ * @public
59
64
  * <p>Retrieves a specific SpeechSynthesisTask object based on its TaskID.
60
65
  * This object contains information about the given speech synthesis task,
61
66
  * including the status of the task, and a link to the S3 bucket containing
@@ -65,12 +70,14 @@ export declare class Polly extends PollyClient {
65
70
  getSpeechSynthesisTask(args: GetSpeechSynthesisTaskCommandInput, cb: (err: any, data?: GetSpeechSynthesisTaskCommandOutput) => void): void;
66
71
  getSpeechSynthesisTask(args: GetSpeechSynthesisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpeechSynthesisTaskCommandOutput) => void): void;
67
72
  /**
73
+ * @public
68
74
  * <p>Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
69
75
  */
70
76
  listLexicons(args: ListLexiconsCommandInput, options?: __HttpHandlerOptions): Promise<ListLexiconsCommandOutput>;
71
77
  listLexicons(args: ListLexiconsCommandInput, cb: (err: any, data?: ListLexiconsCommandOutput) => void): void;
72
78
  listLexicons(args: ListLexiconsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLexiconsCommandOutput) => void): void;
73
79
  /**
80
+ * @public
74
81
  * <p>Returns a list of SpeechSynthesisTask objects ordered by their
75
82
  * creation date. This operation can filter the tasks by their status, for
76
83
  * example, allowing users to list only tasks that are completed.</p>
@@ -79,6 +86,7 @@ export declare class Polly extends PollyClient {
79
86
  listSpeechSynthesisTasks(args: ListSpeechSynthesisTasksCommandInput, cb: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void): void;
80
87
  listSpeechSynthesisTasks(args: ListSpeechSynthesisTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void): void;
81
88
  /**
89
+ * @public
82
90
  * <p>Stores a pronunciation lexicon in an Amazon Web Services Region. If
83
91
  * a lexicon with the same name already exists in the region, it is
84
92
  * overwritten by the new lexicon. Lexicon operations have eventual
@@ -90,6 +98,7 @@ export declare class Polly extends PollyClient {
90
98
  putLexicon(args: PutLexiconCommandInput, cb: (err: any, data?: PutLexiconCommandOutput) => void): void;
91
99
  putLexicon(args: PutLexiconCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLexiconCommandOutput) => void): void;
92
100
  /**
101
+ * @public
93
102
  * <p>Allows the creation of an asynchronous synthesis task, by starting a
94
103
  * new <code>SpeechSynthesisTask</code>. This operation requires all the
95
104
  * standard information needed for speech synthesis, plus the name of an
@@ -105,6 +114,7 @@ export declare class Polly extends PollyClient {
105
114
  startSpeechSynthesisTask(args: StartSpeechSynthesisTaskCommandInput, cb: (err: any, data?: StartSpeechSynthesisTaskCommandOutput) => void): void;
106
115
  startSpeechSynthesisTask(args: StartSpeechSynthesisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSpeechSynthesisTaskCommandOutput) => void): void;
107
116
  /**
117
+ * @public
108
118
  * <p>Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
109
119
  * SSML input must be valid, well-formed SSML. Some alphabets might not be
110
120
  * available with all the voices (for example, Cyrillic might not be read at
@@ -17,15 +17,24 @@ import { PutLexiconCommandInput, PutLexiconCommandOutput } from "./commands/PutL
17
17
  import { StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOutput } from "./commands/StartSpeechSynthesisTaskCommand";
18
18
  import { SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput } from "./commands/SynthesizeSpeechCommand";
19
19
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
20
+ /**
21
+ * @public
22
+ */
20
23
  export type ServiceInputTypes = DeleteLexiconCommandInput | DescribeVoicesCommandInput | GetLexiconCommandInput | GetSpeechSynthesisTaskCommandInput | ListLexiconsCommandInput | ListSpeechSynthesisTasksCommandInput | PutLexiconCommandInput | StartSpeechSynthesisTaskCommandInput | SynthesizeSpeechCommandInput;
24
+ /**
25
+ * @public
26
+ */
21
27
  export type ServiceOutputTypes = DeleteLexiconCommandOutput | DescribeVoicesCommandOutput | GetLexiconCommandOutput | GetSpeechSynthesisTaskCommandOutput | ListLexiconsCommandOutput | ListSpeechSynthesisTasksCommandOutput | PutLexiconCommandOutput | StartSpeechSynthesisTaskCommandOutput | SynthesizeSpeechCommandOutput;
28
+ /**
29
+ * @public
30
+ */
22
31
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
23
32
  /**
24
33
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
25
34
  */
26
35
  requestHandler?: __HttpHandler;
27
36
  /**
28
- * A constructor for a class implementing the {@link __Checksum} interface
37
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
29
38
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
30
39
  * @internal
31
40
  */
@@ -115,7 +124,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
115
124
  */
116
125
  logger?: __Logger;
117
126
  /**
118
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
127
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
119
128
  */
120
129
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
121
130
  /**
@@ -124,19 +133,30 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
124
133
  */
125
134
  sdkStreamMixin?: __SdkStreamMixinInjector;
126
135
  }
136
+ /**
137
+ * @public
138
+ */
127
139
  type PollyClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
128
140
  /**
129
- * The configuration interface of PollyClient class constructor that set the region, credentials and other options.
141
+ * @public
142
+ *
143
+ * The configuration interface of PollyClient class constructor that set the region, credentials and other options.
130
144
  */
131
145
  export interface PollyClientConfig extends PollyClientConfigType {
132
146
  }
147
+ /**
148
+ * @public
149
+ */
133
150
  type PollyClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
134
151
  /**
135
- * The resolved configuration interface of PollyClient class. This is resolved and normalized from the {@link PollyClientConfig | constructor configuration interface}.
152
+ * @public
153
+ *
154
+ * The resolved configuration interface of PollyClient class. This is resolved and normalized from the {@link PollyClientConfig | constructor configuration interface}.
136
155
  */
137
156
  export interface PollyClientResolvedConfig extends PollyClientResolvedConfigType {
138
157
  }
139
158
  /**
159
+ * @public
140
160
  * <p>Amazon Polly is a web service that makes it easy to synthesize speech from
141
161
  * text.</p>
142
162
  * <p>The Amazon Polly service provides API operations for synthesizing
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteLexiconInput, DeleteLexiconOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteLexiconCommand}.
8
10
  */
9
11
  export interface DeleteLexiconCommandInput extends DeleteLexiconInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteLexiconCommand}.
13
17
  */
14
18
  export interface DeleteLexiconCommandOutput extends DeleteLexiconOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for
18
23
  * speech synthesis, nor is it possible to retrieve it using either the
19
24
  * <code>GetLexicon</code> or <code>ListLexicon</code> APIs.</p>
@@ -28,6 +33,8 @@ export interface DeleteLexiconCommandOutput extends DeleteLexiconOutput, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteLexiconCommandInput - {@link DeleteLexiconCommandInput}
37
+ * @returns {@link DeleteLexiconCommandOutput}
31
38
  * @see {@link DeleteLexiconCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteLexiconCommandOutput} for command's `response` shape.
33
40
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DeleteLexiconCommandOutput extends DeleteLexiconOutput, __Metad
58
65
  export declare class DeleteLexiconCommand extends $Command<DeleteLexiconCommandInput, DeleteLexiconCommandOutput, PollyClientResolvedConfig> {
59
66
  readonly input: DeleteLexiconCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DeleteLexiconCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteLexiconCommandInput, DeleteLexiconCommandOutput>;
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 { DescribeVoicesInput, DescribeVoicesOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeVoicesCommand}.
8
10
  */
9
11
  export interface DescribeVoicesCommandInput extends DescribeVoicesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeVoicesCommand}.
13
17
  */
14
18
  export interface DescribeVoicesCommandOutput extends DescribeVoicesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the list of voices that are available for use when
18
23
  * requesting speech synthesis. Each voice speaks a specified language, is
19
24
  * either male or female, and is identified by an ID, which is the ASCII
@@ -40,6 +45,8 @@ export interface DescribeVoicesCommandOutput extends DescribeVoicesOutput, __Met
40
45
  * const response = await client.send(command);
41
46
  * ```
42
47
  *
48
+ * @param DescribeVoicesCommandInput - {@link DescribeVoicesCommandInput}
49
+ * @returns {@link DescribeVoicesCommandOutput}
43
50
  * @see {@link DescribeVoicesCommandInput} for command's `input` shape.
44
51
  * @see {@link DescribeVoicesCommandOutput} for command's `response` shape.
45
52
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -94,11 +101,20 @@ export interface DescribeVoicesCommandOutput extends DescribeVoicesOutput, __Met
94
101
  export declare class DescribeVoicesCommand extends $Command<DescribeVoicesCommandInput, DescribeVoicesCommandOutput, PollyClientResolvedConfig> {
95
102
  readonly input: DescribeVoicesCommandInput;
96
103
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
104
+ /**
105
+ * @public
106
+ */
97
107
  constructor(input: DescribeVoicesCommandInput);
98
108
  /**
99
109
  * @internal
100
110
  */
101
111
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeVoicesCommandInput, DescribeVoicesCommandOutput>;
112
+ /**
113
+ * @internal
114
+ */
102
115
  private serialize;
116
+ /**
117
+ * @internal
118
+ */
103
119
  private deserialize;
104
120
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetLexiconInput, GetLexiconOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetLexiconCommand}.
8
10
  */
9
11
  export interface GetLexiconCommandInput extends GetLexiconInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetLexiconCommand}.
13
17
  */
14
18
  export interface GetLexiconCommandOutput extends GetLexiconOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the content of the specified pronunciation lexicon stored
18
23
  * in an Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetLexiconCommandOutput extends GetLexiconOutput, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetLexiconCommandInput - {@link GetLexiconCommandInput}
35
+ * @returns {@link GetLexiconCommandOutput}
29
36
  * @see {@link GetLexiconCommandInput} for command's `input` shape.
30
37
  * @see {@link GetLexiconCommandOutput} for command's `response` shape.
31
38
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -72,11 +79,20 @@ export interface GetLexiconCommandOutput extends GetLexiconOutput, __MetadataBea
72
79
  export declare class GetLexiconCommand extends $Command<GetLexiconCommandInput, GetLexiconCommandOutput, PollyClientResolvedConfig> {
73
80
  readonly input: GetLexiconCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: GetLexiconCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLexiconCommandInput, GetLexiconCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSpeechSynthesisTaskInput, GetSpeechSynthesisTaskOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSpeechSynthesisTaskCommand}.
8
10
  */
9
11
  export interface GetSpeechSynthesisTaskCommandInput extends GetSpeechSynthesisTaskInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSpeechSynthesisTaskCommand}.
13
17
  */
14
18
  export interface GetSpeechSynthesisTaskCommandOutput extends GetSpeechSynthesisTaskOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a specific SpeechSynthesisTask object based on its TaskID.
18
23
  * This object contains information about the given speech synthesis task,
19
24
  * including the status of the task, and a link to the S3 bucket containing
@@ -28,6 +33,8 @@ export interface GetSpeechSynthesisTaskCommandOutput extends GetSpeechSynthesisT
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetSpeechSynthesisTaskCommandInput - {@link GetSpeechSynthesisTaskCommandInput}
37
+ * @returns {@link GetSpeechSynthesisTaskCommandOutput}
31
38
  * @see {@link GetSpeechSynthesisTaskCommandInput} for command's `input` shape.
32
39
  * @see {@link GetSpeechSynthesisTaskCommandOutput} for command's `response` shape.
33
40
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -48,11 +55,20 @@ export interface GetSpeechSynthesisTaskCommandOutput extends GetSpeechSynthesisT
48
55
  export declare class GetSpeechSynthesisTaskCommand extends $Command<GetSpeechSynthesisTaskCommandInput, GetSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig> {
49
56
  readonly input: GetSpeechSynthesisTaskCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: GetSpeechSynthesisTaskCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSpeechSynthesisTaskCommandInput, GetSpeechSynthesisTaskCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListLexiconsInput, ListLexiconsOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListLexiconsCommand}.
8
10
  */
9
11
  export interface ListLexiconsCommandInput extends ListLexiconsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListLexiconsCommand}.
13
17
  */
14
18
  export interface ListLexiconsCommandOutput extends ListLexiconsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListLexiconsCommandOutput extends ListLexiconsOutput, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListLexiconsCommandInput - {@link ListLexiconsCommandInput}
34
+ * @returns {@link ListLexiconsCommandOutput}
28
35
  * @see {@link ListLexiconsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListLexiconsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -67,11 +74,20 @@ export interface ListLexiconsCommandOutput extends ListLexiconsOutput, __Metadat
67
74
  export declare class ListLexiconsCommand extends $Command<ListLexiconsCommandInput, ListLexiconsCommandOutput, PollyClientResolvedConfig> {
68
75
  readonly input: ListLexiconsCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: ListLexiconsCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListLexiconsCommandInput, ListLexiconsCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListSpeechSynthesisTasksInput, ListSpeechSynthesisTasksOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSpeechSynthesisTasksCommand}.
8
10
  */
9
11
  export interface ListSpeechSynthesisTasksCommandInput extends ListSpeechSynthesisTasksInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSpeechSynthesisTasksCommand}.
13
17
  */
14
18
  export interface ListSpeechSynthesisTasksCommandOutput extends ListSpeechSynthesisTasksOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of SpeechSynthesisTask objects ordered by their
18
23
  * creation date. This operation can filter the tasks by their status, for
19
24
  * example, allowing users to list only tasks that are completed.</p>
@@ -27,6 +32,8 @@ export interface ListSpeechSynthesisTasksCommandOutput extends ListSpeechSynthes
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListSpeechSynthesisTasksCommandInput - {@link ListSpeechSynthesisTasksCommandInput}
36
+ * @returns {@link ListSpeechSynthesisTasksCommandOutput}
30
37
  * @see {@link ListSpeechSynthesisTasksCommandInput} for command's `input` shape.
31
38
  * @see {@link ListSpeechSynthesisTasksCommandOutput} for command's `response` shape.
32
39
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListSpeechSynthesisTasksCommandOutput extends ListSpeechSynthes
43
50
  export declare class ListSpeechSynthesisTasksCommand extends $Command<ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput, PollyClientResolvedConfig> {
44
51
  readonly input: ListSpeechSynthesisTasksCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListSpeechSynthesisTasksCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutLexiconInput, PutLexiconOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutLexiconCommand}.
8
10
  */
9
11
  export interface PutLexiconCommandInput extends PutLexiconInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutLexiconCommand}.
13
17
  */
14
18
  export interface PutLexiconCommandOutput extends PutLexiconOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stores a pronunciation lexicon in an Amazon Web Services Region. If
18
23
  * a lexicon with the same name already exists in the region, it is
19
24
  * overwritten by the new lexicon. Lexicon operations have eventual
@@ -30,6 +35,8 @@ export interface PutLexiconCommandOutput extends PutLexiconOutput, __MetadataBea
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param PutLexiconCommandInput - {@link PutLexiconCommandInput}
39
+ * @returns {@link PutLexiconCommandOutput}
33
40
  * @see {@link PutLexiconCommandInput} for command's `input` shape.
34
41
  * @see {@link PutLexiconCommandOutput} for command's `response` shape.
35
42
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -78,11 +85,20 @@ export interface PutLexiconCommandOutput extends PutLexiconOutput, __MetadataBea
78
85
  export declare class PutLexiconCommand extends $Command<PutLexiconCommandInput, PutLexiconCommandOutput, PollyClientResolvedConfig> {
79
86
  readonly input: PutLexiconCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: PutLexiconCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutLexiconCommandInput, PutLexiconCommandOutput>;
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 { StartSpeechSynthesisTaskInput, StartSpeechSynthesisTaskOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartSpeechSynthesisTaskCommand}.
8
10
  */
9
11
  export interface StartSpeechSynthesisTaskCommandInput extends StartSpeechSynthesisTaskInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartSpeechSynthesisTaskCommand}.
13
17
  */
14
18
  export interface StartSpeechSynthesisTaskCommandOutput extends StartSpeechSynthesisTaskOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows the creation of an asynchronous synthesis task, by starting a
18
23
  * new <code>SpeechSynthesisTask</code>. This operation requires all the
19
24
  * standard information needed for speech synthesis, plus the name of an
@@ -34,6 +39,8 @@ export interface StartSpeechSynthesisTaskCommandOutput extends StartSpeechSynthe
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param StartSpeechSynthesisTaskCommandInput - {@link StartSpeechSynthesisTaskCommandInput}
43
+ * @returns {@link StartSpeechSynthesisTaskCommandOutput}
37
44
  * @see {@link StartSpeechSynthesisTaskCommandInput} for command's `input` shape.
38
45
  * @see {@link StartSpeechSynthesisTaskCommandOutput} for command's `response` shape.
39
46
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -99,11 +106,20 @@ export interface StartSpeechSynthesisTaskCommandOutput extends StartSpeechSynthe
99
106
  export declare class StartSpeechSynthesisTaskCommand extends $Command<StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig> {
100
107
  readonly input: StartSpeechSynthesisTaskCommandInput;
101
108
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
102
112
  constructor(input: StartSpeechSynthesisTaskCommandInput);
103
113
  /**
104
114
  * @internal
105
115
  */
106
116
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
107
120
  private serialize;
121
+ /**
122
+ * @internal
123
+ */
108
124
  private deserialize;
109
125
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SynthesizeSpeechInput, SynthesizeSpeechOutput } from "../models/models_0";
5
5
  import { PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PollyClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SynthesizeSpeechCommand}.
8
10
  */
9
11
  export interface SynthesizeSpeechCommandInput extends SynthesizeSpeechInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SynthesizeSpeechCommand}.
13
17
  */
14
18
  export interface SynthesizeSpeechCommandOutput extends __WithSdkStreamMixin<SynthesizeSpeechOutput, "AudioStream">, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
18
23
  * SSML input must be valid, well-formed SSML. Some alphabets might not be
19
24
  * available with all the voices (for example, Cyrillic might not be read at
@@ -29,6 +34,8 @@ export interface SynthesizeSpeechCommandOutput extends __WithSdkStreamMixin<Synt
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param SynthesizeSpeechCommandInput - {@link SynthesizeSpeechCommandInput}
38
+ * @returns {@link SynthesizeSpeechCommandOutput}
32
39
  * @see {@link SynthesizeSpeechCommandInput} for command's `input` shape.
33
40
  * @see {@link SynthesizeSpeechCommandOutput} for command's `response` shape.
34
41
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
@@ -107,11 +114,20 @@ export interface SynthesizeSpeechCommandOutput extends __WithSdkStreamMixin<Synt
107
114
  export declare class SynthesizeSpeechCommand extends $Command<SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput, PollyClientResolvedConfig> {
108
115
  readonly input: SynthesizeSpeechCommandInput;
109
116
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
117
+ /**
118
+ * @public
119
+ */
110
120
  constructor(input: SynthesizeSpeechCommandInput);
111
121
  /**
112
122
  * @internal
113
123
  */
114
124
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PollyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput>;
125
+ /**
126
+ * @internal
127
+ */
115
128
  private serialize;
129
+ /**
130
+ * @internal
131
+ */
116
132
  private deserialize;
117
133
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Polly service.
4
6
  */
5
7
  export declare class PollyServiceException extends __ServiceException {
@@ -2,6 +2,9 @@
2
2
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
3
3
  import { Readable } from "stream";
4
4
  import { PollyServiceException as __BaseException } from "./PollyServiceException";
5
+ /**
6
+ * @public
7
+ */
5
8
  export interface DeleteLexiconInput {
6
9
  /**
7
10
  * <p>The name of the lexicon to delete. Must be an existing lexicon in
@@ -9,9 +12,13 @@ export interface DeleteLexiconInput {
9
12
  */
10
13
  Name: string | undefined;
11
14
  }
15
+ /**
16
+ * @public
17
+ */
12
18
  export interface DeleteLexiconOutput {
13
19
  }
14
20
  /**
21
+ * @public
15
22
  * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
16
23
  * lexicon that is missing, its name is misspelled or specifying a lexicon
17
24
  * that is in a different region.</p>
@@ -27,6 +34,7 @@ export declare class LexiconNotFoundException extends __BaseException {
27
34
  constructor(opts: __ExceptionOptionType<LexiconNotFoundException, __BaseException>);
28
35
  }
29
36
  /**
37
+ * @public
30
38
  * <p>An unknown condition has caused a service failure.</p>
31
39
  */
32
40
  export declare class ServiceFailureException extends __BaseException {
@@ -37,10 +45,16 @@ export declare class ServiceFailureException extends __BaseException {
37
45
  */
38
46
  constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
39
47
  }
48
+ /**
49
+ * @public
50
+ */
40
51
  export declare enum Engine {
41
52
  NEURAL = "neural",
42
53
  STANDARD = "standard"
43
54
  }
55
+ /**
56
+ * @public
57
+ */
44
58
  export declare enum LanguageCode {
45
59
  ar_AE = "ar-AE",
46
60
  arb = "arb",
@@ -79,6 +93,9 @@ export declare enum LanguageCode {
79
93
  tr_TR = "tr-TR",
80
94
  yue_CN = "yue-CN"
81
95
  }
96
+ /**
97
+ * @public
98
+ */
82
99
  export interface DescribeVoicesInput {
83
100
  /**
84
101
  * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
@@ -108,10 +125,16 @@ export interface DescribeVoicesInput {
108
125
  */
109
126
  NextToken?: string;
110
127
  }
128
+ /**
129
+ * @public
130
+ */
111
131
  export declare enum Gender {
112
132
  Female = "Female",
113
133
  Male = "Male"
114
134
  }
135
+ /**
136
+ * @public
137
+ */
115
138
  export declare enum VoiceId {
116
139
  Aditi = "Aditi",
117
140
  Adriano = "Adriano",
@@ -203,6 +226,7 @@ export declare enum VoiceId {
203
226
  Zhiyu = "Zhiyu"
204
227
  }
205
228
  /**
229
+ * @public
206
230
  * <p>Description of the voice.</p>
207
231
  */
208
232
  export interface Voice {
@@ -244,6 +268,9 @@ export interface Voice {
244
268
  */
245
269
  SupportedEngines?: (Engine | string)[];
246
270
  }
271
+ /**
272
+ * @public
273
+ */
247
274
  export interface DescribeVoicesOutput {
248
275
  /**
249
276
  * <p>A list of voices with their properties.</p>
@@ -257,6 +284,7 @@ export interface DescribeVoicesOutput {
257
284
  NextToken?: string;
258
285
  }
259
286
  /**
287
+ * @public
260
288
  * <p>The NextToken is invalid. Verify that it's spelled correctly, and
261
289
  * then try again.</p>
262
290
  */
@@ -269,6 +297,7 @@ export declare class InvalidNextTokenException extends __BaseException {
269
297
  constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
270
298
  }
271
299
  /**
300
+ * @public
272
301
  * <p>This engine is not compatible with the voice that you have designated.
273
302
  * Choose a new voice that is compatible with the engine or change the engine
274
303
  * and restart the operation.</p>
@@ -281,6 +310,9 @@ export declare class EngineNotSupportedException extends __BaseException {
281
310
  */
282
311
  constructor(opts: __ExceptionOptionType<EngineNotSupportedException, __BaseException>);
283
312
  }
313
+ /**
314
+ * @public
315
+ */
284
316
  export interface GetLexiconInput {
285
317
  /**
286
318
  * <p>Name of the lexicon.</p>
@@ -288,6 +320,7 @@ export interface GetLexiconInput {
288
320
  Name: string | undefined;
289
321
  }
290
322
  /**
323
+ * @public
291
324
  * <p>Provides lexicon name and lexicon content in string format. For
292
325
  * more information, see <a href="https://www.w3.org/TR/pronunciation-lexicon/">Pronunciation Lexicon
293
326
  * Specification (PLS) Version 1.0</a>.</p>
@@ -304,6 +337,7 @@ export interface Lexicon {
304
337
  Name?: string;
305
338
  }
306
339
  /**
340
+ * @public
307
341
  * <p>Contains metadata describing the lexicon such as the number of
308
342
  * lexemes, language code, and so on. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
309
343
  */
@@ -336,6 +370,9 @@ export interface LexiconAttributes {
336
370
  */
337
371
  Size?: number;
338
372
  }
373
+ /**
374
+ * @public
375
+ */
339
376
  export interface GetLexiconOutput {
340
377
  /**
341
378
  * <p>Lexicon object that provides name and the string content of the
@@ -349,35 +386,51 @@ export interface GetLexiconOutput {
349
386
  */
350
387
  LexiconAttributes?: LexiconAttributes;
351
388
  }
389
+ /**
390
+ * @public
391
+ */
352
392
  export interface GetSpeechSynthesisTaskInput {
353
393
  /**
354
394
  * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
355
395
  */
356
396
  TaskId: string | undefined;
357
397
  }
398
+ /**
399
+ * @public
400
+ */
358
401
  export declare enum OutputFormat {
359
402
  JSON = "json",
360
403
  MP3 = "mp3",
361
404
  OGG_VORBIS = "ogg_vorbis",
362
405
  PCM = "pcm"
363
406
  }
407
+ /**
408
+ * @public
409
+ */
364
410
  export declare enum SpeechMarkType {
365
411
  SENTENCE = "sentence",
366
412
  SSML = "ssml",
367
413
  VISEME = "viseme",
368
414
  WORD = "word"
369
415
  }
416
+ /**
417
+ * @public
418
+ */
370
419
  export declare enum TaskStatus {
371
420
  COMPLETED = "completed",
372
421
  FAILED = "failed",
373
422
  IN_PROGRESS = "inProgress",
374
423
  SCHEDULED = "scheduled"
375
424
  }
425
+ /**
426
+ * @public
427
+ */
376
428
  export declare enum TextType {
377
429
  SSML = "ssml",
378
430
  TEXT = "text"
379
431
  }
380
432
  /**
433
+ * @public
381
434
  * <p>SynthesisTask object that provides information about a speech
382
435
  * synthesis task.</p>
383
436
  */
@@ -465,6 +518,9 @@ export interface SynthesisTask {
465
518
  */
466
519
  LanguageCode?: LanguageCode | string;
467
520
  }
521
+ /**
522
+ * @public
523
+ */
468
524
  export interface GetSpeechSynthesisTaskOutput {
469
525
  /**
470
526
  * <p>SynthesisTask object that provides information from the requested
@@ -474,6 +530,7 @@ export interface GetSpeechSynthesisTaskOutput {
474
530
  SynthesisTask?: SynthesisTask;
475
531
  }
476
532
  /**
533
+ * @public
477
534
  * <p>The provided Task ID is not valid. Please provide a valid Task ID and
478
535
  * try again.</p>
479
536
  */
@@ -486,6 +543,7 @@ export declare class InvalidTaskIdException extends __BaseException {
486
543
  constructor(opts: __ExceptionOptionType<InvalidTaskIdException, __BaseException>);
487
544
  }
488
545
  /**
546
+ * @public
489
547
  * <p>The Speech Synthesis task with requested Task ID cannot be
490
548
  * found.</p>
491
549
  */
@@ -498,6 +556,7 @@ export declare class SynthesisTaskNotFoundException extends __BaseException {
498
556
  constructor(opts: __ExceptionOptionType<SynthesisTaskNotFoundException, __BaseException>);
499
557
  }
500
558
  /**
559
+ * @public
501
560
  * <p>Amazon Polly can't find the specified lexicon. Verify that the lexicon's
502
561
  * name is spelled correctly, and then try again.</p>
503
562
  */
@@ -510,6 +569,7 @@ export declare class InvalidLexiconException extends __BaseException {
510
569
  constructor(opts: __ExceptionOptionType<InvalidLexiconException, __BaseException>);
511
570
  }
512
571
  /**
572
+ * @public
513
573
  * <p>The provided Amazon S3 bucket name is invalid. Please check your input
514
574
  * with S3 bucket naming requirements and try again.</p>
515
575
  */
@@ -522,6 +582,7 @@ export declare class InvalidS3BucketException extends __BaseException {
522
582
  constructor(opts: __ExceptionOptionType<InvalidS3BucketException, __BaseException>);
523
583
  }
524
584
  /**
585
+ * @public
525
586
  * <p>The provided Amazon S3 key prefix is invalid. Please provide a valid
526
587
  * S3 object key name.</p>
527
588
  */
@@ -534,6 +595,7 @@ export declare class InvalidS3KeyException extends __BaseException {
534
595
  constructor(opts: __ExceptionOptionType<InvalidS3KeyException, __BaseException>);
535
596
  }
536
597
  /**
598
+ * @public
537
599
  * <p>The specified sample rate is not valid.</p>
538
600
  */
539
601
  export declare class InvalidSampleRateException extends __BaseException {
@@ -545,6 +607,7 @@ export declare class InvalidSampleRateException extends __BaseException {
545
607
  constructor(opts: __ExceptionOptionType<InvalidSampleRateException, __BaseException>);
546
608
  }
547
609
  /**
610
+ * @public
548
611
  * <p>The provided SNS topic ARN is invalid. Please provide a valid SNS
549
612
  * topic ARN and try again.</p>
550
613
  */
@@ -557,6 +620,7 @@ export declare class InvalidSnsTopicArnException extends __BaseException {
557
620
  constructor(opts: __ExceptionOptionType<InvalidSnsTopicArnException, __BaseException>);
558
621
  }
559
622
  /**
623
+ * @public
560
624
  * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
561
625
  * of tags and values, and then try again.</p>
562
626
  */
@@ -569,6 +633,7 @@ export declare class InvalidSsmlException extends __BaseException {
569
633
  constructor(opts: __ExceptionOptionType<InvalidSsmlException, __BaseException>);
570
634
  }
571
635
  /**
636
+ * @public
572
637
  * <p>The language specified is not currently supported by Amazon Polly in this
573
638
  * capacity.</p>
574
639
  */
@@ -581,6 +646,7 @@ export declare class LanguageNotSupportedException extends __BaseException {
581
646
  constructor(opts: __ExceptionOptionType<LanguageNotSupportedException, __BaseException>);
582
647
  }
583
648
  /**
649
+ * @public
584
650
  * <p>Describes the content of the lexicon.</p>
585
651
  */
586
652
  export interface LexiconDescription {
@@ -594,6 +660,7 @@ export interface LexiconDescription {
594
660
  Attributes?: LexiconAttributes;
595
661
  }
596
662
  /**
663
+ * @public
597
664
  * <p>The maximum size of the specified lexicon would be exceeded by this
598
665
  * operation.</p>
599
666
  */
@@ -605,6 +672,9 @@ export declare class LexiconSizeExceededException extends __BaseException {
605
672
  */
606
673
  constructor(opts: __ExceptionOptionType<LexiconSizeExceededException, __BaseException>);
607
674
  }
675
+ /**
676
+ * @public
677
+ */
608
678
  export interface ListLexiconsInput {
609
679
  /**
610
680
  * <p>An opaque pagination token returned from previous
@@ -613,6 +683,9 @@ export interface ListLexiconsInput {
613
683
  */
614
684
  NextToken?: string;
615
685
  }
686
+ /**
687
+ * @public
688
+ */
616
689
  export interface ListLexiconsOutput {
617
690
  /**
618
691
  * <p>A list of lexicon names and attributes.</p>
@@ -625,6 +698,9 @@ export interface ListLexiconsOutput {
625
698
  */
626
699
  NextToken?: string;
627
700
  }
701
+ /**
702
+ * @public
703
+ */
628
704
  export interface ListSpeechSynthesisTasksInput {
629
705
  /**
630
706
  * <p>Maximum number of speech synthesis tasks returned in a List
@@ -642,6 +718,9 @@ export interface ListSpeechSynthesisTasksInput {
642
718
  */
643
719
  Status?: TaskStatus | string;
644
720
  }
721
+ /**
722
+ * @public
723
+ */
645
724
  export interface ListSpeechSynthesisTasksOutput {
646
725
  /**
647
726
  * <p>An opaque pagination token returned from the previous List operation
@@ -657,6 +736,7 @@ export interface ListSpeechSynthesisTasksOutput {
657
736
  SynthesisTasks?: SynthesisTask[];
658
737
  }
659
738
  /**
739
+ * @public
660
740
  * <p>Speech marks are not supported for the <code>OutputFormat</code>
661
741
  * selected. Speech marks are only available for content in <code>json</code>
662
742
  * format.</p>
@@ -670,6 +750,7 @@ export declare class MarksNotSupportedForFormatException extends __BaseException
670
750
  constructor(opts: __ExceptionOptionType<MarksNotSupportedForFormatException, __BaseException>);
671
751
  }
672
752
  /**
753
+ * @public
673
754
  * <p>The maximum size of the lexeme would be exceeded by this
674
755
  * operation.</p>
675
756
  */
@@ -682,6 +763,7 @@ export declare class MaxLexemeLengthExceededException extends __BaseException {
682
763
  constructor(opts: __ExceptionOptionType<MaxLexemeLengthExceededException, __BaseException>);
683
764
  }
684
765
  /**
766
+ * @public
685
767
  * <p>The maximum number of lexicons would be exceeded by this
686
768
  * operation.</p>
687
769
  */
@@ -693,10 +775,13 @@ export declare class MaxLexiconsNumberExceededException extends __BaseException
693
775
  */
694
776
  constructor(opts: __ExceptionOptionType<MaxLexiconsNumberExceededException, __BaseException>);
695
777
  }
778
+ /**
779
+ * @public
780
+ */
696
781
  export interface PutLexiconInput {
697
782
  /**
698
783
  * <p>Name of the lexicon. The name must follow the regular express
699
- * format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive
784
+ * format [0-9A-Za-z]\{1,20\}. That is, the name is a case-sensitive
700
785
  * alphanumeric string up to 20 characters long. </p>
701
786
  */
702
787
  Name: string | undefined;
@@ -705,9 +790,13 @@ export interface PutLexiconInput {
705
790
  */
706
791
  Content: string | undefined;
707
792
  }
793
+ /**
794
+ * @public
795
+ */
708
796
  export interface PutLexiconOutput {
709
797
  }
710
798
  /**
799
+ * @public
711
800
  * <p>The alphabet specified by the lexicon is not a supported alphabet.
712
801
  * Valid values are <code>x-sampa</code> and <code>ipa</code>.</p>
713
802
  */
@@ -720,6 +809,7 @@ export declare class UnsupportedPlsAlphabetException extends __BaseException {
720
809
  constructor(opts: __ExceptionOptionType<UnsupportedPlsAlphabetException, __BaseException>);
721
810
  }
722
811
  /**
812
+ * @public
723
813
  * <p>The language specified in the lexicon is unsupported. For a list of
724
814
  * supported languages, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html">Lexicon Attributes</a>.</p>
725
815
  */
@@ -732,6 +822,7 @@ export declare class UnsupportedPlsLanguageException extends __BaseException {
732
822
  constructor(opts: __ExceptionOptionType<UnsupportedPlsLanguageException, __BaseException>);
733
823
  }
734
824
  /**
825
+ * @public
735
826
  * <p>SSML speech marks are not supported for plain text-type
736
827
  * input.</p>
737
828
  */
@@ -743,6 +834,9 @@ export declare class SsmlMarksNotSupportedForTextTypeException extends __BaseExc
743
834
  */
744
835
  constructor(opts: __ExceptionOptionType<SsmlMarksNotSupportedForTextTypeException, __BaseException>);
745
836
  }
837
+ /**
838
+ * @public
839
+ */
746
840
  export interface StartSpeechSynthesisTaskInput {
747
841
  /**
748
842
  * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
@@ -815,6 +909,9 @@ export interface StartSpeechSynthesisTaskInput {
815
909
  */
816
910
  VoiceId: VoiceId | string | undefined;
817
911
  }
912
+ /**
913
+ * @public
914
+ */
818
915
  export interface StartSpeechSynthesisTaskOutput {
819
916
  /**
820
917
  * <p>SynthesisTask object that provides information and attributes about a
@@ -823,6 +920,7 @@ export interface StartSpeechSynthesisTaskOutput {
823
920
  SynthesisTask?: SynthesisTask;
824
921
  }
825
922
  /**
923
+ * @public
826
924
  * <p>The value of the "Text" parameter is longer than the accepted
827
925
  * limits. For the <code>SynthesizeSpeech</code> API, the limit for input
828
926
  * text is a maximum of 6000 characters total, of which no more than 3000 can
@@ -839,6 +937,9 @@ export declare class TextLengthExceededException extends __BaseException {
839
937
  */
840
938
  constructor(opts: __ExceptionOptionType<TextLengthExceededException, __BaseException>);
841
939
  }
940
+ /**
941
+ * @public
942
+ */
842
943
  export interface SynthesizeSpeechInput {
843
944
  /**
844
945
  * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
@@ -922,6 +1023,9 @@ export interface SynthesizeSpeechInput {
922
1023
  */
923
1024
  VoiceId: VoiceId | string | undefined;
924
1025
  }
1026
+ /**
1027
+ * @public
1028
+ */
925
1029
  export interface SynthesizeSpeechOutput {
926
1030
  /**
927
1031
  * <p> Stream containing the synthesized speech. </p>
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { PollyClient } from "../PollyClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface PollyPaginationConfiguration extends PaginationConfiguration {
4
7
  client: PollyClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput } from "../commands/ListSpeechSynthesisTasksCommand";
3
3
  import { PollyPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListSpeechSynthesisTasks(config: PollyPaginationConfiguration, input: ListSpeechSynthesisTasksCommandInput, ...additionalArguments: any): Paginator<ListSpeechSynthesisTasksCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-polly",
3
3
  "description": "AWS SDK for JavaScript Polly Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-stream-browser": "3.295.0",
53
- "@aws-sdk/util-stream-node": "3.295.0",
54
- "@aws-sdk/util-user-agent-browser": "3.295.0",
55
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-stream-browser": "3.296.0",
53
+ "@aws-sdk/util-stream-node": "3.296.0",
54
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
55
+ "@aws-sdk/util-user-agent-node": "3.296.0",
56
56
  "@aws-sdk/util-utf8": "3.295.0",
57
57
  "tslib": "^2.5.0"
58
58
  },