pyawsopstoolkit-security 0.1.0
This package offers a comprehensive array of features designed to identify security risks and vulnerabilities associated
License: MIT
Keywords: aws, toolkit, operations, tools, development, python, utilities, insights, search, advance-search, hygiene, filtering, amazon-web-services

# pyawsopstoolkit_security

The **pyawsopstoolkit_security** package offers a comprehensive array of features designed to identify security risks
and vulnerabilities associated with AWS (Amazon Web Services), such as IAM roles without permissions boundaries.
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_security**!

### Installation

Install **pyawsopstoolkit_security** via pip:

```bash
pip install pyawsopstoolkit_security
```

## Documentation

- [iam](#iam)

### iam

This **pyawsopstoolkit_security.iam** subpackage offers features designed to identify security risks and vulnerabilities
associated with AWS (Amazon Web Services) Identity and Access Management (IAM).

#### Role

A class representing security risks and vulnerabilities related to IAM roles.

##### Constructors

- `Role(session: Session) -> None`: Initializes a new **Role** object.

##### Methods

- `roles_without_permissions_boundary() -> list`: Retrieves a list of IAM roles lacking associated permissions
  boundaries, facilitating targeted risk assessment and mitigation.

##### Properties

- `session`: An `pyawsopstoolkit.session.Session` object providing access to AWS services.

##### Usage

```python
from pyawsopstoolkit.session import Session
from pyawsopstoolkit_security.iam import Role

# Create a session using default profile
session = Session(profile_name='default')

# Initialize IAM Role object
role_object = Role(session=session)

# Retrieve IAM roles without permissions boundaries
roles_without_boundaries = role_object.roles_without_permissions_boundary()

# Print the list of roles without permissions boundaries
print(roles_without_boundaries)
```

##### References

- [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)
- [When and where to use IAM permissions boundaries](https://aws.amazon.com/blogs/security/when-and-where-to-use-iam-permissions-boundaries/)

#### User

A class representing security risks and vulnerabilities related to IAM users.

##### Constructors

- `User(session: Session) -> None`: Initializes a new **User** object.

##### Methods

- `users_without_permissions_boundary() -> list`: Retrieves a list of IAM users lacking associated permissions
  boundaries, facilitating targeted risk assessment and mitigation.

##### Properties

- `session`: An `pyawsopstoolkit.session.Session` object providing access to AWS services.

##### Usage

```python
from pyawsopstoolkit.session import Session
from pyawsopstoolkit_security.iam import User

# Create a session using default profile
session = Session(profile_name='default')

# Initialize IAM User object
user_object = User(session=session)

# Retrieve IAM users without permissions boundaries
users_without_boundaries = user_object.users_without_permissions_boundary()

# Print the list of users without permissions boundaries
print(users_without_boundaries)
```

##### References

- [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)
- [When and where to use IAM permissions boundaries](https://aws.amazon.com/blogs/security/when-and-where-to-use-iam-permissions-boundaries/)

# 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-security).