Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes reservations that are associated with Dedicated Hosts in your account.
This operation returns paginated results.
Synopsis
- data DescribeHostReservations = DescribeHostReservations' {}
- newDescribeHostReservations :: DescribeHostReservations
- describeHostReservations_filter :: Lens' DescribeHostReservations (Maybe [Filter])
- describeHostReservations_hostReservationIdSet :: Lens' DescribeHostReservations (Maybe [Text])
- describeHostReservations_maxResults :: Lens' DescribeHostReservations (Maybe Int)
- describeHostReservations_nextToken :: Lens' DescribeHostReservations (Maybe Text)
- data DescribeHostReservationsResponse = DescribeHostReservationsResponse' {}
- newDescribeHostReservationsResponse :: Int -> DescribeHostReservationsResponse
- describeHostReservationsResponse_hostReservationSet :: Lens' DescribeHostReservationsResponse (Maybe [HostReservation])
- describeHostReservationsResponse_nextToken :: Lens' DescribeHostReservationsResponse (Maybe Text)
- describeHostReservationsResponse_httpStatus :: Lens' DescribeHostReservationsResponse Int
Creating a Request
data DescribeHostReservations Source #
See: newDescribeHostReservations
smart constructor.
DescribeHostReservations' | |
|
Instances
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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]) Source #
The host reservation IDs.
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.
DescribeHostReservationsResponse' | |
|
Instances
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_hostReservationSet :: Lens' DescribeHostReservationsResponse (Maybe [HostReservation]) Source #
Details about the reservation's configuration.
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.
describeHostReservationsResponse_httpStatus :: Lens' DescribeHostReservationsResponse Int Source #
The response's http status code.