aws_administrator


Nameaws_administrator JSON
Version 2.3.3 PyPI version JSON
download
home_pagehttps://gitlab.com/fer1035_python/modules/pypi-aws_administrator
SummaryRun AWS administrative scripts.
upload_time2024-11-25 11:20:47
maintainerNone
docs_urlNone
authorAhmad Ferdaus Abd Razak
requires_python<4.0,>=3.8
licenseGPL-2.0-only
keywords aws administrator helper scripts
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =====================
**aws_administrator**
=====================

Overview
--------

Run AWS administrative scripts.

Available scripts (see each script's docstring for more information):

- aws_actions_get - Get AWS actions for services.
- aws_sgs_get - Collect AWS Security Group details from multiple accounts.
- aws_sso_assign - Assign AWS SSO Permission Sets to multiple accounts.
- aws_sso_get - Collect AWS SSO Permission Set assignment data from multiple accounts.
- aws_sso_json - Convert human-readable SSO data to AWS IDs.
- aws_sso_mappings - Update AWS SSO mappings data with new principals.
- aws_sso_memberships - Get AWS SSO membership details from mappings data.
- aws_sso_update - Update AWS SSO User and Group names from mappings files.
- aws_s3_getbuckets - List S3 buckets in AWS accounts.

Helper modules:

- helper_aws_iam - Provide common AWS IAM multithreaded functions.
- helper_aws_ec2 - Provide common AWS EC2 multithreaded functions.
- helper_aws_sso - Provide common AWS SSO multithreaded functions.
- helper_aws_s3 - Provide common AWS S3 multithreaded functions.
- helper_aws_entrypoint - Provide AWS auth and crawler options.
- helper_common - Provide common helper functions.
- helper_parameters - Provide helper parameter values.

Usage
------

Installation:

.. code-block:: BASH

    pip3 install aws_administrator
    # or
    python3 -m pip install aws_administrator

Prerequisite steps:

1. Copy the "parameters.ini" file: https://gitlab.com/fer1035_python/modules/pypi-aws_administrator/-/blob/main/src/aws_administrator/extras/parameters.ini to your current working directory.

2. Update the file with the necessary values. To specify a value for a parameter, add the value in the following format: PARAMETER_NAME **= VALUE**. The examples for this is available for the DRY_RUN and THREAD_NUM parameters.

Example (Python shell):

.. code-block:: PYTHON

    # Get AWS SSO Permission Set details from all accounts in an organization.

    from aws_administrator import aws_sso_get
    aws_sso_get.aws_sso_get()

Extra Features
---------------

- Some scripts have a DRY_RUN option which can be set in the "parameters.ini" file.
- The number of threads (THREAD_NUM) for multithreaded scripts can be set in the "parameters.ini" file.

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/fer1035_python/modules/pypi-aws_administrator",
    "name": "aws_administrator",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "aws, administrator, helper, scripts",
    "author": "Ahmad Ferdaus Abd Razak",
    "author_email": "fer1035@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/47/65/6b8a9a8c713e96be476f77259c346c984df99a541bc397a2eb0007a8e6d7/aws_administrator-2.3.3.tar.gz",
    "platform": null,
    "description": "=====================\n**aws_administrator**\n=====================\n\nOverview\n--------\n\nRun AWS administrative scripts.\n\nAvailable scripts (see each script's docstring for more information):\n\n- aws_actions_get - Get AWS actions for services.\n- aws_sgs_get - Collect AWS Security Group details from multiple accounts.\n- aws_sso_assign - Assign AWS SSO Permission Sets to multiple accounts.\n- aws_sso_get - Collect AWS SSO Permission Set assignment data from multiple accounts.\n- aws_sso_json - Convert human-readable SSO data to AWS IDs.\n- aws_sso_mappings - Update AWS SSO mappings data with new principals.\n- aws_sso_memberships - Get AWS SSO membership details from mappings data.\n- aws_sso_update - Update AWS SSO User and Group names from mappings files.\n- aws_s3_getbuckets - List S3 buckets in AWS accounts.\n\nHelper modules:\n\n- helper_aws_iam - Provide common AWS IAM multithreaded functions.\n- helper_aws_ec2 - Provide common AWS EC2 multithreaded functions.\n- helper_aws_sso - Provide common AWS SSO multithreaded functions.\n- helper_aws_s3 - Provide common AWS S3 multithreaded functions.\n- helper_aws_entrypoint - Provide AWS auth and crawler options.\n- helper_common - Provide common helper functions.\n- helper_parameters - Provide helper parameter values.\n\nUsage\n------\n\nInstallation:\n\n.. code-block:: BASH\n\n    pip3 install aws_administrator\n    # or\n    python3 -m pip install aws_administrator\n\nPrerequisite steps:\n\n1. Copy the \"parameters.ini\" file: https://gitlab.com/fer1035_python/modules/pypi-aws_administrator/-/blob/main/src/aws_administrator/extras/parameters.ini to your current working directory.\n\n2. Update the file with the necessary values. To specify a value for a parameter, add the value in the following format: PARAMETER_NAME **= VALUE**. The examples for this is available for the DRY_RUN and THREAD_NUM parameters.\n\nExample (Python shell):\n\n.. code-block:: PYTHON\n\n    # Get AWS SSO Permission Set details from all accounts in an organization.\n\n    from aws_administrator import aws_sso_get\n    aws_sso_get.aws_sso_get()\n\nExtra Features\n---------------\n\n- Some scripts have a DRY_RUN option which can be set in the \"parameters.ini\" file.\n- The number of threads (THREAD_NUM) for multithreaded scripts can be set in the \"parameters.ini\" file.\n",
    "bugtrack_url": null,
    "license": "GPL-2.0-only",
    "summary": "Run AWS administrative scripts.",
    "version": "2.3.3",
    "project_urls": {
        "Homepage": "https://gitlab.com/fer1035_python/modules/pypi-aws_administrator",
        "Repository": "https://gitlab.com/fer1035_python/modules/pypi-aws_administrator"
    },
    "split_keywords": [
        "aws",
        " administrator",
        " helper",
        " scripts"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d18330ae9e91baa96bd191c37c8d1188ce8f6fed4e888e81afcac1a81ca36fb7",
                "md5": "3ef49df8fd308a1c04293ac174ead68f",
                "sha256": "a85a245f5cc7ba694b8268c7461ee0c964686d60804ee469c7c7d4ee97f4352e"
            },
            "downloads": -1,
            "filename": "aws_administrator-2.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ef49df8fd308a1c04293ac174ead68f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 26484,
            "upload_time": "2024-11-25T11:20:45",
            "upload_time_iso_8601": "2024-11-25T11:20:45.724993Z",
            "url": "https://files.pythonhosted.org/packages/d1/83/30ae9e91baa96bd191c37c8d1188ce8f6fed4e888e81afcac1a81ca36fb7/aws_administrator-2.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47656b8a9a8c713e96be476f77259c346c984df99a541bc397a2eb0007a8e6d7",
                "md5": "ff475cb68258f35afd2cfcecd6df639d",
                "sha256": "5b0a4331d1c0c482f64631216ace3955f6c6b72ba1203c4c59666cecbfe4eba1"
            },
            "downloads": -1,
            "filename": "aws_administrator-2.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "ff475cb68258f35afd2cfcecd6df639d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 13027,
            "upload_time": "2024-11-25T11:20:47",
            "upload_time_iso_8601": "2024-11-25T11:20:47.367453Z",
            "url": "https://files.pythonhosted.org/packages/47/65/6b8a9a8c713e96be476f77259c346c984df99a541bc397a2eb0007a8e6d7/aws_administrator-2.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-25 11:20:47",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "fer1035_python",
    "gitlab_project": "modules",
    "lcname": "aws_administrator"
}
        
Elapsed time: 0.47247s