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

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeHostReservations Source #

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

Instances details
ToHeaders DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

ToPath DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

ToQuery DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

AWSPager DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

AWSRequest DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Generic DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Associated Types

type Rep DescribeHostReservations :: Type -> Type #

Read DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Show DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

NFData DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Eq DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Hashable DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

type AWSResponse DescribeHostReservations Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

type Rep DescribeHostReservations Source # 
Instance details

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 Source #

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]) Source #

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

describeHostReservations_nextToken :: Lens' DescribeHostReservations (Maybe Text) Source #

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

Destructuring the Response

data DescribeHostReservationsResponse Source #

See: newDescribeHostReservationsResponse smart constructor.

Constructors

DescribeHostReservationsResponse' 

Fields

Instances

Instances details
Generic DescribeHostReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Associated Types

type Rep DescribeHostReservationsResponse :: Type -> Type #

Read DescribeHostReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Show DescribeHostReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

NFData DescribeHostReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

Eq DescribeHostReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeHostReservations

type Rep DescribeHostReservationsResponse Source # 
Instance details

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 Source #

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