{"id":307,"date":"2022-05-19T04:43:02","date_gmt":"2022-05-19T04:43:02","guid":{"rendered":"http:\/\/checkmateq.com\/blog\/?p=307"},"modified":"2024-10-19T17:01:01","modified_gmt":"2024-10-19T17:01:01","slug":"aws-cli-commands","status":"publish","type":"post","link":"https:\/\/www.checkmateq.com\/blog\/aws-cli-commands","title":{"rendered":"AWS CLI commands to get ec2 instance list"},"content":{"rendered":"

There are more than one ways to use amazon web services Web console, boto3 (aws sdk for python), AWS Command Line Interface (AWS CLI).<\/p>\n

AWS<\/a> CLI enables users to connect and interact with amazon web services using commands from their terminal, with minimal configuration steps one can start running commands to implement functionalities equivalent to that provided by Web console.<\/p>\n

Steps to install the latest version of AWS Cloud<\/a> Command Line Interface on Linux operating system. if you are installing CLI on Linux 64bit use below link to download, copy and paste it in your terminal<\/p>\n

curl \"https:\/\/awscli.amazonaws.com\/awscli-exe-linux-x86_64.zip\" -o \"awscliv2.zip\"<\/pre>\n
above link will download a compressed installer file, use “unzip” or any other similar command to unzip the\u00a0 installer package.<\/p>\n
unzip awscliv2.zip<\/pre>\n
above command will unzip the installer and will create directory named “aws” in the present working directory, run the installation command below after unzipping the installer,\u00a0 this command uses a file\u00a0 “install” from the newly created aws directory, all the files are installed to\u00a0 “\/usr\/local\/aws-cli” .<\/p>\n
sudo .\/aws\/install<\/pre>\n
 <\/p>\n
please check the installation by using the command “aws –version” should get output similar to snapshot below if properly installed\"\"<\/p>\n
Now to configure the AWS CLI installation you need to have Access key ID, Secret access key, these details can be obtained by creating a IAM user ,follow below steps to create a IAM user.<\/p>\n
Login to your aws console , search for iam in search bar and click on IAM as shown in the below image<\/p>\n
 <\/p>\n
\"\"<\/p>\n
 <\/p>\n
on the left pane click on users under access management<\/p>\n
\"\"<\/p>\n
 <\/p>\n
In step-1 add the user and select the access type as required \"\"<\/p>\n
 <\/p>\n
In next step click on  Attach existing policies directly\u00a0<\/strong>and select policy as per the requirement.<\/p>\n
Note: By selecting a policy you are giving a set of permissions to the user ,so always grant permissions only which are required to complete a specific task.<\/p>\n
click on Next:Tags button on the right side of footer<\/p>\n
\"\"<\/p>\n
 <\/p>\n
In step-3 add tags if required, tags are use full to organize, track or control access to users\"\"<\/p>\n
Review the details and click on the Ceate user\u00a0<\/strong>button\"\"<\/p>\n
 <\/p>\n
In the last step click on the Download.csv save the file, copy Access key id and close.<\/p>\n
\"\"<\/p>\n
Now to configure AWS CLI installation run aws configure and enter Access Key Id and secret Access Key\u00a0 from the csv file downloaded from last step of creating IAM user, enter the\u00a0 region\u00a0 \u00a0 and output format json\/yaml\/text\/table.<\/p>\n
\"\"<\/p>\n
 <\/p>\n
Step-1:How to get details of all the instances ?<\/strong><\/p>\n
aws ec2 describe-instances<\/pre>\n
above command gives information of all the instances available<\/p>\n
describe-instances<\/span><\/strong>\u00a0is a paginated operation,\u00a0by default the AWS CLI automatically makes multiple calls to return all possible results to create pagination.<\/p>\n
Using AWS CLI commands you can get information of a particular\u00a0 instance\u00a0 by specifying instance ID or you can get information of a set of instances belonging to a criteria by specifying filters.<\/p>\n
 <\/p>\n
Step-2: aws cli command to get details of a specific instance using instance id<\/strong><\/p>\n
aws ec2 describe-instances --instance-id i-0238c02f55e024cb5<\/pre>\n
This command gives information of a specific instance with instance “id i-0238c02f55e024cb5”
\n\"\"<\/p>\n
 <\/p>\n
Let’s understand how to use filters<\/strong><\/p>\n
\n
Filter Name<\/strong> and Values<\/strong>\u00a0 can be used to return a specific list of information from a describe instance operation.\u00a0 Here Name<\/strong> is a string , Values\u00a0<\/strong>is list of strings and can be more than one for a single Name, both the Name and Value are case sensitive.<\/p>\n
you can use multiple filters in a single command\u00a0 they are\u00a0 joined with an AND (&&)operation , and the command request returns only results that match all of the specified filters.<\/p>\n
\n
\u00a0If you specify multiple values for single\u00a0 a filter, the values are joined with an OR(||) , and the request returns all results that match any of the specified values.<\/p>\n
Syntax: Name=string,Values=string,string …<\/span><\/strong><\/p>\n<\/div>\n<\/div>\n
Below commands gives information of instances with a specific security group<\/strong>.<\/p>\n
 <\/p>\n
How to get details of ec2 instances associated with a specific “security group name<\/strong> ”<\/p>\n
In this command “instance.group-name” is a filter Name which should be used when you want to get information of instances with a specific security group name and here we are using “web-ssh”(security gropu name) as a Value for the filter “instance.group-name”.<\/p>\n
aws ec2 describe-instances --filters \"Name=instance.group-name,Values=web-ssh\"<\/pre>\n
This command gives information of instances with security group name “web-ssh”<\/p>\n
\"\"<\/h4>\n
 <\/p>\n
How to use a<\/strong>rgument\u00a0 –query to get specific information of a\u00a0 ec2 instance<\/strong><\/p>\n
The\u00a0 another argument that you can use with describe instances command is query.<\/strong><\/p>\n
some times you may need only specific necessary information of instances, “–query”\u00a0 will extract specific information of instances as per the query parameters given in the command<\/p>\n
Lets understand how to\u00a0 use “–query”.<\/p>\n
please observe previous output snapshots to get an idea of output format of “describe-instances”\u00a0 it has\u00a0 “Groups”: instance groups and\u00a0 “Instances”: individual instances under the “Reservations”, argument query will extract the required information from results of “describe-instances” as per the parameters specified in the command<\/p>\n
aws ec2 describe-instances --query \"Reservations[*].Instances[*].{Instance:InstanceId}\"<\/pre>\n
This command\u00a0 will search for the information in all(*) the Reservations and in all the Instances and parameter “InstanceId” is used to get only\u00a0 instance Id’s of all the instances.<\/p>\n
 <\/p>\n
\"\"<\/p>\n
 <\/p>\n
 <\/p>\n
How to use\u00a0 both –filter and –query in a single command<\/strong><\/p>\n
using both “–filter” and “–query” helps you to get specific information of a instance for every particular filter you use.<\/p>\n
In this command a filter “instance.group-id” is used which describes instances with a specific security group-id “sg-0ae6105546164429c”,additionally parameter “query” is used to get specific information of all the instances like instance-id, Subnet-Id,
\nSecurity-group-name.<\/p>\n
aws ec2 describe-instances \\\r\n--filter \"Name=instance.group-id,Values=sg-0ae6105546164429c\" \\\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId,Vpc:VpcId,SecurityGroups:SecurityGroups[0].GroupName}\"\r\n<\/pre>\n
Output:<\/p>\n
\"\"<\/p>\n
\n
\n
 <\/p>\n
Using filter “tag” to get details of instances associated with specific tags.<\/strong><\/p>\n
Tags can be given to every resource in aws\u00a0 every tag will have a Key and a Value for each key.<\/p>\n<\/div>\n<\/div>\n
Lets see some commands to get the information of instances using “key\/value” combination of a “tag”<\/p>\n
Using both key and value of a tag<\/strong><\/p>\n
aws ec2 describe-instances                                                    \r\n--filters \"Name=tag:web-servers,Values=server1\"\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,Tags:Tags}\"<\/pre>\n
here “web-server” is a key and “server1” is a value in a tag , this command will give “InstanceId”\u00a0 and all the tags of the instances with tag-key\u00a0 webservers and tag-value server1.<\/p>\n
Note: “value” for a “key” in tags and “Values” for a “Name” in filters are different.<\/p>\n
\"\"<\/p>\n
 <\/p>\n
You\u00a0 can use filter “tag”\u00a0 with any one of its parameters either with tag-key or tag-value<\/p>\n
With tag-key regardless of tag value:<\/strong><\/p>\n
aws ec2 describe-instances \\\r\n--filters \"Name=tag-key,Values=web-servers\" \\\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}\"\r\n<\/pre>\n
This command will give a output with “InstanceId” and “subnetId” whose
\ntag-key is web-servers
\n\"\"<\/p>\n
 <\/p>\n
With tag-value regardless of tag key:<\/strong><\/p>\n
aws ec2 describe-instances \\\r\n--filters \"Name=tag-value,Values=server2\" \\\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId,Vpc:VpcId}\"\r\n<\/pre>\n
This command will give instance-Id,subnet-id and vpc-id of instances with tag-value
\nserver2
\n\"\"<\/p>\n
 <\/p>\n
How to get information of instances using “instance types”<\/strong><\/p>\n
To get details of instances using instance type<\/p>\n
aws ec2 describe-instances \\\r\n--filters \"Name=instance-type,Values=t2.nano\" \\\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId,Vpc:VpcId,SecurityGroups:SecurityGroups[0].GroupName}\"<\/pre>\n
above command gives instance-id, subnet-id, vpc-id, security group name of instances whose instance type is “t2.nano”.<\/p>\n
\"\"<\/p>\n
 <\/p>\n
Using filter “vpc-id” to get information of instances which are in a specific vpc<\/b><\/p>\n
To get the information of instances using filter “vpc-id”<\/p>\n
aws ec2 describe-instances \\\r\n--filters \"Name=vpc-id,Values=vpc-053a656302897f3de\" \\\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}\"\r\n<\/pre>\n
This command gives instance id’s and subnet id’s of the instances launched
\nin a specific vpc with id “vpc-053a656302897f3de”.<\/p>\n
\"\"<\/p>\n
<\/h4>\n
How to get list of instances based on “state of the instance”<\/strong><\/p>\n
To get list of Stopped instances<\/strong><\/p>\n
aws ec2 describe-instances \r\n--filters \"Name=instance-state-name,Values=stopped\"\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,State:State.Name}\"\r\n<\/pre>\n
Here we are using filter “instance-state-name” and “stopped” as a value for it,
\nthis command results in all the instances with “state” stopped.
\n“InstanceId”, “State.Name” are given as parameters for argument query which gives
\nfinal output with instance-id’s of all the stopped instances<\/p>\n
\"\"<\/p>\n
 <\/p>\n
To get list of\u00a0 Terminated instances<\/strong><\/p>\n
aws ec2 describe-instances \\\r\n--filters \"Name=instance-state-name,Values=terminated\" \\\r\n--query \"Reservations[*].Instances[*].{Instance:InstanceId,LaunchTime:LaunchTime,State:State.Name}\"\r\n<\/pre>\n
In the above command, filter “instance-state-name” and value “terminated” is used
\nfor it and “InstanceId”, “LaunchTime” are given as parameters to argument “–query”.<\/p>\n
This commands gives information all theof terminated instance launch time
\nand instance id.
\n\"\"<\/p>\n
<\/h3>\n
How to change\u00a0 output format of aws cli commands<\/strong><\/p>\n
Aws command line interface supports different types of output formats, you can easily change the output format of your cli command using option –output .<\/p>\n