amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeHosts

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeHosts Source #

See: newDescribeHosts smart constructor.

Constructors

DescribeHosts' 

Fields

  • filter' :: Maybe [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 :: Maybe [Text]

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

  • maxResults :: Maybe Int

    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 :: Maybe Text

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

Instances

Instances details
ToHeaders DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

toHeaders :: DescribeHosts -> [Header] #

ToPath DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

toPath :: DescribeHosts -> ByteString #

ToQuery DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

toQuery :: DescribeHosts -> QueryString #

AWSPager DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

page :: DescribeHosts -> AWSResponse DescribeHosts -> Maybe DescribeHosts #

AWSRequest DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Associated Types

type AWSResponse DescribeHosts #

Methods

request :: (Service -> Service) -> DescribeHosts -> Request DescribeHosts #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeHosts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeHosts))) #

Generic DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Associated Types

type Rep DescribeHosts :: Type -> Type #

Methods

from :: DescribeHosts -> Rep DescribeHosts x #

to :: Rep DescribeHosts x -> DescribeHosts #

Read DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

readsPrec :: Int -> ReadS DescribeHosts #

readList :: ReadS [DescribeHosts] #

readPrec :: ReadPrec DescribeHosts #

readListPrec :: ReadPrec [DescribeHosts] #

Show DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

showsPrec :: Int -> DescribeHosts -> ShowS #

show :: DescribeHosts -> String #

showList :: [DescribeHosts] -> ShowS #

NFData DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

rnf :: DescribeHosts -> () #

Eq DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

(==) :: DescribeHosts -> DescribeHosts -> Bool #

(/=) :: DescribeHosts -> DescribeHosts -> Bool #

Hashable DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

hashWithSalt :: Int -> DescribeHosts -> Int #

hash :: DescribeHosts -> Int #

type AWSResponse DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

type AWSResponse DescribeHosts = DescribeHostsResponse
type Rep DescribeHosts Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

type Rep DescribeHosts = D1 ('MetaData "DescribeHosts" "Amazonka.EC2.DescribeHosts" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeHosts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "hostIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeHosts :: DescribeHosts Source #

Create a value of DescribeHosts with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filter':DescribeHosts', describeHosts_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.

$sel:hostIds:DescribeHosts', describeHosts_hostIds - The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

$sel:maxResults:DescribeHosts', describeHosts_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.

DescribeHosts, describeHosts_nextToken - The token to use to retrieve the next page of results.

Request Lenses

describeHosts_filter :: Lens' DescribeHosts (Maybe [Filter]) Source #

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.

describeHosts_hostIds :: Lens' DescribeHosts (Maybe [Text]) Source #

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

describeHosts_maxResults :: Lens' DescribeHosts (Maybe Int) Source #

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.

describeHosts_nextToken :: Lens' DescribeHosts (Maybe Text) Source #

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

Destructuring the Response

data DescribeHostsResponse Source #

See: newDescribeHostsResponse smart constructor.

Constructors

DescribeHostsResponse' 

Fields

  • hosts :: Maybe [Host]

    Information about the Dedicated Hosts.

  • nextToken :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeHostsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Associated Types

type Rep DescribeHostsResponse :: Type -> Type #

Methods

from :: DescribeHostsResponse -> Rep DescribeHostsResponse x #

to :: Rep DescribeHostsResponse x -> DescribeHostsResponse #

Read DescribeHostsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

readsPrec :: Int -> ReadS DescribeHostsResponse #

readList :: ReadS [DescribeHostsResponse] #

readPrec :: ReadPrec DescribeHostsResponse #

readListPrec :: ReadPrec [DescribeHostsResponse] #

Show DescribeHostsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

showsPrec :: Int -> DescribeHostsResponse -> ShowS #

show :: DescribeHostsResponse -> String #

showList :: [DescribeHostsResponse] -> ShowS #

NFData DescribeHostsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

rnf :: DescribeHostsResponse -> () #

Eq DescribeHostsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

Methods

(==) :: DescribeHostsResponse -> DescribeHostsResponse -> Bool #

(/=) :: DescribeHostsResponse -> DescribeHostsResponse -> Bool #

type Rep DescribeHostsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHosts

type Rep DescribeHostsResponse = D1 ('MetaData "DescribeHostsResponse" "Amazonka.EC2.DescribeHosts" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeHostsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hosts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Host])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeHostsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeHostsResponse'

-> DescribeHostsResponse 

Create a value of DescribeHostsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hosts:DescribeHostsResponse', describeHostsResponse_hosts - Information about the Dedicated Hosts.

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

$sel:httpStatus:DescribeHostsResponse', describeHostsResponse_httpStatus - The response's http status code.

Response Lenses

describeHostsResponse_hosts :: Lens' DescribeHostsResponse (Maybe [Host]) Source #

Information about the Dedicated Hosts.

describeHostsResponse_nextToken :: Lens' DescribeHostsResponse (Maybe Text) Source #

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

describeHostsResponse_httpStatus :: Lens' DescribeHostsResponse Int Source #

The response's http status code.