|« PreviousNext »|
|Did this page help you? Yes | No | Tell us about it...|
This section explains how to specify which credentials and region the AWS Command Line Interface should use when interacting with AWS. Following the setup instructions is a list of the AWS services supported by the CLI.
Before using AWS CLI, you first need to specify your AWS account credentials in order to use any AWS command that connects to a service. To specify your credentials choose one of the following three options:
Set the AWS_CONFIG_FILE environment variable to point to a configuration file containing your credentials.
Configure the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables with your credentials.
Create an IAM role. This is the recommended option when using AWS CLI on an Amazon EC2 instance.
Use the environment variable AWS_CONFIG_FILE to point to the configuration file that
contains your AWS access and secret keys. For example, the name of the environment variable
must be AWS_CONFIG_FILE, and the value for the variable must point to the
location of your credential file, such as
It is recommended to set the file permissions of the config file to read-only for the current user.
The following example shows the syntax of the configuration file for the default profile containing access and secret keys for AWS.
[default] aws_access_key_id=AKIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Configure the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY with your key values. The following example shows the syntax.
You must specify an AWS region when using AWS CLI. You set the desired region by either configuring the region setting in your default profile for the environment variable AWS_CONFIG_FILE, such as:
[default] aws_access_key_id=AKIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY region = us-west-2
Or, by using the
--region option with an AWS CLI command, such as:
aws --region us-west-2 sqs list-queues
This example first sets the region to
us-west-2 and then lists the
Amazon SQS queues for that region.
To ensure that everything is set up correctly, test the installation by issuing a common AWS command,
If the test is successful, you will see the help displayed on your terminal.
You can see the help for each of the supported services by adding the service name between
For example, to see the help for Amazon EC2 type:
aws ec2 help
For a list of the available services you can use with AWS Command Line Interface, see Supported Services.