Skip to main content

Login to AWS SSO with this simple utility - just invoke get_aws_session with: region, role_name, account_id, sso_endpoint. Then use the returned aws session instead of boto3

Project description

sso-aws - AWS SSO Login Utility 🔒

License

Overview 📝

The AWS SSO Login Utility is a Python package that simplifies the process of logging in to AWS Single Sign-On (SSO) and retrieving an AWS session for programmatic access. With just a single function call, get_aws_session, you can easily obtain an AWS session to use instead of boto3.

Installation 🚀

You can install the package via pip:

pip install sso-aws

Usage 💻

To use the utility, follow these steps:

  1. Import the package:

    from aws_sso_login import get_aws_session
    
  2. Invoke the get_aws_session function with the required parameters:

    session = get_aws_session(region='us-west-2', role_name='MyRole', account_id='123456789012', sso_endpoint='https://example.awsapps.com/start')
    

    Make sure to provide the correct values for region, role_name, account_id, and sso_endpoint.

  3. Now you can use the returned session object instead of boto3 to interact with AWS services:

    # Example: List S3 buckets
    s3_client = session.client('s3')
    response = s3_client.list_buckets()
    print(response['Buckets'])
    

Example 📃

Here's an example that demonstrates how to use the utility:

from aws_sso_login import get_aws_session

region = 'us-west-2'
role_name = 'MyRole'
account_id = '123456789012'
sso_endpoint = 'https://example.awsapps.com/start'

session = get_aws_session(region=region, role_name=role_name, account_id=account_id, sso_endpoint=sso_endpoint)

# Use the session object for AWS API calls
s3_client = session.client('s3')
response = s3_client.list_buckets()
print(response['Buckets'])

Contributing 👥

Contributions are welcome! If you find any issues or want to enhance this utility, please submit an issue or a pull request in the GitHub repository.

License 📜

This project is licensed under the MIT License.

Acknowledgements 👏

This utility was inspired by the need for a simpler way to log in to AWS SSO and retrieve AWS sessions programmatically. Special thanks to all the contributors and the open-source community.

Contact ✉️

If you have any questions, suggestions, or feedback, feel free to reach out to the project maintainer at GitHub


Enjoy using the AWS SSO Login Utility! ✨

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sso-aws-1.0.5.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sso_aws-1.0.5-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

Details for the file sso-aws-1.0.5.tar.gz.

File metadata

  • Download URL: sso-aws-1.0.5.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.1

File hashes

Hashes for sso-aws-1.0.5.tar.gz
Algorithm Hash digest
SHA256 7b23605cbae21a991792302753c31f94c5f14a02cc54f104bcc04d1e227be021
MD5 288626b324d0820122b3672db53115d2
BLAKE2b-256 8a74e9cf2bfdfc657f0f3d3a30977788efd6e0628209eca35ce80cc6b3c8f16b

See more details on using hashes here.

File details

Details for the file sso_aws-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: sso_aws-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 3.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.1

File hashes

Hashes for sso_aws-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b1bca0671bd34e0bd897d5012e23fbdfe51e922d8efff4ddcf060ef06a247e24
MD5 1bba486d33a8e19270592d1ba7a74e30
BLAKE2b-256 7c173cc4b4d095187d42793aaaecd27606f55f3dc239965bf9bb5a82b8c28ec5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page