DescribeInstanceAttribute
Description
Returns information about an attribute of an instance. Only one attribute can be specified per call.
Request Parameters
| Name | Description | Required |
|---|---|---|
|
Type: |
Ancestor: None
Children: instanceId, DescribeInstanceAttributesGroup
instanceId
The instance ID.
Type: xsd:string
Default: Describes all instances.
Ancestor: DescribeInstanceAttributeType
Children: None
Yes
DescribeInstanceAttributesGroup
The group of attributes to describe.
Type: DescribeInstanceAttributesGroup
Ancestor: DescribeInstanceAttributeType
Children: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, and blockDeviceMapping
No
instanceType
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and so on).
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: instanceType
Children: None
No
kernel
The kernel ID.
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: kernel
Children: None
No
ramdisk
The RAM disk ID.
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: ramdisk
Children: None
No
userData
MIME, Base64-encoded user data.
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: userData
Children: None
No
disableApiTermination
Specifies whether the instance can be terminated. You must modify this attribute before you can terminate any "locked" instances.
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: disableApiTermination
Children: None
No
instanceInitiatedShutdownBehavior
Specifies whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down.
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: instanceInitiatedShutdownBehavior
Children: None
No
rootDeviceName
The root device name (e.g., /dev/sda1).
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: rootDeviceName
Children: None
No
blockDeviceMapping
Block device mapping set.
Type: EmptyElementType
Ancestor: DescribeInstanceAttributesGroup
Children: none
No
none
This element contains no options.
Type: xsd:string
Default: None
Ancestor: blockDeviceMapping
Children: None
No
Response Elements
| Name | Description |
|---|---|
|
|
Type: DescribeInstanceAttributeResponseType Ancestor: None Children: |
|
The ID of the request. Type: xsd:string Ancestor: Children: None |
|
The ID of the instance. Type: xsd:string Ancestor: Children: None |
|
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and so on). Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the parent element. Type: xsd:string Ancestor: Children: None |
|
The kernel ID. Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the parent element. Type: xsd:string Ancestor: Children: None |
|
The RAM disk ID. Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the parent element. Type: xsd:string Ancestor: Children: None |
|
MIME, Base64-encoded user data. Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the parent element. Type: xsd:string Ancestor: Children: None |
|
Specifies whether the instance can be terminated. You must modify this attribute before you can terminate any "locked" instances. Type: NullableAttributeBooleanValueType Ancestor: Children: |
|
Generic boolean value. Type: xsd:boolean Valid Values: Ancestor: Children: None |
|
Specifies whether the instance's Amazon EBS volumes are deleted when the instance is shut down. Type: NullableAttributeBooleanValueType Ancestor: Children: |
|
Generic boolean value. Type: xsd:boolean Valid Values: Ancestor: Children: None |
|
The root device name (e.g., /dev/sda1). Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the parent element. Type: xsd:string Ancestor: Children: None |
|
Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName. Type: InstanceBlockDeviceMappingResponseType Ancestor: Children: |
|
The item element. Type: InstanceBlockDeviceMappingResponseItemType Ancestor: Children: |
|
Specifies how the device is exposed to the instance (e.g., /dev/sdh). Type: xsd:string Ancestor: Children: None |
|
Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched. Type: EbsInstanceBlockDeviceMappingResponseType Ancestor: Children: |
|
The ID of the Amazon EBS volume. Type: xsd:string Ancestor: Children: None |
|
Attachment state. Type: xsd:string Valid Values: Ancestor: Children: None |
|
Time stamp when the attachment initiated. Type: xsd:dateTime Ancestor: Children: None |
|
Specifies whether the Amazon EBS volume is deleted on instance termination. Type: xsd:boolean Ancestor: Children: None |
Examples
Example Request
This example lists the kernel ID of the i-10a64379 instance.
<DescribeInstanceAttribute xmlns="http://ec2.amazonaws.com/doc/2009-10-31/"> <imageId><![CDATA[&exampleamiid;</imageId> <kernel/> </DescribeInstanceAttribute>
Example Response
<DescribeInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2009-10-31/">
<instanceId>i-10a64379</instanceId>
<kernel>
<value>aki-f70657b2</value>
</kernel>
</DescribeInstanceAttributeResponse>