DescribeHosts#

Description#

Request for the list of all existing dedicated hosts and their descriptions. Filtering by one or more dedicated host parameters can be applied.

Request Parameters#

  • Filter.N — The name of the filter.

    • Type: List of Filter objects

    • Required: No

  • HostId.N — The IDs of the dedicated hosts.

    • Type: Array of strings

    • Required: No

Supported Filters#

  • auto-placement — Whether automated placement is enabled or disabled.

    • Type: String

    • Required: No

    • Values: on | off

  • availability-zone — The name of the availability zone.

    • Type: String

    • Required: No

  • instance-type — The type of instance that the dedicated host supports.

    • Type: String

    • Required: No

  • state — The dedicated host’s state.

    • Type: String

    • Required: No

    • Values: pending | available | under-assessment | permanent-failure | temporary-failure | released | released-permanent-failure

  • tag-key — The tag key. Such a filter allows you to find dedicated hosts with the specified key regardless of the key value.

    • Type: String

    • Required: No

  • tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.

    • Type: String

    • Required: No

Response Elements#

  • requestId — The request ID.

    • Type: String

  • hostSet — Information about the dedicated hosts.

    • Type: List of Host objects