Skip to content

fix: errors in documentation #1244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karenc-bq merged 1 commit into from
Jun 3, 2026
+5 −5
Merged

fix: errors in documentation #1244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
> | Multiple database clusters | Review all connection strings and add a unique `cluster_id` parameter per cluster. See the [Cluster ID documentation](https://github.com/aws/aws-advanced-python-wrapper/blob/main/docs/using-the-python-wrapper/ClusterId.md) for configuration guidance. |

### :magic_wand: Added
* [SQLAlchemy ORM support](https://github.com/aws/aws-advanced-python-wrapper/blob/main/docs/using-the-python-wrapper/SQLAlchemySupport.md).
* [SQLAlchemy ORM support](https://github.com/aws/aws-advanced-python-wrapper/blob/main/docs/using-the-python-wrapper/SqlAlchemySupport.md).

### :bug: Fixed
* New pooled connections created with stale credentials, and PostgreSQL error handler unable to correctly handle auth errors nested in connection errors ([PR #1231](https://github.com/aws/aws-advanced-python-wrapper/pull/1231)).
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ The following table lists the connection properties used with the AWS Advanced P
| `secrets_manager_secret_id` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `secrets_manager_region` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `secrets_manager_endpoint` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `secrets_manager_secret_username` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `secrets_manager_secret_password` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `secrets_manager_secret_username_key` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `secrets_manager_secret_password_key` | [Secrets Manager Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
| `reader_host_selector_strategy` | [Connection Strategy](docs/using-the-python-wrapper/using-plugins/UsingTheReadWriteSplittingPlugin.md#connection-strategies) |
| `db_user` | [Federated Authentication Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
| `idp_username` | [Federated Authentication Plugin](docs/using-the-python-wrapper/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
Expand Down
4 changes: 2 additions & 2 deletions docs/using-the-python-wrapper/SqlAlchemySupport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ For a complete example, see [MySQLSQLAlchemyFailover.py](../examples/MySQLSQLAlc

### Plugin Compatibility

| Plugin name | Plugin Code | Supported? |
| Plugin name | Plugin Code | Supported? |
|-------------------------------------------------------------------------------------------------|-------------------------------------------|-----|
| [Failover Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Failover Plugin v2](./using-plugins/UsingTheFailover2Plugin.md) | `failover_v2` | <span style="color:yellow;font-size:15px">&check;</span> |
Expand All @@ -76,7 +76,7 @@ For a complete example, see [MySQLSQLAlchemyFailover.py](../examples/MySQLSQLAlc
| [AWS Secrets Manager Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `aws_secrets_manager` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthenticationPlugin.md) | `federated_auth` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthenticationPlugin.md) | `okta` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Custom Endpoint Plugin](./using-plugins/UsingTheCustomEndpointPlugin.md) | `customEndpoint` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Custom Endpoint Plugin](./using-plugins/UsingTheCustomEndpointPlugin.md) | `custom_endpoint` | <span style="color:yellow;font-size:15px">&check;</span> |
| Aurora Stale DNS Plugin | `stale_dns` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Aurora Connection Tracker Plugin](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | `aurora_connection_tracker` | <span style="color:yellow;font-size:15px">&check;</span> |
| [Fastest Response Strategy Plugin](./using-plugins/UsingTheFastestResponseStrategyPlugin.md) | `fastest_response_strategy` | <span style="color:yellow;font-size:15px">&check;</span> |
Expand Down