@aws-sdk/client-lex-runtime-service 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.
@@ -6,6 +6,7 @@ import { PostTextCommandInput, PostTextCommandOutput } from "./commands/PostText
6
6
  import { PutSessionCommandInput, PutSessionCommandOutput } from "./commands/PutSessionCommand";
7
7
  import { LexRuntimeServiceClient } from "./LexRuntimeServiceClient";
8
8
  /**
9
+ * @public
9
10
  * <p>Amazon Lex provides both build and runtime endpoints. Each endpoint
10
11
  * provides a set of operations (API). Your conversational bot uses the
11
12
  * runtime API to understand user utterances (user input text or voice). For
@@ -21,6 +22,7 @@ import { LexRuntimeServiceClient } from "./LexRuntimeServiceClient";
21
22
  */
22
23
  export declare class LexRuntimeService extends LexRuntimeServiceClient {
23
24
  /**
25
+ * @public
24
26
  * <p>Removes session information for a specified bot, alias, and user ID.
25
27
  * </p>
26
28
  */
@@ -28,6 +30,7 @@ export declare class LexRuntimeService extends LexRuntimeServiceClient {
28
30
  deleteSession(args: DeleteSessionCommandInput, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void;
29
31
  deleteSession(args: DeleteSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void;
30
32
  /**
33
+ * @public
31
34
  * <p>Returns session information for a specified bot, alias, and user
32
35
  * ID.</p>
33
36
  */
@@ -35,6 +38,7 @@ export declare class LexRuntimeService extends LexRuntimeServiceClient {
35
38
  getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
36
39
  getSession(args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
37
40
  /**
41
+ * @public
38
42
  * <p> Sends user input (text or speech) to Amazon Lex. Clients use this API to
39
43
  * send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the
40
44
  * user input using the machine learning model that it built for the bot. </p>
@@ -117,6 +121,7 @@ export declare class LexRuntimeService extends LexRuntimeServiceClient {
117
121
  postContent(args: PostContentCommandInput, cb: (err: any, data?: PostContentCommandOutput) => void): void;
118
122
  postContent(args: PostContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostContentCommandOutput) => void): void;
119
123
  /**
124
+ * @public
120
125
  * <p>Sends user input to Amazon Lex. Client applications can use this API to
121
126
  * send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input
122
127
  * using the machine learning model it built for the bot. </p>
@@ -198,6 +203,7 @@ export declare class LexRuntimeService extends LexRuntimeServiceClient {
198
203
  postText(args: PostTextCommandInput, cb: (err: any, data?: PostTextCommandOutput) => void): void;
199
204
  postText(args: PostTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostTextCommandOutput) => void): void;
200
205
  /**
206
+ * @public
201
207
  * <p>Creates a new session or modifies an existing session with an Amazon Lex
202
208
  * bot. Use this operation to enable your application to set the state of the
203
209
  * bot.</p>
@@ -13,15 +13,24 @@ import { PostContentCommandInput, PostContentCommandOutput } from "./commands/Po
13
13
  import { PostTextCommandInput, PostTextCommandOutput } from "./commands/PostTextCommand";
14
14
  import { PutSessionCommandInput, PutSessionCommandOutput } from "./commands/PutSessionCommand";
15
15
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
16
+ /**
17
+ * @public
18
+ */
16
19
  export type ServiceInputTypes = DeleteSessionCommandInput | GetSessionCommandInput | PostContentCommandInput | PostTextCommandInput | PutSessionCommandInput;
20
+ /**
21
+ * @public
22
+ */
17
23
  export type ServiceOutputTypes = DeleteSessionCommandOutput | GetSessionCommandOutput | PostContentCommandOutput | PostTextCommandOutput | PutSessionCommandOutput;
24
+ /**
25
+ * @public
26
+ */
18
27
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
19
28
  /**
20
29
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
21
30
  */
22
31
  requestHandler?: __HttpHandler;
23
32
  /**
24
- * A constructor for a class implementing the {@link __Checksum} interface
33
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
25
34
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
26
35
  * @internal
27
36
  */
@@ -111,7 +120,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
111
120
  */
112
121
  logger?: __Logger;
113
122
  /**
114
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
123
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
115
124
  */
116
125
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
117
126
  /**
@@ -120,19 +129,30 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
120
129
  */
121
130
  sdkStreamMixin?: __SdkStreamMixinInjector;
122
131
  }
132
+ /**
133
+ * @public
134
+ */
123
135
  type LexRuntimeServiceClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
124
136
  /**
125
- * The configuration interface of LexRuntimeServiceClient class constructor that set the region, credentials and other options.
137
+ * @public
138
+ *
139
+ * The configuration interface of LexRuntimeServiceClient class constructor that set the region, credentials and other options.
126
140
  */
127
141
  export interface LexRuntimeServiceClientConfig extends LexRuntimeServiceClientConfigType {
128
142
  }
143
+ /**
144
+ * @public
145
+ */
129
146
  type LexRuntimeServiceClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
130
147
  /**
131
- * The resolved configuration interface of LexRuntimeServiceClient class. This is resolved and normalized from the {@link LexRuntimeServiceClientConfig | constructor configuration interface}.
148
+ * @public
149
+ *
150
+ * The resolved configuration interface of LexRuntimeServiceClient class. This is resolved and normalized from the {@link LexRuntimeServiceClientConfig | constructor configuration interface}.
132
151
  */
133
152
  export interface LexRuntimeServiceClientResolvedConfig extends LexRuntimeServiceClientResolvedConfigType {
134
153
  }
135
154
  /**
155
+ * @public
136
156
  * <p>Amazon Lex provides both build and runtime endpoints. Each endpoint
137
157
  * provides a set of operations (API). Your conversational bot uses the
138
158
  * runtime API to understand user utterances (user input text or voice). For
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LexRuntimeServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeServiceClient";
5
5
  import { DeleteSessionRequest, DeleteSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSessionCommand}.
8
10
  */
9
11
  export interface DeleteSessionCommandInput extends DeleteSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSessionCommand}.
13
17
  */
14
18
  export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes session information for a specified bot, alias, and user ID.
18
23
  * </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteSessionCommandInput - {@link DeleteSessionCommandInput}
35
+ * @returns {@link DeleteSessionCommandOutput}
29
36
  * @see {@link DeleteSessionCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteSessionCommandOutput} for command's `response` shape.
31
38
  * @see {@link LexRuntimeServiceClientResolvedConfig | config} for LexRuntimeServiceClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __Met
54
61
  export declare class DeleteSessionCommand extends $Command<DeleteSessionCommandInput, DeleteSessionCommandOutput, LexRuntimeServiceClientResolvedConfig> {
55
62
  readonly input: DeleteSessionCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteSessionCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeServiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSessionCommandInput, DeleteSessionCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LexRuntimeServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeServiceClient";
5
5
  import { GetSessionRequest, GetSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSessionCommand}.
8
10
  */
9
11
  export interface GetSessionCommandInput extends GetSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSessionCommand}.
13
17
  */
14
18
  export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns session information for a specified bot, alias, and user
18
23
  * ID.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetSessionCommandInput - {@link GetSessionCommandInput}
35
+ * @returns {@link GetSessionCommandOutput}
29
36
  * @see {@link GetSessionCommandInput} for command's `input` shape.
30
37
  * @see {@link GetSessionCommandOutput} for command's `response` shape.
31
38
  * @see {@link LexRuntimeServiceClientResolvedConfig | config} for LexRuntimeServiceClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
50
57
  export declare class GetSessionCommand extends $Command<GetSessionCommandInput, GetSessionCommandOutput, LexRuntimeServiceClientResolvedConfig> {
51
58
  readonly input: GetSessionCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetSessionCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeServiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionCommandInput, GetSessionCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -5,9 +5,11 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
5
5
  import { LexRuntimeServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeServiceClient";
6
6
  import { PostContentRequest, PostContentResponse } from "../models/models_0";
7
7
  /**
8
+ * @public
9
+ *
8
10
  * The input for {@link PostContentCommand}.
9
11
  */
10
- type PostContentCommandInputType = Omit<PostContentRequest, "inputStream"> & {
12
+ export type PostContentCommandInputType = Omit<PostContentRequest, "inputStream"> & {
11
13
  /**
12
14
  * For *`PostContentRequest["inputStream"]`*, see {@link PostContentRequest.inputStream}.
13
15
  */
@@ -19,11 +21,14 @@ type PostContentCommandInputType = Omit<PostContentRequest, "inputStream"> & {
19
21
  export interface PostContentCommandInput extends PostContentCommandInputType {
20
22
  }
21
23
  /**
24
+ * @public
25
+ *
22
26
  * The output of {@link PostContentCommand}.
23
27
  */
24
28
  export interface PostContentCommandOutput extends __WithSdkStreamMixin<PostContentResponse, "audioStream">, __MetadataBearer {
25
29
  }
26
30
  /**
31
+ * @public
27
32
  * <p> Sends user input (text or speech) to Amazon Lex. Clients use this API to
28
33
  * send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the
29
34
  * user input using the machine learning model that it built for the bot. </p>
@@ -111,6 +116,8 @@ export interface PostContentCommandOutput extends __WithSdkStreamMixin<PostConte
111
116
  * const response = await client.send(command);
112
117
  * ```
113
118
  *
119
+ * @param PostContentCommandInput - {@link PostContentCommandInput}
120
+ * @returns {@link PostContentCommandOutput}
114
121
  * @see {@link PostContentCommandInput} for command's `input` shape.
115
122
  * @see {@link PostContentCommandOutput} for command's `response` shape.
116
123
  * @see {@link LexRuntimeServiceClientResolvedConfig | config} for LexRuntimeServiceClient's `config` shape.
@@ -175,12 +182,20 @@ export interface PostContentCommandOutput extends __WithSdkStreamMixin<PostConte
175
182
  export declare class PostContentCommand extends $Command<PostContentCommandInput, PostContentCommandOutput, LexRuntimeServiceClientResolvedConfig> {
176
183
  readonly input: PostContentCommandInput;
177
184
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
185
+ /**
186
+ * @public
187
+ */
178
188
  constructor(input: PostContentCommandInput);
179
189
  /**
180
190
  * @internal
181
191
  */
182
192
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeServiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PostContentCommandInput, PostContentCommandOutput>;
193
+ /**
194
+ * @internal
195
+ */
183
196
  private serialize;
197
+ /**
198
+ * @internal
199
+ */
184
200
  private deserialize;
185
201
  }
186
- export {};
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LexRuntimeServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeServiceClient";
5
5
  import { PostTextRequest, PostTextResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PostTextCommand}.
8
10
  */
9
11
  export interface PostTextCommandInput extends PostTextRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PostTextCommand}.
13
17
  */
14
18
  export interface PostTextCommandOutput extends PostTextResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends user input to Amazon Lex. Client applications can use this API to
18
23
  * send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input
19
24
  * using the machine learning model it built for the bot. </p>
@@ -100,6 +105,8 @@ export interface PostTextCommandOutput extends PostTextResponse, __MetadataBeare
100
105
  * const response = await client.send(command);
101
106
  * ```
102
107
  *
108
+ * @param PostTextCommandInput - {@link PostTextCommandInput}
109
+ * @returns {@link PostTextCommandOutput}
103
110
  * @see {@link PostTextCommandInput} for command's `input` shape.
104
111
  * @see {@link PostTextCommandOutput} for command's `response` shape.
105
112
  * @see {@link LexRuntimeServiceClientResolvedConfig | config} for LexRuntimeServiceClient's `config` shape.
@@ -154,11 +161,20 @@ export interface PostTextCommandOutput extends PostTextResponse, __MetadataBeare
154
161
  export declare class PostTextCommand extends $Command<PostTextCommandInput, PostTextCommandOutput, LexRuntimeServiceClientResolvedConfig> {
155
162
  readonly input: PostTextCommandInput;
156
163
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
164
+ /**
165
+ * @public
166
+ */
157
167
  constructor(input: PostTextCommandInput);
158
168
  /**
159
169
  * @internal
160
170
  */
161
171
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeServiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PostTextCommandInput, PostTextCommandOutput>;
172
+ /**
173
+ * @internal
174
+ */
162
175
  private serialize;
176
+ /**
177
+ * @internal
178
+ */
163
179
  private deserialize;
164
180
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LexRuntimeServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeServiceClient";
5
5
  import { PutSessionRequest, PutSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutSessionCommand}.
8
10
  */
9
11
  export interface PutSessionCommandInput extends PutSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutSessionCommand}.
13
17
  */
14
18
  export interface PutSessionCommandOutput extends __WithSdkStreamMixin<PutSessionResponse, "audioStream">, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new session or modifies an existing session with an Amazon Lex
18
23
  * bot. Use this operation to enable your application to set the state of the
19
24
  * bot.</p>
@@ -29,6 +34,8 @@ export interface PutSessionCommandOutput extends __WithSdkStreamMixin<PutSession
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param PutSessionCommandInput - {@link PutSessionCommandInput}
38
+ * @returns {@link PutSessionCommandOutput}
32
39
  * @see {@link PutSessionCommandInput} for command's `input` shape.
33
40
  * @see {@link PutSessionCommandOutput} for command's `response` shape.
34
41
  * @see {@link LexRuntimeServiceClientResolvedConfig | config} for LexRuntimeServiceClient's `config` shape.
@@ -83,11 +90,20 @@ export interface PutSessionCommandOutput extends __WithSdkStreamMixin<PutSession
83
90
  export declare class PutSessionCommand extends $Command<PutSessionCommandInput, PutSessionCommandOutput, LexRuntimeServiceClientResolvedConfig> {
84
91
  readonly input: PutSessionCommandInput;
85
92
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
93
+ /**
94
+ * @public
95
+ */
86
96
  constructor(input: PutSessionCommandInput);
87
97
  /**
88
98
  * @internal
89
99
  */
90
100
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeServiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSessionCommandInput, PutSessionCommandOutput>;
101
+ /**
102
+ * @internal
103
+ */
91
104
  private serialize;
105
+ /**
106
+ * @internal
107
+ */
92
108
  private deserialize;
93
109
  }
@@ -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 LexRuntimeService service.
4
6
  */
5
7
  export declare class LexRuntimeServiceServiceException extends __ServiceException {
@@ -3,6 +3,7 @@ import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJ
3
3
  import { Readable } from "stream";
4
4
  import { LexRuntimeServiceServiceException as __BaseException } from "./LexRuntimeServiceServiceException";
5
5
  /**
6
+ * @public
6
7
  * <p>The length of time or number of turns that a context remains
7
8
  * active.</p>
8
9
  */
@@ -22,6 +23,7 @@ export interface ActiveContextTimeToLive {
22
23
  turnsToLive?: number;
23
24
  }
24
25
  /**
26
+ * @public
25
27
  * <p>A context is a variable that contains information about the current
26
28
  * state of the conversation between a user and Amazon Lex. Context can be set
27
29
  * automatically by Amazon Lex when an intent is fulfilled, or it can be set at
@@ -45,6 +47,7 @@ export interface ActiveContext {
45
47
  parameters: Record<string, string> | undefined;
46
48
  }
47
49
  /**
50
+ * @public
48
51
  * <p> Request validation failed, there is no usable message in the context,
49
52
  * or the bot build failed, is still in progress, or contains unbuilt
50
53
  * changes. </p>
@@ -58,6 +61,7 @@ export declare class BadRequestException extends __BaseException {
58
61
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
59
62
  }
60
63
  /**
64
+ * @public
61
65
  * <p> Two clients are using the same AWS account, Amazon Lex bot, and user
62
66
  * ID. </p>
63
67
  */
@@ -69,6 +73,9 @@ export declare class ConflictException extends __BaseException {
69
73
  */
70
74
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
71
75
  }
76
+ /**
77
+ * @public
78
+ */
72
79
  export interface DeleteSessionRequest {
73
80
  /**
74
81
  * <p>The name of the bot that contains the session data.</p>
@@ -83,6 +90,9 @@ export interface DeleteSessionRequest {
83
90
  */
84
91
  userId: string | undefined;
85
92
  }
93
+ /**
94
+ * @public
95
+ */
86
96
  export interface DeleteSessionResponse {
87
97
  /**
88
98
  * <p>The name of the bot associated with the session data.</p>
@@ -102,6 +112,7 @@ export interface DeleteSessionResponse {
102
112
  sessionId?: string;
103
113
  }
104
114
  /**
115
+ * @public
105
116
  * <p>Internal service error. Retry the call.</p>
106
117
  */
107
118
  export declare class InternalFailureException extends __BaseException {
@@ -113,6 +124,7 @@ export declare class InternalFailureException extends __BaseException {
113
124
  constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
114
125
  }
115
126
  /**
127
+ * @public
116
128
  * <p>Exceeded a limit.</p>
117
129
  */
118
130
  export declare class LimitExceededException extends __BaseException {
@@ -125,6 +137,7 @@ export declare class LimitExceededException extends __BaseException {
125
137
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
126
138
  }
127
139
  /**
140
+ * @public
128
141
  * <p>The resource (such as the Amazon Lex bot or an alias) that is referred
129
142
  * to is not found.</p>
130
143
  */
@@ -136,6 +149,9 @@ export declare class NotFoundException extends __BaseException {
136
149
  */
137
150
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
138
151
  }
152
+ /**
153
+ * @public
154
+ */
139
155
  export interface GetSessionRequest {
140
156
  /**
141
157
  * <p>The name of the bot that contains the session data.</p>
@@ -159,17 +175,26 @@ export interface GetSessionRequest {
159
175
  */
160
176
  checkpointLabelFilter?: string;
161
177
  }
178
+ /**
179
+ * @public
180
+ */
162
181
  export declare enum FulfillmentState {
163
182
  FAILED = "Failed",
164
183
  FULFILLED = "Fulfilled",
165
184
  READY_FOR_FULFILLMENT = "ReadyForFulfillment"
166
185
  }
186
+ /**
187
+ * @public
188
+ */
167
189
  export declare enum MessageFormatType {
168
190
  COMPOSITE = "Composite",
169
191
  CUSTOM_PAYLOAD = "CustomPayload",
170
192
  PLAIN_TEXT = "PlainText",
171
193
  SSML = "SSML"
172
194
  }
195
+ /**
196
+ * @public
197
+ */
173
198
  export declare enum DialogActionType {
174
199
  CLOSE = "Close",
175
200
  CONFIRM_INTENT = "ConfirmIntent",
@@ -178,6 +203,7 @@ export declare enum DialogActionType {
178
203
  ELICIT_SLOT = "ElicitSlot"
179
204
  }
180
205
  /**
206
+ * @public
181
207
  * <p>Describes the next action that the bot should take in its interaction
182
208
  * with the user and provides information about the context in which the
183
209
  * action takes place. Use the <code>DialogAction</code> data type to set the
@@ -285,12 +311,16 @@ export interface DialogAction {
285
311
  */
286
312
  messageFormat?: MessageFormatType | string;
287
313
  }
314
+ /**
315
+ * @public
316
+ */
288
317
  export declare enum ConfirmationStatus {
289
318
  CONFIRMED = "Confirmed",
290
319
  DENIED = "Denied",
291
320
  NONE = "None"
292
321
  }
293
322
  /**
323
+ * @public
294
324
  * <p>Provides information about the state of an intent. You can use this
295
325
  * information to get the current state of an intent so that you can process
296
326
  * the intent, or so that you can return the intent to its previous
@@ -396,6 +426,9 @@ export interface IntentSummary {
396
426
  */
397
427
  slotToElicit?: string;
398
428
  }
429
+ /**
430
+ * @public
431
+ */
399
432
  export interface GetSessionResponse {
400
433
  /**
401
434
  * <p>An array of information about the intents used in the session. The
@@ -431,6 +464,7 @@ export interface GetSessionResponse {
431
464
  activeContexts?: ActiveContext[];
432
465
  }
433
466
  /**
467
+ * @public
434
468
  * <p>Either the Amazon Lex bot is still building, or one of the dependent
435
469
  * services (Amazon Polly, AWS Lambda) failed with an internal service
436
470
  * error.</p>
@@ -445,6 +479,7 @@ export declare class BadGatewayException extends __BaseException {
445
479
  constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
446
480
  }
447
481
  /**
482
+ * @public
448
483
  * <p> One of the dependencies, such as AWS Lambda or Amazon Polly, threw an
449
484
  * exception. For example, </p>
450
485
  * <ul>
@@ -472,6 +507,7 @@ export declare class DependencyFailedException extends __BaseException {
472
507
  constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
473
508
  }
474
509
  /**
510
+ * @public
475
511
  * <p>This exception is not used.</p>
476
512
  */
477
513
  export declare class LoopDetectedException extends __BaseException {
@@ -484,6 +520,7 @@ export declare class LoopDetectedException extends __BaseException {
484
520
  constructor(opts: __ExceptionOptionType<LoopDetectedException, __BaseException>);
485
521
  }
486
522
  /**
523
+ * @public
487
524
  * <p>The accept header in the request does not have a valid value.</p>
488
525
  */
489
526
  export declare class NotAcceptableException extends __BaseException {
@@ -494,6 +531,9 @@ export declare class NotAcceptableException extends __BaseException {
494
531
  */
495
532
  constructor(opts: __ExceptionOptionType<NotAcceptableException, __BaseException>);
496
533
  }
534
+ /**
535
+ * @public
536
+ */
497
537
  export interface PostContentRequest {
498
538
  /**
499
539
  * <p>Name of the Amazon Lex bot.</p>
@@ -663,6 +703,9 @@ export interface PostContentRequest {
663
703
  */
664
704
  activeContexts?: __LazyJsonString | string;
665
705
  }
706
+ /**
707
+ * @public
708
+ */
666
709
  export declare enum DialogState {
667
710
  CONFIRM_INTENT = "ConfirmIntent",
668
711
  ELICIT_INTENT = "ElicitIntent",
@@ -671,6 +714,9 @@ export declare enum DialogState {
671
714
  FULFILLED = "Fulfilled",
672
715
  READY_FOR_FULFILLMENT = "ReadyForFulfillment"
673
716
  }
717
+ /**
718
+ * @public
719
+ */
674
720
  export interface PostContentResponse {
675
721
  /**
676
722
  * <p>Content type as specified in the <code>Accept</code> HTTP header in
@@ -919,6 +965,7 @@ export interface PostContentResponse {
919
965
  activeContexts?: __LazyJsonString | string;
920
966
  }
921
967
  /**
968
+ * @public
922
969
  * <p>The input speech is too long.</p>
923
970
  */
924
971
  export declare class RequestTimeoutException extends __BaseException {
@@ -930,6 +977,7 @@ export declare class RequestTimeoutException extends __BaseException {
930
977
  constructor(opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>);
931
978
  }
932
979
  /**
980
+ * @public
933
981
  * <p>The Content-Type header (<code>PostContent</code> API) has an invalid
934
982
  * value. </p>
935
983
  */
@@ -941,6 +989,9 @@ export declare class UnsupportedMediaTypeException extends __BaseException {
941
989
  */
942
990
  constructor(opts: __ExceptionOptionType<UnsupportedMediaTypeException, __BaseException>);
943
991
  }
992
+ /**
993
+ * @public
994
+ */
944
995
  export interface PostTextRequest {
945
996
  /**
946
997
  * <p>The name of the Amazon Lex bot.</p>
@@ -1012,6 +1063,7 @@ export interface PostTextRequest {
1012
1063
  activeContexts?: ActiveContext[];
1013
1064
  }
1014
1065
  /**
1066
+ * @public
1015
1067
  * <p>Provides a score that indicates the confidence that Amazon Lex has that an
1016
1068
  * intent is the one that satisfies the user's intent.</p>
1017
1069
  */
@@ -1024,6 +1076,7 @@ export interface IntentConfidence {
1024
1076
  score?: number;
1025
1077
  }
1026
1078
  /**
1079
+ * @public
1027
1080
  * <p>An intent that Amazon Lex suggests satisfies the user's intent. Includes
1028
1081
  * the name of the intent, the confidence that Amazon Lex has that the user's
1029
1082
  * intent is satisfied, and the slots defined for the intent.</p>
@@ -1044,10 +1097,14 @@ export interface PredictedIntent {
1044
1097
  */
1045
1098
  slots?: Record<string, string>;
1046
1099
  }
1100
+ /**
1101
+ * @public
1102
+ */
1047
1103
  export declare enum ContentType {
1048
1104
  GENERIC = "application/vnd.amazonaws.card.generic"
1049
1105
  }
1050
1106
  /**
1107
+ * @public
1051
1108
  * <p>Represents an option to be shown on the client platform (Facebook,
1052
1109
  * Slack, etc.)</p>
1053
1110
  */
@@ -1064,6 +1121,7 @@ export interface Button {
1064
1121
  value: string | undefined;
1065
1122
  }
1066
1123
  /**
1124
+ * @public
1067
1125
  * <p>Represents an option rendered to the user when a prompt is shown. It
1068
1126
  * could be an image, a button, a link, or text. </p>
1069
1127
  */
@@ -1090,6 +1148,7 @@ export interface GenericAttachment {
1090
1148
  buttons?: Button[];
1091
1149
  }
1092
1150
  /**
1151
+ * @public
1093
1152
  * <p>If you configure a response card when creating your bots, Amazon Lex
1094
1153
  * substitutes the session attributes and slot values that are available, and
1095
1154
  * then returns it. The response card can also come from a Lambda function (
@@ -1111,6 +1170,7 @@ export interface ResponseCard {
1111
1170
  genericAttachments?: GenericAttachment[];
1112
1171
  }
1113
1172
  /**
1173
+ * @public
1114
1174
  * <p>The sentiment expressed in an utterance.</p>
1115
1175
  * <p>When the bot is configured to send utterances to Amazon Comprehend for
1116
1176
  * sentiment analysis, this field structure contains the result of the
@@ -1127,6 +1187,9 @@ export interface SentimentResponse {
1127
1187
  */
1128
1188
  sentimentScore?: string;
1129
1189
  }
1190
+ /**
1191
+ * @public
1192
+ */
1130
1193
  export interface PostTextResponse {
1131
1194
  /**
1132
1195
  * <p>The current user intent that Amazon Lex is aware of.</p>
@@ -1312,6 +1375,9 @@ export interface PostTextResponse {
1312
1375
  */
1313
1376
  activeContexts?: ActiveContext[];
1314
1377
  }
1378
+ /**
1379
+ * @public
1380
+ */
1315
1381
  export interface PutSessionRequest {
1316
1382
  /**
1317
1383
  * <p>The name of the bot that contains the session data.</p>
@@ -1429,6 +1495,9 @@ export interface PutSessionRequest {
1429
1495
  */
1430
1496
  activeContexts?: ActiveContext[];
1431
1497
  }
1498
+ /**
1499
+ * @public
1500
+ */
1432
1501
  export interface PutSessionResponse {
1433
1502
  /**
1434
1503
  * <p>Content type as specified in the <code>Accept</code> HTTP header in
@@ -13,7 +13,7 @@ import {
13
13
  ServiceOutputTypes,
14
14
  } from "../LexRuntimeServiceClient";
15
15
  import { PostContentRequest, PostContentResponse } from "../models/models_0";
16
- type PostContentCommandInputType = Pick<
16
+ export type PostContentCommandInputType = Pick<
17
17
  PostContentRequest,
18
18
  Exclude<keyof PostContentRequest, "inputStream">
19
19
  > & {
@@ -39,4 +39,3 @@ export declare class PostContentCommand extends $Command<
39
39
  private serialize;
40
40
  private deserialize;
41
41
  }
42
- export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-lex-runtime-service",
3
3
  "description": "AWS SDK for JavaScript Lex Runtime Service Client for Node.js, Browser and React Native",
4
- "version": "3.296.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",
@@ -22,9 +22,9 @@
22
22
  "dependencies": {
23
23
  "@aws-crypto/sha256-browser": "3.0.0",
24
24
  "@aws-crypto/sha256-js": "3.0.0",
25
- "@aws-sdk/client-sts": "3.296.0",
25
+ "@aws-sdk/client-sts": "3.297.0",
26
26
  "@aws-sdk/config-resolver": "3.296.0",
27
- "@aws-sdk/credential-provider-node": "3.296.0",
27
+ "@aws-sdk/credential-provider-node": "3.297.0",
28
28
  "@aws-sdk/fetch-http-handler": "3.296.0",
29
29
  "@aws-sdk/hash-node": "3.296.0",
30
30
  "@aws-sdk/invalid-dependency": "3.296.0",