Skip to content

EC2  >  Operations  >  describe_instance_attribute

describe_instance_attribute

Operation

describe_instance_attribute async

describe_instance_attribute(input: DescribeInstanceAttributeInput, plugins: list[Plugin] | None = None) -> DescribeInstanceAttributeOutput

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.

Parameters:

Name Type Description Default
input DescribeInstanceAttributeInput

An instance of DescribeInstanceAttributeInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeInstanceAttributeOutput

An instance of DescribeInstanceAttributeOutput.

Input

DescribeInstanceAttributeInput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceAttributeInput structure.

Attributes

attribute class-attribute instance-attribute
attribute: str | None = ...

The instance attribute.

Note that the enaSupport attribute is not supported.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

instance_id class-attribute instance-attribute
instance_id: str | None = ...

The ID of the instance.

Output

DescribeInstanceAttributeOutput dataclass

Bases: _SerdeShape

Describes an instance attribute.

Attributes

block_device_mappings class-attribute instance-attribute
block_device_mappings: list[InstanceBlockDeviceMapping] | None = ...

The block device mapping of the instance.

disable_api_stop class-attribute instance-attribute
disable_api_stop: AttributeBooleanValue | None = ...

Indicates whether stop protection is enabled for the instance.

disable_api_termination class-attribute instance-attribute
disable_api_termination: AttributeBooleanValue | None = ...

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.

ebs_optimized class-attribute instance-attribute
ebs_optimized: AttributeBooleanValue | None = ...

Indicates whether the instance is optimized for Amazon EBS I/O.

ena_support class-attribute instance-attribute
ena_support: AttributeBooleanValue | None = ...

Indicates whether enhanced networking with ENA is enabled.

enclave_options class-attribute instance-attribute
enclave_options: EnclaveOptions | None = ...

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

groups class-attribute instance-attribute
groups: list[GroupIdentifier] | None = ...

The security groups associated with the instance.

instance_id class-attribute instance-attribute
instance_id: str | None = ...

The ID of the instance.

instance_initiated_shutdown_behavior class-attribute instance-attribute
instance_initiated_shutdown_behavior: AttributeValue | None = ...

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

instance_type class-attribute instance-attribute
instance_type: AttributeValue | None = ...

The instance type.

kernel_id class-attribute instance-attribute
kernel_id: AttributeValue | None = ...

The kernel ID.

product_codes class-attribute instance-attribute
product_codes: list[ProductCode] | None = ...

The product codes.

ramdisk_id class-attribute instance-attribute
ramdisk_id: AttributeValue | None = ...

The RAM disk ID.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

root_device_name class-attribute instance-attribute
root_device_name: AttributeValue | None = ...

The device name of the root device volume (for example, /dev/sda1).

source_dest_check class-attribute instance-attribute
source_dest_check: AttributeBooleanValue | None = ...

Indicates whether source/destination checks are enabled.

sriov_net_support class-attribute instance-attribute
sriov_net_support: AttributeValue | None = ...

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

user_data class-attribute instance-attribute
user_data: AttributeValue | None = ...

The user data.