Skip to content

Commit e8a2199

Browse files
committed
docs: update doc-strings, fix typo
1 parent 74a2dfa commit e8a2199

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

redshift_connector/__init__.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,7 @@ def connect(
212212
preferred_role : str
213213
The IAM role preferred for the current connection.
214214
principal_arn : Optional[str]
215+
The ARN of the IAM entity (user or role) for which you are generating a policy.
215216
credentials_provider : str
216217
The class name of the IdP that will be used for authenticating with the Amazon Redshift cluster.
217218
region : str
@@ -227,6 +228,7 @@ def connect(
227228
client_secret : str
228229
The client secret from Azure IdP.
229230
partner_sp_id : Optional[str]
231+
The Partner SP Id used for authentication with Ping.
230232
idp_response_timeout : int
231233
The timeout for retrieving SAML assertion from IdP. Default value is `120`.
232234
listen_port : int
@@ -246,7 +248,12 @@ def connect(
246248
Is `datashare <https://docs.aws.amazon.com/redshift/latest/dg/datashare-overview.html>`_ disabled. Default value is True, implying datasharing will not be used.
247249
ssl_insecure : bool
248250
Specifies if IdP host's server certificate will be verified. Default value is True
249-
251+
web_identity_token: Optional[str]
252+
A web identity token used for authentication with JWT.
253+
role_session_name: Optional[str]
254+
An identifier for the assumed role session used for authentication with JWT.
255+
role_arn: Optional[str]
256+
The role ARN used for authentication with JWT. This parameter is required when using a JWTCredentialsProvider.
250257
Returns
251258
-------
252259
A Connection object associated with the specified Amazon Redshift cluster: :class:`Connection`

redshift_connector/core.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1322,7 +1322,7 @@ def handle_COMMAND_COMPLETE(self: "Connection", data: bytes, cursor: Cursor) ->
13221322
pcache["ps"].clear()
13231323

13241324
# Get the data respond from database
1325-
# transfrom the Redshift data tye into python data type
1325+
# transform the Redshift data tye into python data type
13261326
# store the data into _cached_rows
13271327
def handle_DATA_ROW(self: "Connection", data: bytes, cursor: Cursor) -> None:
13281328
data_idx: int = 2

0 commit comments

Comments
 (0)