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
{{ message }}
Repository navigation
Commit 85b975a
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/source/guide/credentials.rst
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -232,6 +232,38 @@ This provider can also be configured via environment variables:
232
232
233
233
These environment variables currently only apply to the assume role with web identity provider and do not apply to the general assume role provider configuration.
234
234
235
+
AWS Single Sign-On Provider (SSO)
236
+
-----------------------------------
237
+
238
+
Support for the AWS Single Sign-On (SSO) credential provider was added in 1.14.0.
239
+
240
+
To begin using the SSO credential provider, start by using the AWS CLI V2 to configure and manage your SSO profiles and login sessions.
241
+
For detailed instructions on the configuration and login process see the `AWS CLI User Guide for SSO <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html>`_.
242
+
Once completed you will have one or many profiles in the shared configuration file with the following settings:
* ``sso_start_url`` - The URL that points to the organization's AWS SSO user portal.
254
+
* ``sso_region`` - The AWS Region that contains the AWS SSO portal host. This is separate from, and can be a different region than the default CLI region parameter.
255
+
* ``sso_account_id`` - The AWS account ID that contains the IAM role that you want to use with this profile.
256
+
* ``sso_role_name`` - The name of the IAM role that defines the user's permissions when using this profile.
257
+
258
+
You can then specify the profile name via the ``AWS_PROFILE`` environment variable or the ``profile_name`` argument when creating a ``Session``.
259
+
For example, we can create a Session using the ``my-sso-profile`` profile and any clients created from this session will use the ``my-sso-profile`` credentials:
0 commit comments