Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeHosts

Describes one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

Request Parameters

The 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.

Filter.N

One or more filters.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation assigned to this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

Type: Array of Filter objects

Required: No

HostId.N

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Type: Array of strings

Required: No

MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

Type: Integer

Required: No

NextToken

The token to retrieve the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

hostSet

Information about the Dedicated Hosts.

Type: Array of Host objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example describes the Dedicated Hosts in your account.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeHosts &AUTHPARAMS

Sample Response

Copy
<DescribeHostsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId> <hostSet> <item></item> <availableCapacity> <availableVCpus>1</availableVCpus> <availableInstanceCapacity> <item> <availableCapacity>32</availableCapacity> <totalCapacity>32</totalCapacity> <instanceType>m3.medium</instanceType> </item> </availableInstanceCapacity> </availableCapacity> <instances/> <autoPlacement>off</autoPlacement> <hostId>h-00548908djdsgfs</hostId> <state>available</state> <hostProperties> <total VCpus>1</totalVCpus> <cores>20</cores> <sockets>2</sockets> <instanceType>m3.medium</instanceType> </hostProperties> <availabilityZone>us-east-1b</availabilityZone> </item> </hostSet> </DescribeHostsResponse>

Example

This example describes a released Dedicated Host in your account using the state filter to show only hosts with a state of released.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeHosts &Filter.1.Name=state &Filter.1.Value=released &AUTHPARAMS

Sample Response

Copy
<DescribeHostsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>d4904fd9-82c2-4ea5-adfe-a9983EXAMPLE</requestId> <hostSet> <item> <instances/> <autoPlacement>on</autoPlacement> <hostId>h-00548908djdsgfs</hostId> <state>released</state> <hostProperties> <totalVCpus>1</totalVCpus> <cores>20</cores> <sockets>2</sockets> <instanceType>m3.medium</instanceType> </hostProperties> <availabilityZone>us-east-1b</availabilityZone> </item> </hostSet> </DescribeHostsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: