Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.
- describeHostReservations :: DescribeHostReservations
- data DescribeHostReservations
- dhrNextToken :: Lens' DescribeHostReservations (Maybe Text)
- dhrHostReservationIdSet :: Lens' DescribeHostReservations [Text]
- dhrFilter :: Lens' DescribeHostReservations [Filter]
- dhrMaxResults :: Lens' DescribeHostReservations (Maybe Int)
- describeHostReservationsResponse :: Int -> DescribeHostReservationsResponse
- data DescribeHostReservationsResponse
- dhrrsNextToken :: Lens' DescribeHostReservationsResponse (Maybe Text)
- dhrrsHostReservationSet :: Lens' DescribeHostReservationsResponse [HostReservation]
- dhrrsResponseStatus :: Lens' DescribeHostReservationsResponse Int
Creating a Request
describeHostReservations :: DescribeHostReservations Source #
Creates a value of DescribeHostReservations
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dhrNextToken
- The token to use to retrieve the next page of results.dhrHostReservationIdSet
- One or more host reservation IDs.dhrFilter
- One or more filters. *instance-family
- The instance family (e.g.,m4
). *payment-option
- The payment option (NoUpfront
|PartialUpfront
|AllUpfront
). *state
- The state of the reservation (payment-pending
|payment-failed
|active
|retired
).dhrMaxResults
- 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 returnednextToken
value. This value can be between 5 and 500; ifmaxResults
is given a larger value than 500, you will receive an error.
data DescribeHostReservations Source #
See: describeHostReservations
smart constructor.
Request Lenses
dhrNextToken :: Lens' DescribeHostReservations (Maybe Text) Source #
The token to use to retrieve the next page of results.
dhrHostReservationIdSet :: Lens' DescribeHostReservations [Text] Source #
One or more host reservation IDs.
dhrFilter :: Lens' DescribeHostReservations [Filter] Source #
One or more filters. * instance-family
- The instance family (e.g., m4
). * payment-option
- The payment option (NoUpfront
| PartialUpfront
| AllUpfront
). * state
- The state of the reservation (payment-pending
| payment-failed
| active
| retired
).
dhrMaxResults :: 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 will receive an error.
Destructuring the Response
describeHostReservationsResponse Source #
Creates a value of DescribeHostReservationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dhrrsNextToken
- The token to use to retrieve the next page of results. This value isnull
when there are no more results to return.dhrrsHostReservationSet
- Details about the reservation's configuration.dhrrsResponseStatus
- -- | The response status code.
data DescribeHostReservationsResponse Source #
See: describeHostReservationsResponse
smart constructor.
Response Lenses
dhrrsNextToken :: 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.
dhrrsHostReservationSet :: Lens' DescribeHostReservationsResponse [HostReservation] Source #
Details about the reservation's configuration.
dhrrsResponseStatus :: Lens' DescribeHostReservationsResponse Int Source #
- - | The response status code.