Skip to content

EC2  >  Operations  >  describe_hosts

describe_hosts

Operation

describe_hosts async 

describe_hosts(input: DescribeHostsInput, plugins: list[Plugin] | None = None) -> DescribeHostsOutput

Describes the specified Dedicated Hosts or all 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 are listed with the state released.

Parameters:

Name Type Description Default
input DescribeHostsInput

An instance of DescribeHostsInput.

 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
DescribeHostsOutput

An instance of DescribeHostsOutput.

Input

DescribeHostsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeHostsInput structure.

Attributes

filter class-attribute instance-attribute 
filter: list[Filter] | None = ...

The filters.

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

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

  • client-token - The idempotency token that you provided when you allocated the host.

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

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

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

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

host_ids class-attribute instance-attribute 
host_ids: list[str] | None = ...

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

max_results class-attribute instance-attribute 
max_results: int | None = ...

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 receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

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

The token to use to retrieve the next page of results.

Output

DescribeHostsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeHostsOutput structure.

Attributes

hosts class-attribute instance-attribute 
hosts: list[Host] | None = ...

Information about the Dedicated Hosts.

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

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

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.