awscli-plugin-proxy
===================
This awscli plugin allows usage of proxy for AWS services as configured in profile configuration.
------------
Installation
------------
The easiest way to install awscli-plugin-proxy is to use `pip`:
$ pip install awscli-plugin-proxy
You can also install the latest package from GitHub source which can contain changes not yet pushed to PyPI:
$ pip install git+https://github.com/cyralinc/awscli-plugin-proxy.git
or, if you install `awscli` via Homebrew, which bundles its own python, install as following:
$ /usr/local/opt/awscli/libexec/bin/pip install awscli-plugin-proxy
---------------
Getting Started
---------------
Before using awscli-plugin-proxy plugin, you need to [configure awscli](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) first.
**MUST**: Once that's done, to enable `awscli-plugin-proxy` plugin for S3, you can run:
$ aws configure set plugins.s3-proxy awscli_plugin_proxy
The above command adds below section to your aws config file. You can also directly edit your `~/.aws/config` with below configuration.
[plugins]
s3-proxy = awscli_plugin_s3_proxy
To add proxy configure to a profile (assuming you have a **test** profile), you can run:
$ aws configure --profile test set s3.proxy http://proxy-host.com:8080
The above command adds below section to your profile:
[profile test]
s3 =
proxy = http://proxy-host.com:8080
s3api =
proxy = http://proxy-host.com:8080
Now you can access S3 using proxy with profile:
$ aws s3 ls --profile test
If You want to use profile without passing it every time as parameter, use environment variable, ex:
export AWS_PROFILE=test
Alternative (classic) method
----------------------------
You can follow the [guide by AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-http-proxy.html) which describes how to use proxy using system environment variables. Here is the example:
export http_proxy=http://proxy-host.com:8080
export https_proxy=http://proxy-host.com:8080
export HTTP_PROXY=http://proxy-host.com:8080
export HTTPS_PROXY=http://proxy-host.com:8080
Remember that after setting these variables, `ALL` clients using this settings will be going through proxy!
Additionally, if You are using awscli on EC2 host, add `NO_PROXY` variable to allow awscli communicate with metadata endpoint:
NO_PROXY=169.254.169.254
Raw data
{
"_id": null,
"home_page": "https://github.com/cyralinc/awscli-plugin-proxy",
"name": "awscli-plugin-proxy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "awscli,plugin,proxy",
"author": "Sebastian Nowak",
"author_email": "sebastian@nowak.ninja",
"download_url": "https://files.pythonhosted.org/packages/ae/76/8e44cb505d1a3da7ca87b5c2033fc6081e57ff1372404b599974cda8f462/awscli-plugin-proxy-0.5.1.tar.gz",
"platform": null,
"description": "awscli-plugin-proxy\n===================\n\nThis awscli plugin allows usage of proxy for AWS services as configured in profile configuration.\n\n------------\nInstallation\n------------\n\nThe easiest way to install awscli-plugin-proxy is to use `pip`:\n\n $ pip install awscli-plugin-proxy\n\nYou can also install the latest package from GitHub source which can contain changes not yet pushed to PyPI:\n\n $ pip install git+https://github.com/cyralinc/awscli-plugin-proxy.git\n\nor, if you install `awscli` via Homebrew, which bundles its own python, install as following:\n\n $ /usr/local/opt/awscli/libexec/bin/pip install awscli-plugin-proxy\n\n\n---------------\nGetting Started\n---------------\n\nBefore using awscli-plugin-proxy plugin, you need to [configure awscli](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) first.\n\n**MUST**: Once that's done, to enable `awscli-plugin-proxy` plugin for S3, you can run:\n\n $ aws configure set plugins.s3-proxy awscli_plugin_proxy\n\nThe above command adds below section to your aws config file. You can also directly edit your `~/.aws/config` with below configuration.\n\n [plugins]\n s3-proxy = awscli_plugin_s3_proxy\n\nTo add proxy configure to a profile (assuming you have a **test** profile), you can run:\n\n $ aws configure --profile test set s3.proxy http://proxy-host.com:8080\n\nThe above command adds below section to your profile:\n\n\t[profile test]\n\ts3 =\n\t\tproxy = http://proxy-host.com:8080\n\ts3api =\n\t\tproxy = http://proxy-host.com:8080\n\nNow you can access S3 using proxy with profile:\n\n $ aws s3 ls --profile test\n\nIf You want to use profile without passing it every time as parameter, use environment variable, ex:\n\n export AWS_PROFILE=test\n\nAlternative (classic) method\n----------------------------\nYou can follow the [guide by AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-http-proxy.html) which describes how to use proxy using system environment variables. Here is the example:\n\n export http_proxy=http://proxy-host.com:8080\n export https_proxy=http://proxy-host.com:8080\n export HTTP_PROXY=http://proxy-host.com:8080\n export HTTPS_PROXY=http://proxy-host.com:8080\n\nRemember that after setting these variables, `ALL` clients using this settings will be going through proxy!\n\nAdditionally, if You are using awscli on EC2 host, add `NO_PROXY` variable to allow awscli communicate with metadata endpoint:\n\n NO_PROXY=169.254.169.254\n",
"bugtrack_url": null,
"license": "",
"summary": "Proxy plugin for AWS CLI (based on https://github.com/nowak-ninja/awscli-s3-proxy)",
"version": "0.5.1",
"project_urls": {
"Download": "https://codeload.github.com/cyralinc/awscli-plugin-proxy/zip/refs/heads/master",
"Homepage": "https://github.com/cyralinc/awscli-plugin-proxy"
},
"split_keywords": [
"awscli",
"plugin",
"proxy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4768d5468e5e711789fb8f1e6d197759c83313eb3489cb0c3d0a6af5743d3c0f",
"md5": "cca901bd94e29cf5474db617030189ca",
"sha256": "40271e0742a1023792d4c6538b7fe4a624f8b47869282bdbe3b5f410de77b3d4"
},
"downloads": -1,
"filename": "awscli_plugin_proxy-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cca901bd94e29cf5474db617030189ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6999,
"upload_time": "2023-12-14T19:20:54",
"upload_time_iso_8601": "2023-12-14T19:20:54.501821Z",
"url": "https://files.pythonhosted.org/packages/47/68/d5468e5e711789fb8f1e6d197759c83313eb3489cb0c3d0a6af5743d3c0f/awscli_plugin_proxy-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae768e44cb505d1a3da7ca87b5c2033fc6081e57ff1372404b599974cda8f462",
"md5": "02e1493b8682208029015df8cbed9574",
"sha256": "faf60675b2e7c23e92daffe51c949861f031719c24697a4529775dfca0ed7b0d"
},
"downloads": -1,
"filename": "awscli-plugin-proxy-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "02e1493b8682208029015df8cbed9574",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6629,
"upload_time": "2023-12-14T19:20:57",
"upload_time_iso_8601": "2023-12-14T19:20:57.015582Z",
"url": "https://files.pythonhosted.org/packages/ae/76/8e44cb505d1a3da7ca87b5c2033fc6081e57ff1372404b599974cda8f462/awscli-plugin-proxy-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 19:20:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cyralinc",
"github_project": "awscli-plugin-proxy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "awscli-plugin-proxy"
}
JSON
