diff --git a/README.rst b/README.rst index 51cdb7b9969a..5aa6df5c3bee 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,42 @@ -aws-cli -======= +AWS-CLI +================= .. image:: https://github.com/aws/aws-cli/actions/workflows/run-tests.yml/badge.svg :target: https://github.com/aws/aws-cli/actions/workflows/run-tests.yml :alt: Build Status +.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg + :target: https://opensource.org/licenses/Apache-2.0 + :alt: License Apache 2.0 + +.. image:: awscli/assets/Amazon_Web_Services-Logo.png + :alt: AWS Logo + :align: center + :height: 200px + +The AWS Command Line Interface (CLI) is a unified tool to manage your Amazon Web Services resources, enabling seamless automation and scripting of cloud operations. + +---------------- + +Table of Contents +================= + +- `About <#about>`__ +- `Getting Started <#getting-started>`__ +- `Requirements <#requirements>`__ +- `Notices <#notices>`__ +- `Maintenance and Support <#maintenance-and-support-for-cli-major-versions>`__ +- `Installation <#installation>`__ +- `Configuration <#configuration>`__ +- `Basic Commands <#basic-commands>`__ +- `Command Completion <#command-completion>`__ +- `Getting Help <#getting-help>`__ +- `More Resources <#more-resources>`__ + +---------------- + +About +================= This package provides a unified command line interface to Amazon Web Services. @@ -15,14 +47,14 @@ Jump to: - `More Resources <#more-resources>`__ Getting Started ---------------- +================= This README is for the AWS CLI version 1. If you are looking for information about the AWS CLI version 2, please visit the `v2 branch `__. Requirements -~~~~~~~~~~~~ +================= The aws-cli package works on Python versions: @@ -33,7 +65,7 @@ The aws-cli package works on Python versions: - 3.13.x and greater Notices -~~~~~~~ +================= On 2025-04-22, support for Python 3.8 ended for the AWS CLI. This follows the Python Software Foundation `end of support `__ @@ -48,14 +80,14 @@ website `__ *for any important security bulletins related to aws-cli.* Maintenance and Support for CLI Major Versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +================= The AWS CLI version 1 was made generally available on 09/02/2013 and is currently in the full support phase of the availability life cycle. For information about maintenance and support for SDK major versions and their underlying dependencies, see the `Maintenance Policy `__ section in the *AWS SDKs and Tools Shared Configuration and Credentials Reference Guide*. Installation -~~~~~~~~~~~~ +================= Installation of the AWS CLI and its dependencies use a range of packaging features provided by ``pip`` and ``setuptools``. To ensure smooth installation, @@ -115,7 +147,7 @@ See the section of the AWS CLI User Guide for more information. Configuration -~~~~~~~~~~~~~ +================= Before using the AWS CLI, you need to configure your AWS credentials. You can do this in several ways: @@ -222,7 +254,7 @@ You can access this topic from the AWS CLI as well by running ``aws help config-vars``. Basic Commands -~~~~~~~~~~~~~~ +================= An AWS CLI command has the following structure: @@ -261,7 +293,7 @@ CLI `__ chapter of the AWS CLI User Guide. Command Completion -~~~~~~~~~~~~~~~~~~ +================= The aws-cli package includes a command completion feature for Unix-like systems. This feature is not automatically installed so you need to @@ -270,7 +302,7 @@ completion topic `__. Getting Help ------------- +================= The best way to interact with our team is through GitHub. You can `open an issue `__ and @@ -295,7 +327,7 @@ the services or their limitations, you may find the `Amazon Web Services Discussion Forums `__ helpful. More Resources --------------- +================= - `Changelog `__ - `AWS CLI diff --git a/awscli/assets/Amazon_Web_Services-Logo.png b/awscli/assets/Amazon_Web_Services-Logo.png new file mode 100644 index 000000000000..73ac4ad951c9 Binary files /dev/null and b/awscli/assets/Amazon_Web_Services-Logo.png differ diff --git a/awscli/assets/notes.txt b/awscli/assets/notes.txt new file mode 100644 index 000000000000..9ebde443f3f2 --- /dev/null +++ b/awscli/assets/notes.txt @@ -0,0 +1,5 @@ +Notes +============================================================================================= +The images placed in this folder are used to improve the look of AWS-CLI. +The only image currently available, the logo, is being used in the repository's ReadMe. +============================================================================================= \ No newline at end of file