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 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
// 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 = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
pub(crate) client: aws_smithy_client::Client<C, M, R>,
pub(crate) conf: crate::Config,
}
/// Client for Redshift Data API Service
///
/// Client for invoking operations on Redshift Data API Service. Each operation on Redshift Data API 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_redshiftdata::Client::new(&shared_config);
/// // invoke an operation
/// /* let rsp = client
/// .<operation_name>().
/// .<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_redshiftdata::config::Builder::from(&shared_config)
/// .retry_config(RetryConfig::disabled())
/// .build();
/// let client = aws_sdk_redshiftdata::Client::from_conf(config);
/// # }
#[derive(std::fmt::Debug)]
pub struct Client<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
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 [`BatchExecuteStatement`](crate::client::fluent_builders::BatchExecuteStatement) operation.
///
/// - The fluent builder is configurable:
/// - [`sqls(Vec<String>)`](crate::client::fluent_builders::BatchExecuteStatement::sqls) / [`set_sqls(Option<Vec<String>>)`](crate::client::fluent_builders::BatchExecuteStatement::set_sqls): <p>One or more SQL statements to run. </p>
/// - [`cluster_identifier(impl Into<String>)`](crate::client::fluent_builders::BatchExecuteStatement::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::client::fluent_builders::BatchExecuteStatement::set_cluster_identifier): <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`secret_arn(impl Into<String>)`](crate::client::fluent_builders::BatchExecuteStatement::secret_arn) / [`set_secret_arn(Option<String>)`](crate::client::fluent_builders::BatchExecuteStatement::set_secret_arn): <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
/// - [`db_user(impl Into<String>)`](crate::client::fluent_builders::BatchExecuteStatement::db_user) / [`set_db_user(Option<String>)`](crate::client::fluent_builders::BatchExecuteStatement::set_db_user): <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
/// - [`database(impl Into<String>)`](crate::client::fluent_builders::BatchExecuteStatement::database) / [`set_database(Option<String>)`](crate::client::fluent_builders::BatchExecuteStatement::set_database): <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`with_event(bool)`](crate::client::fluent_builders::BatchExecuteStatement::with_event) / [`set_with_event(Option<bool>)`](crate::client::fluent_builders::BatchExecuteStatement::set_with_event): <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
/// - [`statement_name(impl Into<String>)`](crate::client::fluent_builders::BatchExecuteStatement::statement_name) / [`set_statement_name(Option<String>)`](crate::client::fluent_builders::BatchExecuteStatement::set_statement_name): <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
/// - On success, responds with [`BatchExecuteStatementOutput`](crate::output::BatchExecuteStatementOutput) with field(s):
/// - [`id(Option<String>)`](crate::output::BatchExecuteStatementOutput::id): <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>. </p>
/// - [`created_at(Option<DateTime>)`](crate::output::BatchExecuteStatementOutput::created_at): <p>The date and time (UTC) the statement was created. </p>
/// - [`cluster_identifier(Option<String>)`](crate::output::BatchExecuteStatementOutput::cluster_identifier): <p>The cluster identifier. This parameter is not returned when connecting to a serverless endpoint. </p>
/// - [`db_user(Option<String>)`](crate::output::BatchExecuteStatementOutput::db_user): <p>The database user name.</p>
/// - [`database(Option<String>)`](crate::output::BatchExecuteStatementOutput::database): <p>The name of the database.</p>
/// - [`secret_arn(Option<String>)`](crate::output::BatchExecuteStatementOutput::secret_arn): <p>The name or ARN of the secret that enables access to the database. </p>
/// - On failure, responds with [`SdkError<BatchExecuteStatementError>`](crate::error::BatchExecuteStatementError)
pub fn batch_execute_statement(&self) -> fluent_builders::BatchExecuteStatement<C, M, R> {
fluent_builders::BatchExecuteStatement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CancelStatement`](crate::client::fluent_builders::CancelStatement) operation.
///
/// - The fluent builder is configurable:
/// - [`id(impl Into<String>)`](crate::client::fluent_builders::CancelStatement::id) / [`set_id(Option<String>)`](crate::client::fluent_builders::CancelStatement::set_id): <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
/// - On success, responds with [`CancelStatementOutput`](crate::output::CancelStatementOutput) with field(s):
/// - [`status(Option<bool>)`](crate::output::CancelStatementOutput::status): <p>A value that indicates whether the cancel statement succeeded (true). </p>
/// - On failure, responds with [`SdkError<CancelStatementError>`](crate::error::CancelStatementError)
pub fn cancel_statement(&self) -> fluent_builders::CancelStatement<C, M, R> {
fluent_builders::CancelStatement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeStatement`](crate::client::fluent_builders::DescribeStatement) operation.
///
/// - The fluent builder is configurable:
/// - [`id(impl Into<String>)`](crate::client::fluent_builders::DescribeStatement::id) / [`set_id(Option<String>)`](crate::client::fluent_builders::DescribeStatement::set_id): <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
/// - On success, responds with [`DescribeStatementOutput`](crate::output::DescribeStatementOutput) with field(s):
/// - [`id(Option<String>)`](crate::output::DescribeStatementOutput::id): <p>The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
/// - [`secret_arn(Option<String>)`](crate::output::DescribeStatementOutput::secret_arn): <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
/// - [`db_user(Option<String>)`](crate::output::DescribeStatementOutput::db_user): <p>The database user name. </p>
/// - [`database(Option<String>)`](crate::output::DescribeStatementOutput::database): <p>The name of the database. </p>
/// - [`cluster_identifier(Option<String>)`](crate::output::DescribeStatementOutput::cluster_identifier): <p>The cluster identifier. </p>
/// - [`duration(i64)`](crate::output::DescribeStatementOutput::duration): <p>The amount of time in nanoseconds that the statement ran. </p>
/// - [`error(Option<String>)`](crate::output::DescribeStatementOutput::error): <p>The error message from the cluster if the SQL statement encountered an error while running. </p>
/// - [`status(Option<StatusString>)`](crate::output::DescribeStatementOutput::status): <p>The status of the SQL statement being described. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>
/// - [`created_at(Option<DateTime>)`](crate::output::DescribeStatementOutput::created_at): <p>The date and time (UTC) when the SQL statement was submitted to run. </p>
/// - [`updated_at(Option<DateTime>)`](crate::output::DescribeStatementOutput::updated_at): <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed. </p>
/// - [`redshift_pid(i64)`](crate::output::DescribeStatementOutput::redshift_pid): <p>The process identifier from Amazon Redshift. </p>
/// - [`has_result_set(Option<bool>)`](crate::output::DescribeStatementOutput::has_result_set): <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.</p>
/// - [`query_string(Option<String>)`](crate::output::DescribeStatementOutput::query_string): <p>The SQL statement text. </p>
/// - [`result_rows(i64)`](crate::output::DescribeStatementOutput::result_rows): <p>Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A <code>-1</code> indicates the value is null.</p>
/// - [`result_size(i64)`](crate::output::DescribeStatementOutput::result_size): <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
/// - [`redshift_query_id(i64)`](crate::output::DescribeStatementOutput::redshift_query_id): <p>The identifier of the query generated by Amazon Redshift. These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
/// - [`query_parameters(Option<Vec<SqlParameter>>)`](crate::output::DescribeStatementOutput::query_parameters): <p>The parameters for the SQL statement.</p>
/// - [`sub_statements(Option<Vec<SubStatementData>>)`](crate::output::DescribeStatementOutput::sub_statements): <p>The SQL statements from a multiple statement run.</p>
/// - On failure, responds with [`SdkError<DescribeStatementError>`](crate::error::DescribeStatementError)
pub fn describe_statement(&self) -> fluent_builders::DescribeStatement<C, M, R> {
fluent_builders::DescribeStatement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeTable`](crate::client::fluent_builders::DescribeTable) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeTable::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`cluster_identifier(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_cluster_identifier): <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`secret_arn(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::secret_arn) / [`set_secret_arn(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_secret_arn): <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
/// - [`db_user(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::db_user) / [`set_db_user(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_db_user): <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
/// - [`database(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::database) / [`set_database(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_database): <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
/// - [`connected_database(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::connected_database) / [`set_connected_database(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_connected_database): <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
/// - [`schema(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::schema) / [`set_schema(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_schema): <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
/// - [`table(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::table) / [`set_table(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_table): <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeTable::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeTable::set_next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - [`max_results(i32)`](crate::client::fluent_builders::DescribeTable::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::DescribeTable::set_max_results): <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
/// - On success, responds with [`DescribeTableOutput`](crate::output::DescribeTableOutput) with field(s):
/// - [`table_name(Option<String>)`](crate::output::DescribeTableOutput::table_name): <p>The table name. </p>
/// - [`column_list(Option<Vec<ColumnMetadata>>)`](crate::output::DescribeTableOutput::column_list): <p>A list of columns in the table. </p>
/// - [`next_token(Option<String>)`](crate::output::DescribeTableOutput::next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On failure, responds with [`SdkError<DescribeTableError>`](crate::error::DescribeTableError)
pub fn describe_table(&self) -> fluent_builders::DescribeTable<C, M, R> {
fluent_builders::DescribeTable::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ExecuteStatement`](crate::client::fluent_builders::ExecuteStatement) operation.
///
/// - The fluent builder is configurable:
/// - [`sql(impl Into<String>)`](crate::client::fluent_builders::ExecuteStatement::sql) / [`set_sql(Option<String>)`](crate::client::fluent_builders::ExecuteStatement::set_sql): <p>The SQL statement text to run. </p>
/// - [`cluster_identifier(impl Into<String>)`](crate::client::fluent_builders::ExecuteStatement::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::client::fluent_builders::ExecuteStatement::set_cluster_identifier): <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`secret_arn(impl Into<String>)`](crate::client::fluent_builders::ExecuteStatement::secret_arn) / [`set_secret_arn(Option<String>)`](crate::client::fluent_builders::ExecuteStatement::set_secret_arn): <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
/// - [`db_user(impl Into<String>)`](crate::client::fluent_builders::ExecuteStatement::db_user) / [`set_db_user(Option<String>)`](crate::client::fluent_builders::ExecuteStatement::set_db_user): <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
/// - [`database(impl Into<String>)`](crate::client::fluent_builders::ExecuteStatement::database) / [`set_database(Option<String>)`](crate::client::fluent_builders::ExecuteStatement::set_database): <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`with_event(bool)`](crate::client::fluent_builders::ExecuteStatement::with_event) / [`set_with_event(Option<bool>)`](crate::client::fluent_builders::ExecuteStatement::set_with_event): <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
/// - [`statement_name(impl Into<String>)`](crate::client::fluent_builders::ExecuteStatement::statement_name) / [`set_statement_name(Option<String>)`](crate::client::fluent_builders::ExecuteStatement::set_statement_name): <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
/// - [`parameters(Vec<SqlParameter>)`](crate::client::fluent_builders::ExecuteStatement::parameters) / [`set_parameters(Option<Vec<SqlParameter>>)`](crate::client::fluent_builders::ExecuteStatement::set_parameters): <p>The parameters for the SQL statement.</p>
/// - On success, responds with [`ExecuteStatementOutput`](crate::output::ExecuteStatementOutput) with field(s):
/// - [`id(Option<String>)`](crate::output::ExecuteStatementOutput::id): <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
/// - [`created_at(Option<DateTime>)`](crate::output::ExecuteStatementOutput::created_at): <p>The date and time (UTC) the statement was created. </p>
/// - [`cluster_identifier(Option<String>)`](crate::output::ExecuteStatementOutput::cluster_identifier): <p>The cluster identifier. This parameter is not returned when connecting to a serverless endpoint. </p>
/// - [`db_user(Option<String>)`](crate::output::ExecuteStatementOutput::db_user): <p>The database user name.</p>
/// - [`database(Option<String>)`](crate::output::ExecuteStatementOutput::database): <p>The name of the database.</p>
/// - [`secret_arn(Option<String>)`](crate::output::ExecuteStatementOutput::secret_arn): <p>The name or ARN of the secret that enables access to the database. </p>
/// - On failure, responds with [`SdkError<ExecuteStatementError>`](crate::error::ExecuteStatementError)
pub fn execute_statement(&self) -> fluent_builders::ExecuteStatement<C, M, R> {
fluent_builders::ExecuteStatement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetStatementResult`](crate::client::fluent_builders::GetStatementResult) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::GetStatementResult::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`id(impl Into<String>)`](crate::client::fluent_builders::GetStatementResult::id) / [`set_id(Option<String>)`](crate::client::fluent_builders::GetStatementResult::set_id): <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::GetStatementResult::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::GetStatementResult::set_next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On success, responds with [`GetStatementResultOutput`](crate::output::GetStatementResultOutput) with field(s):
/// - [`records(Option<Vec<Vec<Field>>>)`](crate::output::GetStatementResultOutput::records): <p>The results of the SQL statement.</p>
/// - [`column_metadata(Option<Vec<ColumnMetadata>>)`](crate::output::GetStatementResultOutput::column_metadata): <p>The properties (metadata) of a column. </p>
/// - [`total_num_rows(i64)`](crate::output::GetStatementResultOutput::total_num_rows): <p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
/// - [`next_token(Option<String>)`](crate::output::GetStatementResultOutput::next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On failure, responds with [`SdkError<GetStatementResultError>`](crate::error::GetStatementResultError)
pub fn get_statement_result(&self) -> fluent_builders::GetStatementResult<C, M, R> {
fluent_builders::GetStatementResult::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListDatabases`](crate::client::fluent_builders::ListDatabases) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListDatabases::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`cluster_identifier(impl Into<String>)`](crate::client::fluent_builders::ListDatabases::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::client::fluent_builders::ListDatabases::set_cluster_identifier): <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`database(impl Into<String>)`](crate::client::fluent_builders::ListDatabases::database) / [`set_database(Option<String>)`](crate::client::fluent_builders::ListDatabases::set_database): <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`secret_arn(impl Into<String>)`](crate::client::fluent_builders::ListDatabases::secret_arn) / [`set_secret_arn(Option<String>)`](crate::client::fluent_builders::ListDatabases::set_secret_arn): <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
/// - [`db_user(impl Into<String>)`](crate::client::fluent_builders::ListDatabases::db_user) / [`set_db_user(Option<String>)`](crate::client::fluent_builders::ListDatabases::set_db_user): <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListDatabases::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListDatabases::set_next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListDatabases::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListDatabases::set_max_results): <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
/// - On success, responds with [`ListDatabasesOutput`](crate::output::ListDatabasesOutput) with field(s):
/// - [`databases(Option<Vec<String>>)`](crate::output::ListDatabasesOutput::databases): <p>The names of databases. </p>
/// - [`next_token(Option<String>)`](crate::output::ListDatabasesOutput::next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On failure, responds with [`SdkError<ListDatabasesError>`](crate::error::ListDatabasesError)
pub fn list_databases(&self) -> fluent_builders::ListDatabases<C, M, R> {
fluent_builders::ListDatabases::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListSchemas`](crate::client::fluent_builders::ListSchemas) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListSchemas::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`cluster_identifier(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_cluster_identifier): <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`secret_arn(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::secret_arn) / [`set_secret_arn(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_secret_arn): <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
/// - [`db_user(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::db_user) / [`set_db_user(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_db_user): <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
/// - [`database(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::database) / [`set_database(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_database): <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
/// - [`connected_database(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::connected_database) / [`set_connected_database(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_connected_database): <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
/// - [`schema_pattern(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::schema_pattern) / [`set_schema_pattern(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_schema_pattern): <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. </p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListSchemas::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListSchemas::set_next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListSchemas::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListSchemas::set_max_results): <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
/// - On success, responds with [`ListSchemasOutput`](crate::output::ListSchemasOutput) with field(s):
/// - [`schemas(Option<Vec<String>>)`](crate::output::ListSchemasOutput::schemas): <p>The schemas that match the request pattern. </p>
/// - [`next_token(Option<String>)`](crate::output::ListSchemasOutput::next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On failure, responds with [`SdkError<ListSchemasError>`](crate::error::ListSchemasError)
pub fn list_schemas(&self) -> fluent_builders::ListSchemas<C, M, R> {
fluent_builders::ListSchemas::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListStatements`](crate::client::fluent_builders::ListStatements) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListStatements::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListStatements::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListStatements::set_next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListStatements::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListStatements::set_max_results): <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
/// - [`statement_name(impl Into<String>)`](crate::client::fluent_builders::ListStatements::statement_name) / [`set_statement_name(Option<String>)`](crate::client::fluent_builders::ListStatements::set_statement_name): <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
/// - [`status(StatusString)`](crate::client::fluent_builders::ListStatements::status) / [`set_status(Option<StatusString>)`](crate::client::fluent_builders::ListStatements::set_status): <p>The status of the SQL statement to list. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>
/// - [`role_level(bool)`](crate::client::fluent_builders::ListStatements::role_level) / [`set_role_level(Option<bool>)`](crate::client::fluent_builders::ListStatements::set_role_level): <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
/// - On success, responds with [`ListStatementsOutput`](crate::output::ListStatementsOutput) with field(s):
/// - [`statements(Option<Vec<StatementData>>)`](crate::output::ListStatementsOutput::statements): <p>The SQL statements. </p>
/// - [`next_token(Option<String>)`](crate::output::ListStatementsOutput::next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On failure, responds with [`SdkError<ListStatementsError>`](crate::error::ListStatementsError)
pub fn list_statements(&self) -> fluent_builders::ListStatements<C, M, R> {
fluent_builders::ListStatements::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListTables`](crate::client::fluent_builders::ListTables) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListTables::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`cluster_identifier(impl Into<String>)`](crate::client::fluent_builders::ListTables::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::client::fluent_builders::ListTables::set_cluster_identifier): <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
/// - [`secret_arn(impl Into<String>)`](crate::client::fluent_builders::ListTables::secret_arn) / [`set_secret_arn(Option<String>)`](crate::client::fluent_builders::ListTables::set_secret_arn): <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
/// - [`db_user(impl Into<String>)`](crate::client::fluent_builders::ListTables::db_user) / [`set_db_user(Option<String>)`](crate::client::fluent_builders::ListTables::set_db_user): <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
/// - [`database(impl Into<String>)`](crate::client::fluent_builders::ListTables::database) / [`set_database(Option<String>)`](crate::client::fluent_builders::ListTables::set_database): <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
/// - [`connected_database(impl Into<String>)`](crate::client::fluent_builders::ListTables::connected_database) / [`set_connected_database(Option<String>)`](crate::client::fluent_builders::ListTables::set_connected_database): <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
/// - [`schema_pattern(impl Into<String>)`](crate::client::fluent_builders::ListTables::schema_pattern) / [`set_schema_pattern(Option<String>)`](crate::client::fluent_builders::ListTables::set_schema_pattern): <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
/// - [`table_pattern(impl Into<String>)`](crate::client::fluent_builders::ListTables::table_pattern) / [`set_table_pattern(Option<String>)`](crate::client::fluent_builders::ListTables::set_table_pattern): <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListTables::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListTables::set_next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListTables::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListTables::set_max_results): <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
/// - On success, responds with [`ListTablesOutput`](crate::output::ListTablesOutput) with field(s):
/// - [`tables(Option<Vec<TableMember>>)`](crate::output::ListTablesOutput::tables): <p>The tables that match the request pattern. </p>
/// - [`next_token(Option<String>)`](crate::output::ListTablesOutput::next_token): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
/// - On failure, responds with [`SdkError<ListTablesError>`](crate::error::ListTablesError)
pub fn list_tables(&self) -> fluent_builders::ListTables<C, M, R> {
fluent_builders::ListTables::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 `BatchExecuteStatement`.
///
/// <p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless endpoint, specify the database name. </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct BatchExecuteStatement<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::batch_execute_statement_input::Builder,
}
impl<C, M, R> BatchExecuteStatement<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 `BatchExecuteStatement`.
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::BatchExecuteStatementOutput,
aws_smithy_http::result::SdkError<crate::error::BatchExecuteStatementError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::BatchExecuteStatementInputOperationOutputAlias,
crate::output::BatchExecuteStatementOutput,
crate::error::BatchExecuteStatementError,
crate::input::BatchExecuteStatementInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Appends an item to `Sqls`.
///
/// To override the contents of this collection use [`set_sqls`](Self::set_sqls).
///
/// <p>One or more SQL statements to run. </p>
pub fn sqls(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sqls(input.into());
self
}
/// <p>One or more SQL statements to run. </p>
pub fn set_sqls(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_sqls(input);
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
pub fn with_event(mut self, input: bool) -> Self {
self.inner = self.inner.with_event(input);
self
}
/// <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
pub fn set_with_event(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_with_event(input);
self
}
/// <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
pub fn statement_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.statement_name(input.into());
self
}
/// <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
pub fn set_statement_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_statement_name(input);
self
}
}
/// Fluent builder constructing a request to `CancelStatement`.
///
/// <p>Cancels a running query. To be canceled, a query must be running. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CancelStatement<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::cancel_statement_input::Builder,
}
impl<C, M, R> CancelStatement<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 `CancelStatement`.
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::CancelStatementOutput,
aws_smithy_http::result::SdkError<crate::error::CancelStatementError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::CancelStatementInputOperationOutputAlias,
crate::output::CancelStatementOutput,
crate::error::CancelStatementError,
crate::input::CancelStatementInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.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 identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
pub fn id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.id(input.into());
self
}
/// <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
pub fn set_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeStatement`.
///
/// <p>Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeStatement<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::describe_statement_input::Builder,
}
impl<C, M, R> DescribeStatement<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 `DescribeStatement`.
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::DescribeStatementOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeStatementError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::DescribeStatementInputOperationOutputAlias,
crate::output::DescribeStatementOutput,
crate::error::DescribeStatementError,
crate::input::DescribeStatementInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.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 identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
pub fn id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.id(input.into());
self
}
/// <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
pub fn set_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeTable`.
///
/// <p>Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless endpoint, specify the database name. </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeTable<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::describe_table_input::Builder,
}
impl<C, M, R> DescribeTable<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 `DescribeTable`.
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::DescribeTableOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeTableError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::DescribeTableInputOperationOutputAlias,
crate::output::DescribeTableOutput,
crate::error::DescribeTableError,
crate::input::DescribeTableInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeTablePaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeTablePaginator<C, M, R> {
crate::paginator::DescribeTablePaginator::new(self.handle, self.inner)
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn connected_database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.connected_database(input.into());
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn set_connected_database(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_connected_database(input);
self
}
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub fn schema(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.schema(input.into());
self
}
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub fn set_schema(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_schema(input);
self
}
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub fn table(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.table(input.into());
self
}
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub fn set_table(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_table(input);
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
/// Fluent builder constructing a request to `ExecuteStatement`.
///
/// <p>Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless endpoint, specify the database name. </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ExecuteStatement<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::execute_statement_input::Builder,
}
impl<C, M, R> ExecuteStatement<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 `ExecuteStatement`.
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::ExecuteStatementOutput,
aws_smithy_http::result::SdkError<crate::error::ExecuteStatementError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::ExecuteStatementInputOperationOutputAlias,
crate::output::ExecuteStatementOutput,
crate::error::ExecuteStatementError,
crate::input::ExecuteStatementInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.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 SQL statement text to run. </p>
pub fn sql(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sql(input.into());
self
}
/// <p>The SQL statement text to run. </p>
pub fn set_sql(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_sql(input);
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
pub fn with_event(mut self, input: bool) -> Self {
self.inner = self.inner.with_event(input);
self
}
/// <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
pub fn set_with_event(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_with_event(input);
self
}
/// <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
pub fn statement_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.statement_name(input.into());
self
}
/// <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
pub fn set_statement_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_statement_name(input);
self
}
/// Appends an item to `Parameters`.
///
/// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
///
/// <p>The parameters for the SQL statement.</p>
pub fn parameters(mut self, input: crate::model::SqlParameter) -> Self {
self.inner = self.inner.parameters(input);
self
}
/// <p>The parameters for the SQL statement.</p>
pub fn set_parameters(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::SqlParameter>>,
) -> Self {
self.inner = self.inner.set_parameters(input);
self
}
}
/// Fluent builder constructing a request to `GetStatementResult`.
///
/// <p>Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetStatementResult<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::get_statement_result_input::Builder,
}
impl<C, M, R> GetStatementResult<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 `GetStatementResult`.
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::GetStatementResultOutput,
aws_smithy_http::result::SdkError<crate::error::GetStatementResultError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::GetStatementResultInputOperationOutputAlias,
crate::output::GetStatementResultOutput,
crate::error::GetStatementResultError,
crate::input::GetStatementResultInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::GetStatementResultPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::GetStatementResultPaginator<C, M, R> {
crate::paginator::GetStatementResultPaginator::new(self.handle, self.inner)
}
/// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
pub fn id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.id(input.into());
self
}
/// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
pub fn set_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_id(input);
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListDatabases`.
///
/// <p>List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless endpoint, specify the database name. </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListDatabases<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::list_databases_input::Builder,
}
impl<C, M, R> ListDatabases<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 `ListDatabases`.
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::ListDatabasesOutput,
aws_smithy_http::result::SdkError<crate::error::ListDatabasesError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::ListDatabasesInputOperationOutputAlias,
crate::output::ListDatabasesOutput,
crate::error::ListDatabasesError,
crate::input::ListDatabasesInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListDatabasesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListDatabasesPaginator<C, M, R> {
crate::paginator::ListDatabasesPaginator::new(self.handle, self.inner)
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
/// Fluent builder constructing a request to `ListSchemas`.
///
/// <p>Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless endpoint, specify the database name. </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListSchemas<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::list_schemas_input::Builder,
}
impl<C, M, R> ListSchemas<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 `ListSchemas`.
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::ListSchemasOutput,
aws_smithy_http::result::SdkError<crate::error::ListSchemasError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::ListSchemasInputOperationOutputAlias,
crate::output::ListSchemasOutput,
crate::error::ListSchemasError,
crate::input::ListSchemasInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListSchemasPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListSchemasPaginator<C, M, R> {
crate::paginator::ListSchemasPaginator::new(self.handle, self.inner)
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn connected_database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.connected_database(input.into());
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn set_connected_database(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_connected_database(input);
self
}
/// <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. </p>
pub fn schema_pattern(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.schema_pattern(input.into());
self
}
/// <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. </p>
pub fn set_schema_pattern(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_schema_pattern(input);
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
/// Fluent builder constructing a request to `ListStatements`.
///
/// <p>List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListStatements<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::list_statements_input::Builder,
}
impl<C, M, R> ListStatements<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 `ListStatements`.
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::ListStatementsOutput,
aws_smithy_http::result::SdkError<crate::error::ListStatementsError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::ListStatementsInputOperationOutputAlias,
crate::output::ListStatementsOutput,
crate::error::ListStatementsError,
crate::input::ListStatementsInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListStatementsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListStatementsPaginator<C, M, R> {
crate::paginator::ListStatementsPaginator::new(self.handle, self.inner)
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
pub fn statement_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.statement_name(input.into());
self
}
/// <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
pub fn set_statement_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_statement_name(input);
self
}
/// <p>The status of the SQL statement to list. Status values are defined as follows: </p>
/// <ul>
/// <li> <p>ABORTED - The query run was stopped by the user. </p> </li>
/// <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li>
/// <li> <p>FAILED - The query run failed. </p> </li>
/// <li> <p>FINISHED - The query has finished running. </p> </li>
/// <li> <p>PICKED - The query has been chosen to be run. </p> </li>
/// <li> <p>STARTED - The query run has started. </p> </li>
/// <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li>
/// </ul>
pub fn status(mut self, input: crate::model::StatusString) -> Self {
self.inner = self.inner.status(input);
self
}
/// <p>The status of the SQL statement to list. Status values are defined as follows: </p>
/// <ul>
/// <li> <p>ABORTED - The query run was stopped by the user. </p> </li>
/// <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li>
/// <li> <p>FAILED - The query run failed. </p> </li>
/// <li> <p>FINISHED - The query has finished running. </p> </li>
/// <li> <p>PICKED - The query has been chosen to be run. </p> </li>
/// <li> <p>STARTED - The query run has started. </p> </li>
/// <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li>
/// </ul>
pub fn set_status(
mut self,
input: std::option::Option<crate::model::StatusString>,
) -> Self {
self.inner = self.inner.set_status(input);
self
}
/// <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
pub fn role_level(mut self, input: bool) -> Self {
self.inner = self.inner.role_level(input);
self
}
/// <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
pub fn set_role_level(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_role_level(input);
self
}
}
/// Fluent builder constructing a request to `ListTables`.
///
/// <p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless endpoint, specify the database name. </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListTables<
C = aws_smithy_client::erase::DynConnector,
M = crate::middleware::DefaultMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::list_tables_input::Builder,
}
impl<C, M, R> ListTables<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 `ListTables`.
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::ListTablesOutput,
aws_smithy_http::result::SdkError<crate::error::ListTablesError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::ListTablesInputOperationOutputAlias,
crate::output::ListTablesOutput,
crate::error::ListTablesError,
crate::input::ListTablesInputOperationRetryAlias,
>,
{
let op = self
.inner
.build()
.map_err(|err| aws_smithy_http::result::SdkError::ConstructionFailure(err.into()))?
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListTablesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListTablesPaginator<C, M, R> {
crate::paginator::ListTablesPaginator::new(self.handle, self.inner)
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn connected_database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.connected_database(input.into());
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn set_connected_database(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_connected_database(input);
self
}
/// <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
pub fn schema_pattern(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.schema_pattern(input.into());
self
}
/// <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
pub fn set_schema_pattern(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_schema_pattern(input);
self
}
/// <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
pub fn table_pattern(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.table_pattern(input.into());
self
}
/// <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
pub fn set_table_pattern(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_table_pattern(input);
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
}
impl<C> Client<C, crate::middleware::DefaultMiddleware, 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 builder = aws_smithy_client::Builder::new()
.connector(conn)
.middleware(crate::middleware::DefaultMiddleware::new());
builder.set_retry_config(retry_config.into());
builder.set_timeout_config(timeout_config);
if let Some(sleep_impl) = sleep_impl {
builder.set_sleep_impl(Some(sleep_impl));
}
let client = builder.build();
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}
impl
Client<
aws_smithy_client::erase::DynConnector,
crate::middleware::DefaultMiddleware,
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 builder = aws_smithy_client::Builder::dyn_https()
.middleware(crate::middleware::DefaultMiddleware::new());
builder.set_retry_config(retry_config.into());
builder.set_timeout_config(timeout_config);
// the builder maintains a try-state. To avoid suppressing the warning when sleep is unset,
// only set it if we actually have a sleep impl.
if let Some(sleep_impl) = sleep_impl {
builder.set_sleep_impl(Some(sleep_impl));
}
let client = builder.build();
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}