Describes the specified attribute of the specified instance. You can specify only one attribute at a time.
Request ParametersThe following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
The instance attribute.
Note that the enaSupport
attribute is not supported.
Type: String
Valid Values: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | enclaveOptions | disableApiStop
Required: Yes
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Type: Boolean
Required: No
The ID of the instance.
Type: String
Required: Yes
The following elements are returned by the service.
The block device mapping of the instance.
Type: Array of InstanceBlockDeviceMapping objects
Indicates whether stop protection is enabled for the instance.
Type: AttributeBooleanValue object
Indicates whether termination protection is enabled. If the value is true
, you can't terminate the instance using the Amazon EC2 console, command line tools, or API.
Type: AttributeBooleanValue object
Indicates whether the instance is optimized for Amazon EBS I/O.
Type: AttributeBooleanValue object
Indicates whether enhanced networking with ENA is enabled.
Type: AttributeBooleanValue object
Indicates whether the instance is enabled for AWS Nitro Enclaves.
Type: EnclaveOptions object
The security groups associated with the instance.
Type: Array of GroupIdentifier objects
The ID of the instance.
Type: String
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Type: AttributeValue object
The instance type.
Type: AttributeValue object
The kernel ID.
Type: AttributeValue object
The product codes.
Type: Array of ProductCode objects
The RAM disk ID.
Type: AttributeValue object
The ID of the request.
Type: String
The device name of the root device volume (for example, /dev/sda1
).
Type: AttributeValue object
Indicates whether source/destination checks are enabled.
Type: AttributeBooleanValue object
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Type: AttributeValue object
The user data.
Type: AttributeValue object
For information about the errors that are common to all actions, see Common client error codes.
Examples Example 1This example lists the instance type of the specified instance.
Sample Requesthttps://ec2.amazonaws.com/?Action=DescribeInstanceAttribute
&InstanceId=i-1234567890abcdef0
&Attribute=instanceType
&AUTHPARAMS
Sample Response
<DescribeInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<instanceId>i-1234567890abcdef0</instanceId>
<instanceType>
<value>t1.micro</value>
</instanceType>
</DescribeInstanceAttributeResponse>
Example 2
This example lists the current value of the InstanceInitiatedShutdownBehavior
attribute for the specified instance.
https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute
&InstanceId=i-1234567890abcdef0
&Attribute=instanceInitiatedShutdownBehavior
&AUTHPARAMS
Sample Response
<DescribeInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<instanceId>i-1234567890abcdef0</instanceId>
<instanceInitiatedShutdownBehavior>
<value>stop</value>
</instanceInitiatedShutdownBehavior>
</DescribeInstanceAttributeResponse>
Example 3
This example lists the current value of the DisableApiTermination
attribute for the specified instance.
https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute
&InstanceId=i-1234567890abcdef0
&Attribute=disableApiTermination
&AUTHPARAMS
Sample Response
<DescribeInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<instanceId>i-1234567890abcdef0</instanceId>
<disableApiTermination>
<value>false</value>
</disableApiTermination>
</DescribeInstanceAttributeResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4