list-instances¶
Description¶
Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-instances is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Instances
Synopsis¶
list-instances
--cluster-id <value>
[--instance-group-id <value>]
[--instance-group-types <value>]
[--instance-fleet-id <value>]
[--instance-fleet-type <value>]
[--instance-states <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
Options¶
--cluster-id (string)
The identifier of the cluster for which to list the instances.
--instance-group-id (string)
The identifier of the instance group for which to list the instances.
--instance-group-types (list)
The type of instance group for which to list the instances.
(string)
Syntax:
"string" "string" ...
Where valid values are:
MASTER
CORE
TASK
--instance-fleet-id (string)
The unique identifier of the instance fleet.
--instance-fleet-type (string)
The node type of the instance fleet. For example MASTER, CORE, or TASK.
Possible values:
MASTER
CORE
TASK
--instance-states (list)
A list of instance states that will filter the instances returned with this request.
(string)
Syntax:
"string" "string" ...
Where valid values are:
AWAITING_FULFILLMENT
PROVISIONING
BOOTSTRAPPING
RUNNING
TERMINATED
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
The following command lists all of the instances in a cluster with the cluster ID j-3C6XNQ39VR9WL:
aws emr list-instances --cluster-id j-3C6XNQ39VR9WL
Output:
For a uniform instance group based cluster
{
"Instances": [
{
"Status": {
"Timeline": {
"ReadyDateTime": 1433200400.03,
"CreationDateTime": 1433199960.152
},
"State": "RUNNING",
"StateChangeReason": {}
},
"Ec2InstanceId": "i-f19ecfee",
"PublicDnsName": "ec2-52-52-41-150.us-west-2.compute.amazonaws.com",
"PrivateDnsName": "ip-172-21-11-216.us-west-2.compute.internal",
"PublicIpAddress": "52.52.41.150",
"Id": "ci-3NNHQUQ2TWB6Y",
"PrivateIpAddress": "172.21.11.216"
},
{
"Status": {
"Timeline": {
"ReadyDateTime": 1433200400.031,
"CreationDateTime": 1433199949.102
},
"State": "RUNNING",
"StateChangeReason": {}
},
"Ec2InstanceId": "i-1feee4c2",
"PublicDnsName": "ec2-52-63-246-32.us-west-2.compute.amazonaws.com",
"PrivateDnsName": "ip-172-31-24-130.us-west-2.compute.internal",
"PublicIpAddress": "52.63.246.32",
"Id": "ci-GAOCMKNKDCV7",
"PrivateIpAddress": "172.21.11.215"
},
{
"Status": {
"Timeline": {
"ReadyDateTime": 1433200400.031,
"CreationDateTime": 1433199949.102
},
"State": "RUNNING",
"StateChangeReason": {}
},
"Ec2InstanceId": "i-15cfeee3",
"PublicDnsName": "ec2-52-25-246-63.us-west-2.compute.amazonaws.com",
"PrivateDnsName": "ip-172-31-24-129.us-west-2.compute.internal",
"PublicIpAddress": "52.25.246.63",
"Id": "ci-2W3TDFFB47UAD",
"PrivateIpAddress": "172.21.11.214"
}
]
}
For a fleet based cluster:
{
"Instances": [
{
"Status": {
"Timeline": {
"ReadyDateTime": 1487810810.878,
"CreationDateTime": 1487810588.367,
"EndDateTime": 1488022990.924
},
"State": "TERMINATED",
"StateChangeReason": {
"Message": "Instance was terminated."
}
},
"Ec2InstanceId": "i-xxxxx",
"InstanceFleetId": "if-xxxxx",
"EbsVolumes": [],
"PublicDnsName": "ec2-xx-xxx-xxx-xxx.compute-1.amazonaws.com",
"InstanceType": "m3.xlarge",
"PrivateDnsName": "ip-xx-xx-xxx-xx.ec2.internal",
"Market": "SPOT",
"PublicIpAddress": "xx.xx.xxx.xxx",
"Id": "ci-xxxxx",
"PrivateIpAddress": "10.47.191.80"
}
]
}
Output¶
Instances -> (list)
The list of instances for the cluster and given filters.
(structure)
Represents an EC2 instance provisioned as part of cluster.
Id -> (string)
The unique identifier for the instance in Amazon EMR.
Ec2InstanceId -> (string)
The unique identifier of the instance in Amazon EC2.
PublicDnsName -> (string)
The public DNS name of the instance.
PublicIpAddress -> (string)
The public IP address of the instance.
PrivateDnsName -> (string)
The private DNS name of the instance.
PrivateIpAddress -> (string)
The private IP address of the instance.
Status -> (structure)
The current status of the instance.
State -> (string)
The current state of the instance.
StateChangeReason -> (structure)
The details of the status change reason for the instance.
Code -> (string)
The programmable code for the state change reason.
Message -> (string)
The status change reason description.
Timeline -> (structure)
The timeline of the instance status over time.
CreationDateTime -> (timestamp)
The creation date and time of the instance.
ReadyDateTime -> (timestamp)
The date and time when the instance was ready to perform tasks.
EndDateTime -> (timestamp)
The date and time when the instance was terminated.
InstanceGroupId -> (string)
The identifier of the instance group to which this instance belongs.
InstanceFleetId -> (string)
The unique identifier of the instance fleet to which an EC2 instance belongs.
Market -> (string)
The instance purchasing option. Valid values are
ON_DEMANDorSPOT.InstanceType -> (string)
The EC2 instance type, for example
m3.xlarge.EbsVolumes -> (list)
The list of EBS volumes that are attached to this instance.
(structure)
EBS block device that’s attached to an EC2 instance.
Device -> (string)
The device name that is exposed to the instance, such as /dev/sdh.
VolumeId -> (string)
The volume identifier of the EBS volume.
Marker -> (string)
The pagination token that indicates the next set of results to retrieve.