View a markdown version of this page

Use DescribeInstanceAttribute with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use DescribeInstanceAttribute with a CLI

The following code examples show how to use DescribeInstanceAttribute.

CLI
AWS CLI

Example 1: To describe the instance type

The following describe-instance-attribute example describes the instance type of the specified instance.

aws ec2 describe-instance-attribute \ --instance-id i-1234567890abcdef0 \ --attribute instanceType

Output:

{ "InstanceId": "i-1234567890abcdef0", "InstanceType": { "Value": "t1.micro" } }

For more information, see Amazon EC2 instance type changes in the Amazon EC2 User Guide.

Example 2: To describe the disableApiTermination attribute

The following describe-instance-attribute example describes the disableApiTermination attribute of the specified instance.

aws ec2 describe-instance-attribute \ --instance-id i-1234567890abcdef0 \ --attribute disableApiTermination

Output:

{ "InstanceId": "i-1234567890abcdef0", "DisableApiTermination": { "Value": false } }

For more information, see Change instance termination protection in the Amazon EC2 User Guide.

Example 3: To describe the block device mapping for an instance

The following describe-instance-attribute example describes the blockDeviceMapping attribute of the specified instance.

aws ec2 describe-instance-attribute \ --instance-id i-1234567890abcdef0 \ --attribute blockDeviceMapping

Output:

{ "InstanceId": "i-1234567890abcdef0", "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "Status": "attached", "DeleteOnTermination": true, "VolumeId": "vol-049df61146c4d7901", "AttachTime": "2013-05-17T22:42:34.000Z" } }, { "DeviceName": "/dev/sdf", "Ebs": { "Status": "attached", "DeleteOnTermination": false, "VolumeId": "vol-049df61146c4d7901", "AttachTime": "2013-09-10T23:07:00.000Z" } } ] }

For more information, see Block device mappings for volumes on Amazon EC2 instances in the Amazon EC2 User Guide.

PowerShell
Tools for PowerShell V4

Example 1: This example describes the instance type of the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceType

Output:

InstanceType : t2.micro

Example 2: This example describes whether enhanced networking is enabled for the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport

Output:

SriovNetSupport : simple

Example 3: This example describes the security groups for the specified instance.

(Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute groupSet).Groups

Output:

GroupId ------- sg-12345678 sg-45678901

Example 4: This example describes whether EBS optimization is enabled for the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized

Output:

EbsOptimized : False

Example 5: This example describes the 'disableApiTermination' attribute of the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination

Output:

DisableApiTermination : False

Example 6: This example describes the 'instanceInitiatedShutdownBehavior' attribute of the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior

Output:

InstanceInitiatedShutdownBehavior : stop
Tools for PowerShell V5

Example 1: This example describes the instance type of the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceType

Output:

InstanceType : t2.micro

Example 2: This example describes whether enhanced networking is enabled for the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport

Output:

SriovNetSupport : simple

Example 3: This example describes the security groups for the specified instance.

(Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute groupSet).Groups

Output:

GroupId ------- sg-12345678 sg-45678901

Example 4: This example describes whether EBS optimization is enabled for the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized

Output:

EbsOptimized : False

Example 5: This example describes the 'disableApiTermination' attribute of the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination

Output:

DisableApiTermination : False

Example 6: This example describes the 'instanceInitiatedShutdownBehavior' attribute of the specified instance.

Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior

Output:

InstanceInitiatedShutdownBehavior : stop