You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/usage.rst
+24Lines changed: 24 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,30 @@
3
3
Usage
4
4
*****
5
5
6
+
In order to use this package, you must have AWS credentials configured on your machine locally. Check the :ref:`authorization documentation <authorization>` for additional details.
7
+
8
+
Quick and Dirty
9
+
---------------
10
+
11
+
The following code block illustrates a minimal, quick and dirty configuration for initializing :class:`boto3_refresh_session.session.RefreshableSession` and subsequently creating an S3 client.
In order to use :class:`boto3_refresh_session.session.RefreshableSession`, you are required to configure parameters for the :meth:`STS.Client.assume_role` method.
0 commit comments