Amazonka.EC2.DescribeHostReservations

Describes reservations that are associated with Dedicated Hosts in your account.

This operation returns paginated results.

Creating a Request

data DescribeHostReservations

See: newDescribeHostReservations smart constructor.

Constructors

DescribeHostReservations'

Fields

• filter' :: Maybe [Filter]

  The filters.

  • instance-family - The instance family (for example, m4).
  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
  • state - The state of the reservation (payment-pending | payment-failed | active | retired).
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • 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.
• hostReservationIdSet :: Maybe [Text]

  The host reservation IDs.

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

• nextToken :: Maybe Text

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

Instances

ToHeaders DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

toHeaders :: DescribeHostReservations -> [Header]

ToPath DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

toPath :: DescribeHostReservations -> ByteString

ToQuery DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

toQuery :: DescribeHostReservations -> QueryString

AWSPager DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

page :: DescribeHostReservations -> AWSResponse DescribeHostReservations -> Maybe DescribeHostReservations

AWSRequest DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Associated Types

type AWSResponse DescribeHostReservations

Methods

request :: (Service -> Service) -> DescribeHostReservations -> Request DescribeHostReservations

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

Generic DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Associated Types

type Rep DescribeHostReservations :: Type -> Type

Methods

from :: DescribeHostReservations -> Rep DescribeHostReservations x

to :: Rep DescribeHostReservations x -> DescribeHostReservations

Read DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

readsPrec :: Int -> ReadS DescribeHostReservations

readList :: ReadS [DescribeHostReservations]

readPrec :: ReadPrec DescribeHostReservations

readListPrec :: ReadPrec [DescribeHostReservations]

Show DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

showsPrec :: Int -> DescribeHostReservations -> ShowS

show :: DescribeHostReservations -> String

showList :: [DescribeHostReservations] -> ShowS

NFData DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

rnf :: DescribeHostReservations -> ()

Eq DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

(==) :: DescribeHostReservations -> DescribeHostReservations -> Bool

(/=) :: DescribeHostReservations -> DescribeHostReservations -> Bool

Hashable DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

Methods

hashWithSalt :: Int -> DescribeHostReservations -> Int

hash :: DescribeHostReservations -> Int

type AWSResponse DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

type AWSResponse DescribeHostReservations = DescribeHostReservationsResponse

type Rep DescribeHostReservations

Defined in Amazonka.EC2.DescribeHostReservations

type Rep DescribeHostReservations = D1 ('MetaData "DescribeHostReservations" "Amazonka.EC2.DescribeHostReservations" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeHostReservations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "hostReservationIdSet") '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)))))

newDescribeHostReservations :: DescribeHostReservations

Create a value of DescribeHostReservations 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':DescribeHostReservations', describeHostReservations_filter - The filters.

• instance-family - The instance family (for example, m4).
• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
• state - The state of the reservation (payment-pending | payment-failed | active | retired).
• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
• 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:hostReservationIdSet:DescribeHostReservations', describeHostReservations_hostReservationIdSet - The host reservation IDs.

$sel:maxResults:DescribeHostReservations', describeHostReservations_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.

DescribeHostReservations, describeHostReservations_nextToken - The token to use to retrieve the next page of results.

Request Lenses

describeHostReservations_filter :: Lens' DescribeHostReservations (Maybe [Filter])

The filters.

• instance-family - The instance family (for example, m4).
• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
• state - The state of the reservation (payment-pending | payment-failed | active | retired).
• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
• 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.

describeHostReservations_hostReservationIdSet :: Lens' DescribeHostReservations (Maybe [Text])

The host reservation IDs.

describeHostReservations_maxResults :: Lens' DescribeHostReservations (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.

describeHostReservations_nextToken :: Lens' DescribeHostReservations (Maybe Text)

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

Destructuring the Response

data DescribeHostReservationsResponse

See: newDescribeHostReservationsResponse smart constructor.

Constructors

DescribeHostReservationsResponse'

Fields

• hostReservationSet :: Maybe [HostReservation]

  Details about the reservation's configuration.

• 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

Generic DescribeHostReservationsResponse

Defined in Amazonka.EC2.DescribeHostReservations

Associated Types

type Rep DescribeHostReservationsResponse :: Type -> Type

Methods

from :: DescribeHostReservationsResponse -> Rep DescribeHostReservationsResponse x

to :: Rep DescribeHostReservationsResponse x -> DescribeHostReservationsResponse

Read DescribeHostReservationsResponse

Defined in Amazonka.EC2.DescribeHostReservations

Methods

readsPrec :: Int -> ReadS DescribeHostReservationsResponse

readList :: ReadS [DescribeHostReservationsResponse]

readPrec :: ReadPrec DescribeHostReservationsResponse

readListPrec :: ReadPrec [DescribeHostReservationsResponse]

Show DescribeHostReservationsResponse

Defined in Amazonka.EC2.DescribeHostReservations

Methods

showsPrec :: Int -> DescribeHostReservationsResponse -> ShowS

show :: DescribeHostReservationsResponse -> String

showList :: [DescribeHostReservationsResponse] -> ShowS

NFData DescribeHostReservationsResponse

Defined in Amazonka.EC2.DescribeHostReservations

Methods

rnf :: DescribeHostReservationsResponse -> ()

Eq DescribeHostReservationsResponse

Defined in Amazonka.EC2.DescribeHostReservations

Methods

(==) :: DescribeHostReservationsResponse -> DescribeHostReservationsResponse -> Bool

(/=) :: DescribeHostReservationsResponse -> DescribeHostReservationsResponse -> Bool

type Rep DescribeHostReservationsResponse

Defined in Amazonka.EC2.DescribeHostReservations

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

newDescribeHostReservationsResponse

Arguments

:: Int

$sel:httpStatus:DescribeHostReservationsResponse'

-> DescribeHostReservationsResponse

Create a value of DescribeHostReservationsResponse 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:hostReservationSet:DescribeHostReservationsResponse', describeHostReservationsResponse_hostReservationSet - Details about the reservation's configuration.

DescribeHostReservations, describeHostReservationsResponse_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:DescribeHostReservationsResponse', describeHostReservationsResponse_httpStatus - The response's http status code.

Response Lenses

describeHostReservationsResponse_hostReservationSet :: Lens' DescribeHostReservationsResponse (Maybe [HostReservation])

Details about the reservation's configuration.

describeHostReservationsResponse_nextToken :: Lens' DescribeHostReservationsResponse (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.

describeHostReservationsResponse_httpStatus :: Lens' DescribeHostReservationsResponse Int

The response's http status code.