Instance Metadata Categories¶
The Instance Metadata Service divides metadata into categories1. Clients must include the categories path within a request when retrieving instance metadata.
The imds-mock offers different levels of support for each of the instance categories. Please consult this table with each future release.
Table Key
This is a living table and will change as new features are released. In the meantime, the following key highlights the level of support for each metadata category.
- : fully supported
- : partially supported, future enhancements planned
- : not currently supported
Categories¶
The following table lists the categories of instance metadata. Highlighted text within a category denotes a dynamic placeholder.
| Category | Supported |
|---|---|
ami-id | v0.1.0 |
ami-launch-index | v0.1.0 |
ami-manifest-path | |
ancestor-ami-ids | |
autoscaling/target-lifecycle-state | |
block-device-mapping/ami | v0.1.0 |
block-device-mapping/ebsN | v0.1.0 |
block-device-mapping/ephemeralN | |
block-device-mapping/root | v0.1.0 |
block-device-mapping/swap | |
elastic-gpus/associations/elastic-gpu-id | |
elastic-inference/associations/eia-id | |
events/maintenance/history | |
events/maintenance/scheduled | |
events/recommendations/rebalance | v0.3.0 |
hostname | v0.1.0 |
iam/info | v0.1.0 |
iam/security-credentials/role-name | v0.1.0 |
identity-credentials/ec2/info | |
identity-credentials/ec2/security-credentials/ec2-instance | |
instance-action | v0.1.0 |
instance-id | v0.1.0 |
instance-life-cycle | v0.1.0 |
instance-type | v0.1.0 |
ipv6 | |
kernel-id | |
local-hostname | v0.1.0 |
local-ipv4 | v0.1.0 |
mac | v0.1.0 |
metrics/vhostmd | |
network/interfaces/macs/mac/device-number | v0.1.0 |
network/interfaces/macs/mac/interface-id | v0.1.0 |
network/interfaces/macs/mac/ipv4-associations/public-ip | |
network/interfaces/macs/mac/ipv6s | |
network/interfaces/macs/mac/local-hostname | v0.1.0 |
network/interfaces/macs/mac/local-ipv4s | v0.1.0 |
network/interfaces/macs/mac/mac | v0.1.0 |
network/interfaces/macs/mac/network-card-index | v0.1.0 |
network/interfaces/macs/mac/owner-id | v0.1.0 |
network/interfaces/macs/mac/public-hostname | |
network/interfaces/macs/mac/public-ipv4s | |
network/interfaces/macs/mac/security-groups | v0.1.0 |
network/interfaces/macs/mac/security-group-ids | v0.1.0 |
network/interfaces/macs/mac/subnet-id | v0.1.0 |
network/interfaces/macs/mac/subnet-ipv4-cidr-block | v0.1.0 |
network/interfaces/macs/mac/subnet-ipv6-cidr-blocks | |
network/interfaces/macs/mac/vpc-id | v0.1.0 |
network/interfaces/macs/mac/vpc-ipv4-cidr-block | v0.1.0 |
network/interfaces/macs/mac/vpc-ipv4-cidr-blocks | v0.1.0 |
network/interfaces/macs/mac/vpc-ipv6-cidr-blocks | v0.1.0 |
placement/availability-zone | v0.1.0 |
placement/availability-zone-id | v0.1.0 |
placement/group-name | |
placement/host-id | |
placement/partition-number | |
placement/region | v0.1.0 |
product-codes | |
public-hostname | |
public-ipv4 | |
public-keys/0/openssh-key | v0.1.0 |
ramdisk-id | |
reservation-id | v0.1.0 |
security-groups | v0.1.0 |
services/domain | v0.1.0 |
services/partition | v0.1.0 |
spot/instance-action | v0.3.0 |
spot/termination-time | v0.3.0 |
tags/instance | v0.2.0 |
Dynamic Categories¶
The following table lists the categories of dynamic data.
| Category | Supported |
|---|---|
fws/instance-monitoring | |
instance-identity/document | |
instance-identity/pkcs7 | |
instance-identity/signature |