1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
client: aws_smithy_client::Client<C, M, R>,
conf: crate::Config,
}
/// Client for Amazon Lex Runtime Service
///
/// Client for invoking operations on Amazon Lex Runtime Service. Each operation on Amazon Lex Runtime Service is a method on this
/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
///
/// # Examples
/// **Constructing a client and invoking an operation**
/// ```rust,no_run
/// # async fn docs() {
/// // create a shared configuration. This can be used & shared between multiple service clients.
/// let shared_config = aws_config::load_from_env().await;
/// let client = aws_sdk_lexruntime::Client::new(&shared_config);
/// // invoke an operation
/// /* let rsp = client
/// .<operationname>().
/// .<param>("some value")
/// .send().await; */
/// # }
/// ```
/// **Constructing a client with custom configuration**
/// ```rust,no_run
/// use aws_config::RetryConfig;
/// # async fn docs() {
/// let shared_config = aws_config::load_from_env().await;
/// let config = aws_sdk_lexruntime::config::Builder::from(&shared_config)
/// .retry_config(RetryConfig::disabled())
/// .build();
/// let client = aws_sdk_lexruntime::Client::from_conf(config);
/// # }
#[derive(std::fmt::Debug)]
pub struct Client<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<Handle<C, M, R>>,
}
impl<C, M, R> std::clone::Clone for Client<C, M, R> {
fn clone(&self) -> Self {
Self {
handle: self.handle.clone(),
}
}
}
#[doc(inline)]
pub use aws_smithy_client::Builder;
impl<C, M, R> From<aws_smithy_client::Client<C, M, R>> for Client<C, M, R> {
fn from(client: aws_smithy_client::Client<C, M, R>) -> Self {
Self::with_config(client, crate::Config::builder().build())
}
}
impl<C, M, R> Client<C, M, R> {
/// Creates a client with the given service configuration.
pub fn with_config(client: aws_smithy_client::Client<C, M, R>, conf: crate::Config) -> Self {
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
/// Returns the client's configuration.
pub fn conf(&self) -> &crate::Config {
&self.handle.conf
}
}
impl<C, M, R> Client<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Constructs a fluent builder for the `DeleteSession` operation.
///
/// See [`DeleteSession`](crate::client::fluent_builders::DeleteSession) for more information about the
/// operation and its arguments.
pub fn delete_session(&self) -> fluent_builders::DeleteSession<C, M, R> {
fluent_builders::DeleteSession::new(self.handle.clone())
}
/// Constructs a fluent builder for the `GetSession` operation.
///
/// See [`GetSession`](crate::client::fluent_builders::GetSession) for more information about the
/// operation and its arguments.
pub fn get_session(&self) -> fluent_builders::GetSession<C, M, R> {
fluent_builders::GetSession::new(self.handle.clone())
}
/// Constructs a fluent builder for the `PostContent` operation.
///
/// See [`PostContent`](crate::client::fluent_builders::PostContent) for more information about the
/// operation and its arguments.
pub fn post_content(&self) -> fluent_builders::PostContent<C, M, R> {
fluent_builders::PostContent::new(self.handle.clone())
}
/// Constructs a fluent builder for the `PostText` operation.
///
/// See [`PostText`](crate::client::fluent_builders::PostText) for more information about the
/// operation and its arguments.
pub fn post_text(&self) -> fluent_builders::PostText<C, M, R> {
fluent_builders::PostText::new(self.handle.clone())
}
/// Constructs a fluent builder for the `PutSession` operation.
///
/// See [`PutSession`](crate::client::fluent_builders::PutSession) for more information about the
/// operation and its arguments.
pub fn put_session(&self) -> fluent_builders::PutSession<C, M, R> {
fluent_builders::PutSession::new(self.handle.clone())
}
}
pub mod fluent_builders {
//!
//! Utilities to ergonomically construct a request to the service.
//!
//! Fluent builders are created through the [`Client`](crate::client::Client) by calling
//! one if its operation methods. After parameters are set using the builder methods,
//! the `send` method can be called to initiate the request.
//!
/// Fluent builder constructing a request to `DeleteSession`.
///
/// <p>Removes session information for a specified bot, alias, and user ID.
/// </p>
#[derive(std::fmt::Debug)]
pub struct DeleteSession<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::delete_session_input::Builder,
}
impl<C, M, R> DeleteSession<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Creates a new `DeleteSession`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle<C, M, R>>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteSessionOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteSessionError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::DeleteSessionInputOperationOutputAlias,
crate::output::DeleteSessionOutput,
crate::error::DeleteSessionError,
crate::input::DeleteSessionInputOperationRetryAlias,
>,
{
let input = self.inner.build().map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
let op = input
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// <p>The name of the bot that contains the session data.</p>
pub fn bot_name(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_name(inp);
self
}
/// <p>The name of the bot that contains the session data.</p>
pub fn set_bot_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_name(input);
self
}
/// <p>The alias in use for the bot that contains the session data.</p>
pub fn bot_alias(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_alias(inp);
self
}
/// <p>The alias in use for the bot that contains the session data.</p>
pub fn set_bot_alias(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_alias(input);
self
}
/// <p>The identifier of the user associated with the session data.</p>
pub fn user_id(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_id(inp);
self
}
/// <p>The identifier of the user associated with the session data.</p>
pub fn set_user_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_id(input);
self
}
}
/// Fluent builder constructing a request to `GetSession`.
///
/// <p>Returns session information for a specified bot, alias, and user
/// ID.</p>
#[derive(std::fmt::Debug)]
pub struct GetSession<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::get_session_input::Builder,
}
impl<C, M, R> GetSession<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Creates a new `GetSession`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle<C, M, R>>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetSessionOutput,
aws_smithy_http::result::SdkError<crate::error::GetSessionError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::GetSessionInputOperationOutputAlias,
crate::output::GetSessionOutput,
crate::error::GetSessionError,
crate::input::GetSessionInputOperationRetryAlias,
>,
{
let input = self.inner.build().map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
let op = input
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// <p>The name of the bot that contains the session data.</p>
pub fn bot_name(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_name(inp);
self
}
/// <p>The name of the bot that contains the session data.</p>
pub fn set_bot_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_name(input);
self
}
/// <p>The alias in use for the bot that contains the session data.</p>
pub fn bot_alias(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_alias(inp);
self
}
/// <p>The alias in use for the bot that contains the session data.</p>
pub fn set_bot_alias(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_alias(input);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. </p>
pub fn user_id(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_id(inp);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. </p>
pub fn set_user_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_id(input);
self
}
/// <p>A string used to filter the intents returned in the
/// <code>recentIntentSummaryView</code> structure. </p>
/// <p>When you specify a filter, only intents with their
/// <code>checkpointLabel</code> field set to that string are
/// returned.</p>
pub fn checkpoint_label_filter(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.checkpoint_label_filter(inp);
self
}
/// <p>A string used to filter the intents returned in the
/// <code>recentIntentSummaryView</code> structure. </p>
/// <p>When you specify a filter, only intents with their
/// <code>checkpointLabel</code> field set to that string are
/// returned.</p>
pub fn set_checkpoint_label_filter(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_checkpoint_label_filter(input);
self
}
}
/// Fluent builder constructing a request to `PostContent`.
///
/// <p> Sends user input (text or speech) to Amazon Lex. Clients use this API to
/// send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the
/// user input using the machine learning model that it built for the bot. </p>
/// <p>The <code>PostContent</code> operation supports audio input at 8kHz
/// and 16kHz. You can use 8kHz audio to achieve higher speech recognition
/// accuracy in telephone audio applications. </p>
/// <p> In response, Amazon Lex returns the next message to convey to the user.
/// Consider the following example messages: </p>
/// <ul>
/// <li>
/// <p> For a user input "I would like a pizza," Amazon Lex might return a
/// response with a message eliciting slot data (for example,
/// <code>PizzaSize</code>): "What size pizza would you like?". </p>
/// </li>
/// <li>
/// <p> After the user provides all of the pizza order information, Amazon Lex
/// might return a response with a message to get user confirmation:
/// "Order the pizza?". </p>
/// </li>
/// <li>
/// <p> After the user replies "Yes" to the confirmation prompt, Amazon Lex
/// might return a conclusion statement: "Thank you, your cheese pizza has
/// been ordered.". </p>
/// </li>
/// </ul>
/// <p> Not all Amazon Lex messages require a response from the user. For example,
/// conclusion statements do not require a response. Some messages require
/// only a yes or no response. In addition to the <code>message</code>, Amazon Lex
/// provides additional context about the message in the response that you can
/// use to enhance client behavior, such as displaying the appropriate client
/// user interface. Consider the following examples: </p>
/// <ul>
/// <li>
/// <p> If the message is to elicit slot data, Amazon Lex returns the
/// following context information: </p>
/// <ul>
/// <li>
/// <p>
/// <code>x-amz-lex-dialog-state</code> header set to
/// <code>ElicitSlot</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>x-amz-lex-intent-name</code> header set to the intent name
/// in the current context </p>
/// </li>
/// <li>
/// <p>
/// <code>x-amz-lex-slot-to-elicit</code> header set to the slot name
/// for which the <code>message</code> is eliciting information
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>x-amz-lex-slots</code> header set to a map of slots
/// configured for the intent with their current values </p>
/// </li>
/// </ul>
/// </li>
/// <li>
/// <p> If the message is a confirmation prompt, the
/// <code>x-amz-lex-dialog-state</code> header is set to
/// <code>Confirmation</code> and the
/// <code>x-amz-lex-slot-to-elicit</code> header is omitted. </p>
/// </li>
/// <li>
/// <p> If the message is a clarification prompt configured for the
/// intent, indicating that the user intent is not understood, the
/// <code>x-amz-dialog-state</code> header is set to
/// <code>ElicitIntent</code> and the <code>x-amz-slot-to-elicit</code>
/// header is omitted. </p>
/// </li>
/// </ul>
/// <p> In addition, Amazon Lex also returns your application-specific
/// <code>sessionAttributes</code>. For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html">Managing
/// Conversation Context</a>. </p>
#[derive(std::fmt::Debug)]
pub struct PostContent<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::post_content_input::Builder,
}
impl<C, M, R> PostContent<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Creates a new `PostContent`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle<C, M, R>>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PostContentOutput,
aws_smithy_http::result::SdkError<crate::error::PostContentError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::PostContentInputOperationOutputAlias,
crate::output::PostContentOutput,
crate::error::PostContentError,
crate::input::PostContentInputOperationRetryAlias,
>,
{
let input = self.inner.build().map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
let op = input
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// <p>Name of the Amazon Lex bot.</p>
pub fn bot_name(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_name(inp);
self
}
/// <p>Name of the Amazon Lex bot.</p>
pub fn set_bot_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_name(input);
self
}
/// <p>Alias of the Amazon Lex bot.</p>
pub fn bot_alias(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_alias(inp);
self
}
/// <p>Alias of the Amazon Lex bot.</p>
pub fn set_bot_alias(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_alias(input);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. At runtime, each request must contain
/// the <code>userID</code> field.</p>
/// <p>To decide the user ID to use for your application, consider the
/// following factors.</p>
/// <ul>
/// <li>
/// <p>The <code>userID</code> field must not contain any personally
/// identifiable information of the user, for example, name, personal
/// identification numbers, or other end user personal information.</p>
/// </li>
/// <li>
/// <p>If you want a user to start a conversation on one device and
/// continue on another device, use a user-specific identifier.</p>
/// </li>
/// <li>
/// <p>If you want the same user to be able to have two independent
/// conversations on two different devices, choose a device-specific
/// identifier.</p>
/// </li>
/// <li>
/// <p>A user can't have two independent conversations with two different
/// versions of the same bot. For example, a user can't have a
/// conversation with the PROD and BETA versions of the same bot. If you
/// anticipate that a user will need to have conversation with two
/// different versions, for example, while testing, include the bot alias
/// in the user ID to separate the two conversations.</p>
/// </li>
/// </ul>
pub fn user_id(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_id(inp);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. At runtime, each request must contain
/// the <code>userID</code> field.</p>
/// <p>To decide the user ID to use for your application, consider the
/// following factors.</p>
/// <ul>
/// <li>
/// <p>The <code>userID</code> field must not contain any personally
/// identifiable information of the user, for example, name, personal
/// identification numbers, or other end user personal information.</p>
/// </li>
/// <li>
/// <p>If you want a user to start a conversation on one device and
/// continue on another device, use a user-specific identifier.</p>
/// </li>
/// <li>
/// <p>If you want the same user to be able to have two independent
/// conversations on two different devices, choose a device-specific
/// identifier.</p>
/// </li>
/// <li>
/// <p>A user can't have two independent conversations with two different
/// versions of the same bot. For example, a user can't have a
/// conversation with the PROD and BETA versions of the same bot. If you
/// anticipate that a user will need to have conversation with two
/// different versions, for example, while testing, include the bot alias
/// in the user ID to separate the two conversations.</p>
/// </li>
/// </ul>
pub fn set_user_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_id(input);
self
}
/// <p>You pass this value as the <code>x-amz-lex-session-attributes</code>
/// HTTP header.</p>
/// <p>Application-specific information passed between Amazon Lex and a client
/// application. The value must be a JSON serialized and base64 encoded map
/// with string keys and values. The total size of the
/// <code>sessionAttributes</code> and <code>requestAttributes</code>
/// headers is limited to 12 KB.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs">Setting Session Attributes</a>.</p>
pub fn session_attributes(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.session_attributes(inp);
self
}
/// <p>You pass this value as the <code>x-amz-lex-session-attributes</code>
/// HTTP header.</p>
/// <p>Application-specific information passed between Amazon Lex and a client
/// application. The value must be a JSON serialized and base64 encoded map
/// with string keys and values. The total size of the
/// <code>sessionAttributes</code> and <code>requestAttributes</code>
/// headers is limited to 12 KB.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs">Setting Session Attributes</a>.</p>
pub fn set_session_attributes(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_session_attributes(input);
self
}
/// <p>You pass this value as the <code>x-amz-lex-request-attributes</code>
/// HTTP header.</p>
/// <p>Request-specific information passed between Amazon Lex and a client
/// application. The value must be a JSON serialized and base64 encoded map
/// with string keys and values. The total size of the
/// <code>requestAttributes</code> and <code>sessionAttributes</code>
/// headers is limited to 12 KB.</p>
/// <p>The namespace <code>x-amz-lex:</code> is reserved for special
/// attributes. Don't create any request attributes with the prefix
/// <code>x-amz-lex:</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs">Setting Request Attributes</a>.</p>
pub fn request_attributes(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.request_attributes(inp);
self
}
/// <p>You pass this value as the <code>x-amz-lex-request-attributes</code>
/// HTTP header.</p>
/// <p>Request-specific information passed between Amazon Lex and a client
/// application. The value must be a JSON serialized and base64 encoded map
/// with string keys and values. The total size of the
/// <code>requestAttributes</code> and <code>sessionAttributes</code>
/// headers is limited to 12 KB.</p>
/// <p>The namespace <code>x-amz-lex:</code> is reserved for special
/// attributes. Don't create any request attributes with the prefix
/// <code>x-amz-lex:</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs">Setting Request Attributes</a>.</p>
pub fn set_request_attributes(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_request_attributes(input);
self
}
/// <p> You pass this value as the <code>Content-Type</code> HTTP header. </p>
/// <p> Indicates the audio format or text. The header value must start with
/// one of the following prefixes: </p>
/// <ul>
/// <li>
/// <p>PCM format, audio data must be in little-endian byte order.</p>
/// <ul>
/// <li>
/// <p>audio/l16; rate=16000; channels=1</p>
/// </li>
/// <li>
/// <p>audio/x-l16; sample-rate=16000; channel-count=1</p>
/// </li>
/// <li>
/// <p>audio/lpcm; sample-rate=8000; sample-size-bits=16;
/// channel-count=1; is-big-endian=false </p>
/// </li>
/// </ul>
/// </li>
/// <li>
/// <p>Opus format</p>
/// <ul>
/// <li>
/// <p>audio/x-cbr-opus-with-preamble; preamble-size=0;
/// bit-rate=256000; frame-size-milliseconds=4</p>
/// </li>
/// </ul>
/// </li>
/// <li>
/// <p>Text format</p>
/// <ul>
/// <li>
/// <p>text/plain; charset=utf-8</p>
/// </li>
/// </ul>
/// </li>
/// </ul>
pub fn content_type(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.content_type(inp);
self
}
/// <p> You pass this value as the <code>Content-Type</code> HTTP header. </p>
/// <p> Indicates the audio format or text. The header value must start with
/// one of the following prefixes: </p>
/// <ul>
/// <li>
/// <p>PCM format, audio data must be in little-endian byte order.</p>
/// <ul>
/// <li>
/// <p>audio/l16; rate=16000; channels=1</p>
/// </li>
/// <li>
/// <p>audio/x-l16; sample-rate=16000; channel-count=1</p>
/// </li>
/// <li>
/// <p>audio/lpcm; sample-rate=8000; sample-size-bits=16;
/// channel-count=1; is-big-endian=false </p>
/// </li>
/// </ul>
/// </li>
/// <li>
/// <p>Opus format</p>
/// <ul>
/// <li>
/// <p>audio/x-cbr-opus-with-preamble; preamble-size=0;
/// bit-rate=256000; frame-size-milliseconds=4</p>
/// </li>
/// </ul>
/// </li>
/// <li>
/// <p>Text format</p>
/// <ul>
/// <li>
/// <p>text/plain; charset=utf-8</p>
/// </li>
/// </ul>
/// </li>
/// </ul>
pub fn set_content_type(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_content_type(input);
self
}
/// <p> You pass this value as the <code>Accept</code> HTTP header. </p>
/// <p> The message Amazon Lex returns in the response can be either text or
/// speech based on the <code>Accept</code> HTTP header value in the request. </p>
/// <ul>
/// <li>
/// <p> If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex
/// returns text in the response. </p>
/// </li>
/// <li>
/// <p> If the value begins with <code>audio/</code>, Amazon Lex returns
/// speech in the response. Amazon Lex uses Amazon Polly to generate the speech
/// (using the configuration you specified in the <code>Accept</code>
/// header). For example, if you specify <code>audio/mpeg</code> as the
/// value, Amazon Lex returns speech in the MPEG format.</p>
/// </li>
/// <li>
/// <p>If the value is <code>audio/pcm</code>, the speech returned is
/// <code>audio/pcm</code> in 16-bit, little endian format.
/// </p>
/// </li>
/// <li>
/// <p>The following are the accepted values:</p>
/// <ul>
/// <li>
/// <p>audio/mpeg</p>
/// </li>
/// <li>
/// <p>audio/ogg</p>
/// </li>
/// <li>
/// <p>audio/pcm</p>
/// </li>
/// <li>
/// <p>text/plain; charset=utf-8</p>
/// </li>
/// <li>
/// <p>audio/* (defaults to mpeg)</p>
/// </li>
/// </ul>
/// </li>
/// </ul>
pub fn accept(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.accept(inp);
self
}
/// <p> You pass this value as the <code>Accept</code> HTTP header. </p>
/// <p> The message Amazon Lex returns in the response can be either text or
/// speech based on the <code>Accept</code> HTTP header value in the request. </p>
/// <ul>
/// <li>
/// <p> If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex
/// returns text in the response. </p>
/// </li>
/// <li>
/// <p> If the value begins with <code>audio/</code>, Amazon Lex returns
/// speech in the response. Amazon Lex uses Amazon Polly to generate the speech
/// (using the configuration you specified in the <code>Accept</code>
/// header). For example, if you specify <code>audio/mpeg</code> as the
/// value, Amazon Lex returns speech in the MPEG format.</p>
/// </li>
/// <li>
/// <p>If the value is <code>audio/pcm</code>, the speech returned is
/// <code>audio/pcm</code> in 16-bit, little endian format.
/// </p>
/// </li>
/// <li>
/// <p>The following are the accepted values:</p>
/// <ul>
/// <li>
/// <p>audio/mpeg</p>
/// </li>
/// <li>
/// <p>audio/ogg</p>
/// </li>
/// <li>
/// <p>audio/pcm</p>
/// </li>
/// <li>
/// <p>text/plain; charset=utf-8</p>
/// </li>
/// <li>
/// <p>audio/* (defaults to mpeg)</p>
/// </li>
/// </ul>
/// </li>
/// </ul>
pub fn set_accept(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_accept(input);
self
}
/// <p> User input in PCM or Opus audio format or text format as described in
/// the <code>Content-Type</code> HTTP header. </p>
/// <p>You can stream audio data to Amazon Lex or you can create a local buffer
/// that captures all of the audio data before sending. In general, you get
/// better performance if you stream audio data rather than buffering the data
/// locally.</p>
pub fn input_stream(mut self, inp: aws_smithy_http::byte_stream::ByteStream) -> Self {
self.inner = self.inner.input_stream(inp);
self
}
/// <p> User input in PCM or Opus audio format or text format as described in
/// the <code>Content-Type</code> HTTP header. </p>
/// <p>You can stream audio data to Amazon Lex or you can create a local buffer
/// that captures all of the audio data before sending. In general, you get
/// better performance if you stream audio data rather than buffering the data
/// locally.</p>
pub fn set_input_stream(
mut self,
input: std::option::Option<aws_smithy_http::byte_stream::ByteStream>,
) -> Self {
self.inner = self.inner.set_input_stream(input);
self
}
/// <p>A list of contexts active for the request. A context can be activated
/// when a previous intent is fulfilled, or by including the context in the
/// request,</p>
/// <p>If you don't specify a list of contexts, Amazon Lex will use the current
/// list of contexts for the session. If you specify an empty list, all
/// contexts for the session are cleared.</p>
pub fn active_contexts(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.active_contexts(inp);
self
}
/// <p>A list of contexts active for the request. A context can be activated
/// when a previous intent is fulfilled, or by including the context in the
/// request,</p>
/// <p>If you don't specify a list of contexts, Amazon Lex will use the current
/// list of contexts for the session. If you specify an empty list, all
/// contexts for the session are cleared.</p>
pub fn set_active_contexts(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_active_contexts(input);
self
}
}
/// Fluent builder constructing a request to `PostText`.
///
/// <p>Sends user input to Amazon Lex. Client applications can use this API to
/// send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input
/// using the machine learning model it built for the bot. </p>
/// <p> In response, Amazon Lex returns the next <code>message</code> to convey to
/// the user an optional <code>responseCard</code> to display. Consider the
/// following example messages: </p>
/// <ul>
/// <li>
/// <p> For a user input "I would like a pizza", Amazon Lex might return a
/// response with a message eliciting slot data (for example, PizzaSize):
/// "What size pizza would you like?" </p>
/// </li>
/// <li>
/// <p> After the user provides all of the pizza order information,
/// Amazon Lex might return a response with a message to obtain user
/// confirmation "Proceed with the pizza order?". </p>
/// </li>
/// <li>
/// <p> After the user replies to a confirmation prompt with a "yes",
/// Amazon Lex might return a conclusion statement: "Thank you, your cheese
/// pizza has been ordered.". </p>
/// </li>
/// </ul>
///
/// <p> Not all Amazon Lex messages require a user response. For example, a
/// conclusion statement does not require a response. Some messages require
/// only a "yes" or "no" user response. In addition to the
/// <code>message</code>, Amazon Lex provides additional context about the
/// message in the response that you might use to enhance client behavior, for
/// example, to display the appropriate client user interface. These are the
/// <code>slotToElicit</code>, <code>dialogState</code>,
/// <code>intentName</code>, and <code>slots</code> fields in the response.
/// Consider the following examples: </p>
///
/// <ul>
/// <li>
/// <p>If the message is to elicit slot data, Amazon Lex returns the
/// following context information:</p>
/// <ul>
/// <li>
/// <p>
/// <code>dialogState</code> set to ElicitSlot </p>
/// </li>
/// <li>
/// <p>
/// <code>intentName</code> set to the intent name in the current
/// context </p>
/// </li>
/// <li>
/// <p>
/// <code>slotToElicit</code> set to the slot name for which the
/// <code>message</code> is eliciting information </p>
/// </li>
/// <li>
/// <p>
/// <code>slots</code> set to a map of slots, configured for the
/// intent, with currently known values </p>
/// </li>
/// </ul>
/// </li>
/// <li>
/// <p> If the message is a confirmation prompt, the
/// <code>dialogState</code> is set to ConfirmIntent and
/// <code>SlotToElicit</code> is set to null. </p>
/// </li>
/// <li>
/// <p>If the message is a clarification prompt (configured for the
/// intent) that indicates that user intent is not understood, the
/// <code>dialogState</code> is set to ElicitIntent and
/// <code>slotToElicit</code> is set to null. </p>
/// </li>
/// </ul>
///
/// <p> In addition, Amazon Lex also returns your application-specific
/// <code>sessionAttributes</code>. For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html">Managing
/// Conversation Context</a>. </p>
#[derive(std::fmt::Debug)]
pub struct PostText<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::post_text_input::Builder,
}
impl<C, M, R> PostText<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Creates a new `PostText`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle<C, M, R>>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PostTextOutput,
aws_smithy_http::result::SdkError<crate::error::PostTextError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::PostTextInputOperationOutputAlias,
crate::output::PostTextOutput,
crate::error::PostTextError,
crate::input::PostTextInputOperationRetryAlias,
>,
{
let input = self.inner.build().map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
let op = input
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// <p>The name of the Amazon Lex bot.</p>
pub fn bot_name(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_name(inp);
self
}
/// <p>The name of the Amazon Lex bot.</p>
pub fn set_bot_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_name(input);
self
}
/// <p>The alias of the Amazon Lex bot.</p>
pub fn bot_alias(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_alias(inp);
self
}
/// <p>The alias of the Amazon Lex bot.</p>
pub fn set_bot_alias(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_alias(input);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. At runtime, each request must contain
/// the <code>userID</code> field.</p>
/// <p>To decide the user ID to use for your application, consider the
/// following factors.</p>
/// <ul>
/// <li>
/// <p>The <code>userID</code> field must not contain any personally
/// identifiable information of the user, for example, name, personal
/// identification numbers, or other end user personal information.</p>
/// </li>
/// <li>
/// <p>If you want a user to start a conversation on one device and
/// continue on another device, use a user-specific identifier.</p>
/// </li>
/// <li>
/// <p>If you want the same user to be able to have two independent
/// conversations on two different devices, choose a device-specific
/// identifier.</p>
/// </li>
/// <li>
/// <p>A user can't have two independent conversations with two different
/// versions of the same bot. For example, a user can't have a
/// conversation with the PROD and BETA versions of the same bot. If you
/// anticipate that a user will need to have conversation with two
/// different versions, for example, while testing, include the bot alias
/// in the user ID to separate the two conversations.</p>
/// </li>
/// </ul>
pub fn user_id(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_id(inp);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. At runtime, each request must contain
/// the <code>userID</code> field.</p>
/// <p>To decide the user ID to use for your application, consider the
/// following factors.</p>
/// <ul>
/// <li>
/// <p>The <code>userID</code> field must not contain any personally
/// identifiable information of the user, for example, name, personal
/// identification numbers, or other end user personal information.</p>
/// </li>
/// <li>
/// <p>If you want a user to start a conversation on one device and
/// continue on another device, use a user-specific identifier.</p>
/// </li>
/// <li>
/// <p>If you want the same user to be able to have two independent
/// conversations on two different devices, choose a device-specific
/// identifier.</p>
/// </li>
/// <li>
/// <p>A user can't have two independent conversations with two different
/// versions of the same bot. For example, a user can't have a
/// conversation with the PROD and BETA versions of the same bot. If you
/// anticipate that a user will need to have conversation with two
/// different versions, for example, while testing, include the bot alias
/// in the user ID to separate the two conversations.</p>
/// </li>
/// </ul>
pub fn set_user_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_id(input);
self
}
/// Adds a key-value pair to `sessionAttributes`.
///
/// To override the contents of this collection use [`set_session_attributes`](Self::set_session_attributes).
///
/// <p>Application-specific information passed between Amazon Lex and a client
/// application.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs">Setting Session Attributes</a>.</p>
pub fn session_attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.session_attributes(k, v);
self
}
/// <p>Application-specific information passed between Amazon Lex and a client
/// application.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs">Setting Session Attributes</a>.</p>
pub fn set_session_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_session_attributes(input);
self
}
/// Adds a key-value pair to `requestAttributes`.
///
/// To override the contents of this collection use [`set_request_attributes`](Self::set_request_attributes).
///
/// <p>Request-specific information passed between Amazon Lex and a client
/// application.</p>
/// <p>The namespace <code>x-amz-lex:</code> is reserved for special
/// attributes. Don't create any request attributes with the prefix
/// <code>x-amz-lex:</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs">Setting Request Attributes</a>.</p>
pub fn request_attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.request_attributes(k, v);
self
}
/// <p>Request-specific information passed between Amazon Lex and a client
/// application.</p>
/// <p>The namespace <code>x-amz-lex:</code> is reserved for special
/// attributes. Don't create any request attributes with the prefix
/// <code>x-amz-lex:</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs">Setting Request Attributes</a>.</p>
pub fn set_request_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_request_attributes(input);
self
}
/// <p>The text that the user entered (Amazon Lex interprets this text).</p>
pub fn input_text(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.input_text(inp);
self
}
/// <p>The text that the user entered (Amazon Lex interprets this text).</p>
pub fn set_input_text(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_input_text(input);
self
}
/// Appends an item to `activeContexts`.
///
/// To override the contents of this collection use [`set_active_contexts`](Self::set_active_contexts).
///
/// <p>A list of contexts active for the request. A context can be activated
/// when a previous intent is fulfilled, or by including the context in the
/// request,</p>
/// <p>If you don't specify a list of contexts, Amazon Lex will use the current
/// list of contexts for the session. If you specify an empty list, all
/// contexts for the session are cleared.</p>
pub fn active_contexts(mut self, inp: impl Into<crate::model::ActiveContext>) -> Self {
self.inner = self.inner.active_contexts(inp);
self
}
/// <p>A list of contexts active for the request. A context can be activated
/// when a previous intent is fulfilled, or by including the context in the
/// request,</p>
/// <p>If you don't specify a list of contexts, Amazon Lex will use the current
/// list of contexts for the session. If you specify an empty list, all
/// contexts for the session are cleared.</p>
pub fn set_active_contexts(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::ActiveContext>>,
) -> Self {
self.inner = self.inner.set_active_contexts(input);
self
}
}
/// Fluent builder constructing a request to `PutSession`.
///
/// <p>Creates a new session or modifies an existing session with an Amazon Lex
/// bot. Use this operation to enable your application to set the state of the
/// bot.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html">Managing
/// Sessions</a>.</p>
#[derive(std::fmt::Debug)]
pub struct PutSession<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::put_session_input::Builder,
}
impl<C, M, R> PutSession<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Creates a new `PutSession`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle<C, M, R>>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PutSessionOutput,
aws_smithy_http::result::SdkError<crate::error::PutSessionError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::PutSessionInputOperationOutputAlias,
crate::output::PutSessionOutput,
crate::error::PutSessionError,
crate::input::PutSessionInputOperationRetryAlias,
>,
{
let input = self.inner.build().map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
let op = input
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// <p>The name of the bot that contains the session data.</p>
pub fn bot_name(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_name(inp);
self
}
/// <p>The name of the bot that contains the session data.</p>
pub fn set_bot_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_name(input);
self
}
/// <p>The alias in use for the bot that contains the session data.</p>
pub fn bot_alias(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.bot_alias(inp);
self
}
/// <p>The alias in use for the bot that contains the session data.</p>
pub fn set_bot_alias(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_bot_alias(input);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. </p>
pub fn user_id(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_id(inp);
self
}
/// <p>The ID of the client application user. Amazon Lex uses this to identify a
/// user's conversation with your bot. </p>
pub fn set_user_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_id(input);
self
}
/// Adds a key-value pair to `sessionAttributes`.
///
/// To override the contents of this collection use [`set_session_attributes`](Self::set_session_attributes).
///
/// <p>Map of key/value pairs representing the session-specific context
/// information. It contains application information passed between Amazon Lex and
/// a client application.</p>
pub fn session_attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.session_attributes(k, v);
self
}
/// <p>Map of key/value pairs representing the session-specific context
/// information. It contains application information passed between Amazon Lex and
/// a client application.</p>
pub fn set_session_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_session_attributes(input);
self
}
/// <p>Sets the next action that the bot should take to fulfill the
/// conversation.</p>
pub fn dialog_action(mut self, inp: crate::model::DialogAction) -> Self {
self.inner = self.inner.dialog_action(inp);
self
}
/// <p>Sets the next action that the bot should take to fulfill the
/// conversation.</p>
pub fn set_dialog_action(
mut self,
input: std::option::Option<crate::model::DialogAction>,
) -> Self {
self.inner = self.inner.set_dialog_action(input);
self
}
/// Appends an item to `recentIntentSummaryView`.
///
/// To override the contents of this collection use [`set_recent_intent_summary_view`](Self::set_recent_intent_summary_view).
///
/// <p>A summary of the recent intents for the bot. You can use the intent
/// summary view to set a checkpoint label on an intent and modify attributes
/// of intents. You can also use it to remove or add intent summary objects to
/// the list.</p>
/// <p>An intent that you modify or add to the list must make sense for the
/// bot. For example, the intent name must be valid for the bot. You must
/// provide valid values for:</p>
/// <ul>
/// <li>
/// <p>
/// <code>intentName</code>
/// </p>
/// </li>
/// <li>
/// <p>slot names</p>
/// </li>
/// <li>
/// <p>
/// <code>slotToElict</code>
/// </p>
/// </li>
/// </ul>
/// <p>If you send the <code>recentIntentSummaryView</code> parameter in a
/// <code>PutSession</code> request, the contents of the new summary view
/// replaces the old summary view. For example, if a <code>GetSession</code>
/// request returns three intents in the summary view and you call
/// <code>PutSession</code> with one intent in the summary view, the next
/// call to <code>GetSession</code> will only return one intent.</p>
pub fn recent_intent_summary_view(
mut self,
inp: impl Into<crate::model::IntentSummary>,
) -> Self {
self.inner = self.inner.recent_intent_summary_view(inp);
self
}
/// <p>A summary of the recent intents for the bot. You can use the intent
/// summary view to set a checkpoint label on an intent and modify attributes
/// of intents. You can also use it to remove or add intent summary objects to
/// the list.</p>
/// <p>An intent that you modify or add to the list must make sense for the
/// bot. For example, the intent name must be valid for the bot. You must
/// provide valid values for:</p>
/// <ul>
/// <li>
/// <p>
/// <code>intentName</code>
/// </p>
/// </li>
/// <li>
/// <p>slot names</p>
/// </li>
/// <li>
/// <p>
/// <code>slotToElict</code>
/// </p>
/// </li>
/// </ul>
/// <p>If you send the <code>recentIntentSummaryView</code> parameter in a
/// <code>PutSession</code> request, the contents of the new summary view
/// replaces the old summary view. For example, if a <code>GetSession</code>
/// request returns three intents in the summary view and you call
/// <code>PutSession</code> with one intent in the summary view, the next
/// call to <code>GetSession</code> will only return one intent.</p>
pub fn set_recent_intent_summary_view(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::IntentSummary>>,
) -> Self {
self.inner = self.inner.set_recent_intent_summary_view(input);
self
}
/// <p>The message that Amazon Lex returns in the response can be either text or
/// speech based depending on the value of this field.</p>
/// <ul>
/// <li>
/// <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex
/// returns text in the response.</p>
/// </li>
/// <li>
/// <p>If the value begins with <code>audio/</code>, Amazon Lex returns speech
/// in the response. Amazon Lex uses Amazon Polly to generate the speech in the
/// configuration that you specify. For example, if you specify
/// <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the
/// MPEG format.</p>
/// </li>
/// <li>
/// <p>If the value is <code>audio/pcm</code>, the speech is returned as
/// <code>audio/pcm</code> in 16-bit, little endian format.</p>
/// </li>
/// <li>
/// <p>The following are the accepted values:</p>
/// <ul>
/// <li>
/// <p>
/// <code>audio/mpeg</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>audio/ogg</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>audio/pcm</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>audio/*</code> (defaults to mpeg)</p>
/// </li>
/// <li>
/// <p>
/// <code>text/plain; charset=utf-8</code>
/// </p>
/// </li>
/// </ul>
/// </li>
/// </ul>
pub fn accept(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.accept(inp);
self
}
/// <p>The message that Amazon Lex returns in the response can be either text or
/// speech based depending on the value of this field.</p>
/// <ul>
/// <li>
/// <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex
/// returns text in the response.</p>
/// </li>
/// <li>
/// <p>If the value begins with <code>audio/</code>, Amazon Lex returns speech
/// in the response. Amazon Lex uses Amazon Polly to generate the speech in the
/// configuration that you specify. For example, if you specify
/// <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the
/// MPEG format.</p>
/// </li>
/// <li>
/// <p>If the value is <code>audio/pcm</code>, the speech is returned as
/// <code>audio/pcm</code> in 16-bit, little endian format.</p>
/// </li>
/// <li>
/// <p>The following are the accepted values:</p>
/// <ul>
/// <li>
/// <p>
/// <code>audio/mpeg</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>audio/ogg</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>audio/pcm</code>
/// </p>
/// </li>
/// <li>
/// <p>
/// <code>audio/*</code> (defaults to mpeg)</p>
/// </li>
/// <li>
/// <p>
/// <code>text/plain; charset=utf-8</code>
/// </p>
/// </li>
/// </ul>
/// </li>
/// </ul>
pub fn set_accept(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_accept(input);
self
}
/// Appends an item to `activeContexts`.
///
/// To override the contents of this collection use [`set_active_contexts`](Self::set_active_contexts).
///
/// <p>A list of contexts active for the request. A context can be activated
/// when a previous intent is fulfilled, or by including the context in the
/// request,</p>
/// <p>If you don't specify a list of contexts, Amazon Lex will use the current
/// list of contexts for the session. If you specify an empty list, all
/// contexts for the session are cleared.</p>
pub fn active_contexts(mut self, inp: impl Into<crate::model::ActiveContext>) -> Self {
self.inner = self.inner.active_contexts(inp);
self
}
/// <p>A list of contexts active for the request. A context can be activated
/// when a previous intent is fulfilled, or by including the context in the
/// request,</p>
/// <p>If you don't specify a list of contexts, Amazon Lex will use the current
/// list of contexts for the session. If you specify an empty list, all
/// contexts for the session are cleared.</p>
pub fn set_active_contexts(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::ActiveContext>>,
) -> Self {
self.inner = self.inner.set_active_contexts(input);
self
}
}
}
impl<C> Client<C, aws_hyper::AwsMiddleware, aws_smithy_client::retry::Standard> {
/// Creates a client with the given service config and connector override.
pub fn from_conf_conn(conf: crate::Config, conn: C) -> Self {
let retry_config = conf.retry_config.as_ref().cloned().unwrap_or_default();
let timeout_config = conf.timeout_config.as_ref().cloned().unwrap_or_default();
let sleep_impl = conf.sleep_impl.clone();
let mut client = aws_hyper::Client::new(conn)
.with_retry_config(retry_config.into())
.with_timeout_config(timeout_config);
client.set_sleep_impl(sleep_impl);
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}
impl
Client<
aws_smithy_client::erase::DynConnector,
aws_hyper::AwsMiddleware,
aws_smithy_client::retry::Standard,
>
{
/// Creates a new client from a shared config.
#[cfg(any(feature = "rustls", feature = "native-tls"))]
pub fn new(config: &aws_types::config::Config) -> Self {
Self::from_conf(config.into())
}
/// Creates a new client from the service [`Config`](crate::Config).
#[cfg(any(feature = "rustls", feature = "native-tls"))]
pub fn from_conf(conf: crate::Config) -> Self {
let retry_config = conf.retry_config.as_ref().cloned().unwrap_or_default();
let timeout_config = conf.timeout_config.as_ref().cloned().unwrap_or_default();
let sleep_impl = conf.sleep_impl.clone();
let mut client = aws_hyper::Client::https()
.with_retry_config(retry_config.into())
.with_timeout_config(timeout_config);
client.set_sleep_impl(sleep_impl);
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}