Skip to content

Commit f86bb11

Browse files
committed
add note to docstring about redshift vs redshift serverless arguments
1 parent a875e86 commit f86bb11

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

awswrangler/data_api/redshift.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@
1313
class RedshiftDataApi(connector.DataApiConnector):
1414
"""Provides access to a Redshift cluster via the Data API.
1515
16+
Note
17+
----
18+
When connecting to a standard Redshift cluster, `cluster_id` is used.
19+
When connecting to Redshift Serverless, `workgroup_name` is used. These two arguments are mutually exclusive.
20+
1621
Parameters
1722
----------
1823
cluster_id: str
@@ -195,6 +200,11 @@ def connect(
195200
) -> RedshiftDataApi:
196201
"""Create a Redshift Data API connection.
197202
203+
Note
204+
----
205+
When connecting to a standard Redshift cluster, `cluster_id` is used.
206+
When connecting to Redshift Serverless, `workgroup_name` is used. These two arguments are mutually exclusive.
207+
198208
Parameters
199209
----------
200210
cluster_id: str

0 commit comments

Comments
 (0)