Skip to content

Describe Hosts

ec2_describe_hosts R Documentation

Describes the specified Dedicated Hosts or all your Dedicated 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.

Usage

ec2_describe_hosts(Filter, HostIds, MaxResults, NextToken)

Arguments

Filter

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.

HostIds

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

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

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

NextToken

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

Value

A list with the following syntax: 

list(
  Hosts = list(
    list(
      AutoPlacement = "on"|"off",
      AvailabilityZone = "string",
      AvailableCapacity = list(
        AvailableInstanceCapacity = list(
          list(
            AvailableCapacity = 123,
            InstanceType = "string",
            TotalCapacity = 123
          )
        ),
        AvailableVCpus = 123
      ),
      ClientToken = "string",
      HostId = "string",
      HostProperties = list(
        Cores = 123,
        InstanceType = "string",
        InstanceFamily = "string",
        Sockets = 123,
        TotalVCpus = 123
      ),
      HostReservationId = "string",
      Instances = list(
        list(
          InstanceId = "string",
          InstanceType = "string",
          OwnerId = "string"
        )
      ),
      State = "available"|"under-assessment"|"permanent-failure"|"released"|"released-permanent-failure"|"pending",
      AllocationTime = as.POSIXct(
        "2015-01-01"
      ),
      ReleaseTime = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      HostRecovery = "on"|"off",
      AllowsMultipleInstanceTypes = "on"|"off",
      OwnerId = "string",
      AvailabilityZoneId = "string",
      MemberOfServiceLinkedResourceGroup = TRUE|FALSE,
      OutpostArn = "string",
      HostMaintenance = "on"|"off",
      AssetId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_hosts(
  Filter = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  HostIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)