# pyawsopstoolkit_insights
The **pyawsopstoolkit_insights** package offers a comprehensive array of features designed to clean up and maintain
hygiene within AWS (Amazon Web Services). It includes tools for identifying unused IAM roles, EC2 Security Groups, and
more. Meticulously engineered, these features are finely tuned to meet the unique demands of the expansive AWS
ecosystem, encompassing a diverse spectrum of aspects.
## Getting Started
Ready to supercharge your AWS operations? Let's get started with **pyawsopstoolkit_insights**!
### Installation
Install **pyawsopstoolkit_insights** via pip:
```bash
pip install pyawsopstoolkit_insights
```
## Documentation
- [iam](#iam)
### iam
This **pyawsopstoolkit_insights.iam** subpackage offers sophisticated insights specifically designed for AWS (Amazon Web
Services) Identity and Access Management (IAM). It provides tools to analyze and manage IAM roles and users, ensuring
efficient and secure AWS operations.
#### Role
The **Role** class represents insights related to IAM roles.
##### Constructors
- `Role(session: Session) -> None`: Initializes a new **Role** object with the provided session.
##### Methods
- `unused_roles(no_of_days: Optional[int] = 90, include_newly_created: Optional[bool] = False) -> list`: Returns a list
of unused IAM roles based on the specified parameters.
##### Properties
- `session`: An `pyawsopstoolkit.session.Session` object providing access to AWS services.
##### Usage
```python
from pyawsopstoolkit.session import Session
from pyawsopstoolkit_insights.iam import Role
# Create a session using the default profile
session = Session(profile_name='default')
# Initialize the IAM Role object
role_object = Role(session=session)
# Retrieve IAM roles unused for the last 90 days
unused_roles = role_object.unused_roles()
# Print the list of unused roles
print(unused_roles)
```
#### User
The **User** class represents insights related to IAM users.
##### Constructors
- `User(session: Session) -> None`: Initializes a new **User** object with the provided session
##### Methods
- `unused_users(no_of_days: Optional[int] = 90, include_newly_created: Optional[bool] = False) -> list`: Returns a list
of unused IAM users based on the specified parameters.
##### Properties
- `session`: An `pyawsopstoolkit.session.Session` object providing access to AWS services.
##### Usage
```python
from pyawsopstoolkit.session import Session
from pyawsopstoolkit_insights.iam import User
# Create a session using the default profile
session = Session(profile_name='default')
# Initialize the IAM User object
user_object = User(session=session)
# Retrieve IAM users unused for the last 90 days
unused_users = user_object.unused_users()
# Print the list of unused users
print(unused_users)
```
# License
Please refer to the [MIT License](LICENSE) within the project for more information.
# Contributing
We welcome contributions from the community! Whether you have ideas for new features, bug fixes, or enhancements, feel
free to open an issue or submit a pull request on [GitHub](https://github.com/coldsofttech/pyawsopstoolkit-insights).
Raw data
{
"_id": null,
"home_page": "https://github.com/coldsofttech/pyawsopstoolkit-models.git",
"name": "pyawsopstoolkit-insights",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "aws, toolkit, operations, tools, development, python, utilities, insights, search, advance-search, hygiene, filtering, amazon-web-services",
"author": "coldsofttech",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# pyawsopstoolkit_insights\n\nThe **pyawsopstoolkit_insights** package offers a comprehensive array of features designed to clean up and maintain\nhygiene within AWS (Amazon Web Services). It includes tools for identifying unused IAM roles, EC2 Security Groups, and\nmore. Meticulously engineered, these features are finely tuned to meet the unique demands of the expansive AWS\necosystem, encompassing a diverse spectrum of aspects.\n\n## Getting Started\n\nReady to supercharge your AWS operations? Let's get started with **pyawsopstoolkit_insights**!\n\n### Installation\n\nInstall **pyawsopstoolkit_insights** via pip:\n\n```bash\npip install pyawsopstoolkit_insights\n```\n\n## Documentation\n\n- [iam](#iam)\n\n### iam\n\nThis **pyawsopstoolkit_insights.iam** subpackage offers sophisticated insights specifically designed for AWS (Amazon Web\nServices) Identity and Access Management (IAM). It provides tools to analyze and manage IAM roles and users, ensuring\nefficient and secure AWS operations.\n\n#### Role\n\nThe **Role** class represents insights related to IAM roles.\n\n##### Constructors\n\n- `Role(session: Session) -> None`: Initializes a new **Role** object with the provided session.\n\n##### Methods\n\n- `unused_roles(no_of_days: Optional[int] = 90, include_newly_created: Optional[bool] = False) -> list`: Returns a list\n of unused IAM roles based on the specified parameters.\n\n##### Properties\n\n- `session`: An `pyawsopstoolkit.session.Session` object providing access to AWS services.\n\n##### Usage\n\n```python\nfrom pyawsopstoolkit.session import Session\nfrom pyawsopstoolkit_insights.iam import Role\n\n# Create a session using the default profile\nsession = Session(profile_name='default')\n\n# Initialize the IAM Role object\nrole_object = Role(session=session)\n\n# Retrieve IAM roles unused for the last 90 days\nunused_roles = role_object.unused_roles()\n\n# Print the list of unused roles\nprint(unused_roles)\n```\n\n#### User\n\nThe **User** class represents insights related to IAM users.\n\n##### Constructors\n\n- `User(session: Session) -> None`: Initializes a new **User** object with the provided session\n\n##### Methods\n\n- `unused_users(no_of_days: Optional[int] = 90, include_newly_created: Optional[bool] = False) -> list`: Returns a list\n of unused IAM users based on the specified parameters.\n\n##### Properties\n\n- `session`: An `pyawsopstoolkit.session.Session` object providing access to AWS services.\n\n##### Usage\n\n```python\nfrom pyawsopstoolkit.session import Session\nfrom pyawsopstoolkit_insights.iam import User\n\n# Create a session using the default profile\nsession = Session(profile_name='default')\n\n# Initialize the IAM User object\nuser_object = User(session=session)\n\n# Retrieve IAM users unused for the last 90 days\nunused_users = user_object.unused_users()\n\n# Print the list of unused users\nprint(unused_users)\n```\n\n# License\n\nPlease refer to the [MIT License](LICENSE) within the project for more information.\n\n# Contributing\n\nWe welcome contributions from the community! Whether you have ideas for new features, bug fixes, or enhancements, feel\nfree to open an issue or submit a pull request on [GitHub](https://github.com/coldsofttech/pyawsopstoolkit-insights).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This package offers a comprehensive array of features designed to clean up and maintain hygiene within AWS (Amazon Web",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/coldsofttech/pyawsopstoolkit-models.git"
},
"split_keywords": [
"aws",
" toolkit",
" operations",
" tools",
" development",
" python",
" utilities",
" insights",
" search",
" advance-search",
" hygiene",
" filtering",
" amazon-web-services"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59d2d8024dab4d0a8bfdab208c3e68a61e485631015f00d5404fb25b2137bbb4",
"md5": "acda8a997a5b991d3d1e8f962a38e0a1",
"sha256": "827e77d661f18bf9f6f976db68130b7732c24a777869c22e4a8824a47fcc81e4"
},
"downloads": -1,
"filename": "pyawsopstoolkit_insights-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acda8a997a5b991d3d1e8f962a38e0a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5838,
"upload_time": "2024-08-11T12:54:33",
"upload_time_iso_8601": "2024-08-11T12:54:33.817997Z",
"url": "https://files.pythonhosted.org/packages/59/d2/d8024dab4d0a8bfdab208c3e68a61e485631015f00d5404fb25b2137bbb4/pyawsopstoolkit_insights-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-11 12:54:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "coldsofttech",
"github_project": "pyawsopstoolkit-models",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyawsopstoolkit",
"specs": [
[
"==",
"0.1.19"
]
]
},
{
"name": "pyawsopstoolkit_validators",
"specs": [
[
"==",
"0.1.0"
]
]
}
],
"lcname": "pyawsopstoolkit-insights"
}
JSON
