Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

describe-hosts

Description

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-hosts is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Hosts

Synopsis

  describe-hosts
[--filter <value>]
[--host-ids <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filter (list)

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.

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--host-ids (list)

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

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe Dedicated hosts in your account and generate a machine-readable list

To output a list of Dedicated host IDs in JSON (comma separated).

Command:

aws ec2 describe-hosts --query 'Hosts[].HostId' --output json

Output:

[
"h-085664df5899941c",
"h-056c1b0724170dc38"
]

To output a list of Dedicated host IDs in plaintext (comma separated).

Command:

aws ec2 describe-hosts --query 'Hosts[].HostId' --output text

Output:: h-085664df5899941c h-056c1b0724170dc38

To describe available Dedicated hosts in your account

Command:

aws ec2 describe-hosts --filter "Name=state,Values=available"

Output:

{
  "Hosts":  [
      {
          "HostId": "h-085664df5899941c"
          "HostProperties: {
              "Cores": 20,
               "Sockets": 2,
                "InstanceType": "m3.medium".
                "TotalVCpus": 32
           },
           "Instances": [],
            "State": "available",
            "AvailabilityZone": "us-east-1b",
            "AvailableCapacity": {
                "AvailableInstanceCapacity": [
                    {
                          "AvailableCapacity": 32,
                          "InstanceType": "m3.medium",
                          "TotalCapacity": 32
                    }
                 ],
                 "AvailableVCpus": 32
            },
            "AutoPlacement": "off"
     }
  ]
}

Output

Hosts -> (list)

Information about the Dedicated Hosts.

(structure)

Describes the properties of the Dedicated Host.

AutoPlacement -> (string)

Whether auto-placement is on or off.

AvailabilityZone -> (string)

The Availability Zone of the Dedicated Host.

AvailableCapacity -> (structure)

The number of new instances that can be launched onto the Dedicated Host.

AvailableInstanceCapacity -> (list)

The total number of instances supported by the Dedicated Host.

(structure)

Information about the instance type that the Dedicated Host supports.

AvailableCapacity -> (integer)

The number of instances that can still be launched onto the Dedicated Host.

InstanceType -> (string)

The instance type size supported by the Dedicated Host.

TotalCapacity -> (integer)

The total number of instances that can be launched onto the Dedicated Host.

AvailableVCpus -> (integer)

The number of vCPUs available on the Dedicated Host.

ClientToken -> (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .

HostId -> (string)

The ID of the Dedicated Host.

HostProperties -> (structure)

The hardware specifications of the Dedicated Host.

Cores -> (integer)

The number of cores on the Dedicated Host.

InstanceType -> (string)

The instance type size that the Dedicated Host supports (for example, m3.medium ).

Sockets -> (integer)

The number of sockets on the Dedicated Host.

TotalVCpus -> (integer)

The number of vCPUs on the Dedicated Host.

HostReservationId -> (string)

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

Instances -> (list)

The IDs and instance type that are currently running on the Dedicated Host.

(structure)

Describes an instance running on a Dedicated Host.

InstanceId -> (string)

the IDs of instances that are running on the Dedicated Host.

InstanceType -> (string)

The instance type size (for example, m3.medium ) of the running instance.

State -> (string)

The Dedicated Host's state.

AllocationTime -> (timestamp)

The time that the Dedicated Host was allocated.

ReleaseTime -> (timestamp)

The time that the Dedicated Host was released.

Tags -> (list)

Any tags assigned to the Dedicated Host.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

HostRecovery -> (string)

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

NextToken -> (string)

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