iam-actions


Nameiam-actions JSON
Version 1.2.20240713 PyPI version JSON
download
home_pagehttps://github.com/constableapp/iam_actions
SummaryJSON of AWS policy components
upload_time2024-07-13 02:29:15
maintainerNone
docs_urlNone
authorConstable
requires_python<4.0,>=3.9
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # iam_actions

`iam_actions` is a python module which contains a dictionary of AWS IAM information. Ideally, it is a complete catalog of all AWS services, actions, and resource types. The information is scraped from the AWS documentation pages.

Nightly, the scraping service runs, and publishes a new version with the date appended. 

The package is meant to be used as a consumable package, but it also contains the code to generate the definitions for packaging.

There are three "roots" that you can consume: actions, resource_types, and services. They all currently return as dict's. *However, in a future release, it will be returned as python data structures*

## Actions

Actions is a listing of all the actions for a given service. The structure is as follows:
```
{
    "service_name": {
        "action_name: {
            "access_level": access_level,
            "action": action_name,
            "condition_keys": [condition_key1, ...],
            "description": description
        }
    }
}
```

Therefore, you can find information about an action as follows

```
>>> iam_actions.actions['s3']['GetObject']
{'access_level': 'Read', 'action': 'GetObject', 'condition_keys': ['s3:AccessPointNetworkOrigin', 's3:DataAccessPointAccount', 's3:DataAccessPointArn', 's3:ExistingObjectTag/<key>', 's3:ResourceAccount', 's3:TlsVersion', 's3:authType', 's3:signatureAge', 's3:signatureversion', 's3:x-amz-content-sha256'], 'description': 'Grants permission to retrieve objects from Amazon S3', 'orphan': False, 'resources': ['object']}
```

## Services

Services list information about the service. The structure is as follows:

```
{
    "service_name": {
        "Actions": [action1, ...]
        "ServiceNames": [service_name1, ...]
        "ARNFormats": [arn_format1, ...]
        "ConditionKeys": [condition_key1, ...]
        "HasResource": bool
    }
}
```

## Resource Types

Resource Types list information about the resource types for the service. The structure is as follows:

```
{
    "service_name": {
        "resource_name": {
            "arn_pattern": arn_pattern,
            "condition_keys": [condition_key1, ...]
        }
    }
}
```

## Usage

```python
import iam_actions

print(item_actions.services)
print(item_actions.actions)
print(item_actions.resource_types)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/constableapp/iam_actions",
    "name": "iam-actions",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Constable",
    "author_email": "info@constableapp.com",
    "download_url": "https://files.pythonhosted.org/packages/bb/c0/6acebab7a37a2b76c77c96a6c36ba41f5b6096abcefc9823ff9307ef01f7/iam_actions-1.2.20240713.tar.gz",
    "platform": null,
    "description": "# iam_actions\n\n`iam_actions` is a python module which contains a dictionary of AWS IAM information. Ideally, it is a complete catalog of all AWS services, actions, and resource types. The information is scraped from the AWS documentation pages.\n\nNightly, the scraping service runs, and publishes a new version with the date appended. \n\nThe package is meant to be used as a consumable package, but it also contains the code to generate the definitions for packaging.\n\nThere are three \"roots\" that you can consume: actions, resource_types, and services. They all currently return as dict's. *However, in a future release, it will be returned as python data structures*\n\n## Actions\n\nActions is a listing of all the actions for a given service. The structure is as follows:\n```\n{\n    \"service_name\": {\n        \"action_name: {\n            \"access_level\": access_level,\n            \"action\": action_name,\n            \"condition_keys\": [condition_key1, ...],\n            \"description\": description\n        }\n    }\n}\n```\n\nTherefore, you can find information about an action as follows\n\n```\n>>> iam_actions.actions['s3']['GetObject']\n{'access_level': 'Read', 'action': 'GetObject', 'condition_keys': ['s3:AccessPointNetworkOrigin', 's3:DataAccessPointAccount', 's3:DataAccessPointArn', 's3:ExistingObjectTag/<key>', 's3:ResourceAccount', 's3:TlsVersion', 's3:authType', 's3:signatureAge', 's3:signatureversion', 's3:x-amz-content-sha256'], 'description': 'Grants permission to retrieve objects from Amazon S3', 'orphan': False, 'resources': ['object']}\n```\n\n## Services\n\nServices list information about the service. The structure is as follows:\n\n```\n{\n    \"service_name\": {\n        \"Actions\": [action1, ...]\n        \"ServiceNames\": [service_name1, ...]\n        \"ARNFormats\": [arn_format1, ...]\n        \"ConditionKeys\": [condition_key1, ...]\n        \"HasResource\": bool\n    }\n}\n```\n\n## Resource Types\n\nResource Types list information about the resource types for the service. The structure is as follows:\n\n```\n{\n    \"service_name\": {\n        \"resource_name\": {\n            \"arn_pattern\": arn_pattern,\n            \"condition_keys\": [condition_key1, ...]\n        }\n    }\n}\n```\n\n## Usage\n\n```python\nimport iam_actions\n\nprint(item_actions.services)\nprint(item_actions.actions)\nprint(item_actions.resource_types)\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "JSON of AWS policy components",
    "version": "1.2.20240713",
    "project_urls": {
        "Homepage": "https://github.com/constableapp/iam_actions",
        "Repository": "https://github.com/constableapp/iam_actions"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d199b5faeedf13e79ed8bfa3a488ec7b7322b40c977bab0adf1b251bdaa1a16",
                "md5": "46869234247a17ad888aa93326504060",
                "sha256": "4aabe4ac7f7fc93629ba3581c83394c3a80ae89f42077d4b9fd14e6c58fe232f"
            },
            "downloads": -1,
            "filename": "iam_actions-1.2.20240713-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "46869234247a17ad888aa93326504060",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 671847,
            "upload_time": "2024-07-13T02:29:09",
            "upload_time_iso_8601": "2024-07-13T02:29:09.905218Z",
            "url": "https://files.pythonhosted.org/packages/7d/19/9b5faeedf13e79ed8bfa3a488ec7b7322b40c977bab0adf1b251bdaa1a16/iam_actions-1.2.20240713-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bbc06acebab7a37a2b76c77c96a6c36ba41f5b6096abcefc9823ff9307ef01f7",
                "md5": "faf50a8587eae249f598de216ceafc69",
                "sha256": "04bdead540300b8573988a6f4ab789552dfeb8e4690a67c5e7272f8253bbb375"
            },
            "downloads": -1,
            "filename": "iam_actions-1.2.20240713.tar.gz",
            "has_sig": false,
            "md5_digest": "faf50a8587eae249f598de216ceafc69",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 660180,
            "upload_time": "2024-07-13T02:29:15",
            "upload_time_iso_8601": "2024-07-13T02:29:15.504022Z",
            "url": "https://files.pythonhosted.org/packages/bb/c0/6acebab7a37a2b76c77c96a6c36ba41f5b6096abcefc9823ff9307ef01f7/iam_actions-1.2.20240713.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-13 02:29:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "constableapp",
    "github_project": "iam_actions",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "iam-actions"
}
        
Elapsed time: 0.27923s