You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeHostReservationsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeHostReservationsRequest
- Defined in:
- (unknown)
Overview
When passing DescribeHostReservationsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
filter: [
{
name: "String",
values: ["String"],
},
],
host_reservation_id_set: ["HostReservationId"],
max_results: 1,
next_token: "String",
}
Instance Attribute Summary collapse
-
#filter ⇒ Array<Types::Filter>
The filters.
-
#host_reservation_id_set ⇒ Array<String>
The host reservation IDs.
-
#max_results ⇒ Integer
The maximum number of results to return for the request in a single page.
-
#next_token ⇒ String
The token to use to retrieve the next page of results.
Instance Attribute Details
#filter ⇒ Array<Types::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.
#host_reservation_id_set ⇒ Array<String>
The host reservation IDs.
#max_results ⇒ Integer
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.
#next_token ⇒ String
The token to use to retrieve the next page of results.