| 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 |
Amazonka.EC2.GetGroupsForCapacityReservation
Description
Lists the resource groups to which a Capacity Reservation has been added.
This operation returns paginated results.
Synopsis
- data GetGroupsForCapacityReservation = GetGroupsForCapacityReservation' {}
- newGetGroupsForCapacityReservation :: Text -> GetGroupsForCapacityReservation
- getGroupsForCapacityReservation_dryRun :: Lens' GetGroupsForCapacityReservation (Maybe Bool)
- getGroupsForCapacityReservation_maxResults :: Lens' GetGroupsForCapacityReservation (Maybe Natural)
- getGroupsForCapacityReservation_nextToken :: Lens' GetGroupsForCapacityReservation (Maybe Text)
- getGroupsForCapacityReservation_capacityReservationId :: Lens' GetGroupsForCapacityReservation Text
- data GetGroupsForCapacityReservationResponse = GetGroupsForCapacityReservationResponse' {}
- newGetGroupsForCapacityReservationResponse :: Int -> GetGroupsForCapacityReservationResponse
- getGroupsForCapacityReservationResponse_capacityReservationGroups :: Lens' GetGroupsForCapacityReservationResponse (Maybe [CapacityReservationGroup])
- getGroupsForCapacityReservationResponse_nextToken :: Lens' GetGroupsForCapacityReservationResponse (Maybe Text)
- getGroupsForCapacityReservationResponse_httpStatus :: Lens' GetGroupsForCapacityReservationResponse Int
Creating a Request
data GetGroupsForCapacityReservation Source #
See: newGetGroupsForCapacityReservation smart constructor.
Constructors
| GetGroupsForCapacityReservation' | |
Fields
| |
Instances
newGetGroupsForCapacityReservation Source #
Create a value of GetGroupsForCapacityReservation 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:dryRun:GetGroupsForCapacityReservation', getGroupsForCapacityReservation_dryRun - Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
$sel:maxResults:GetGroupsForCapacityReservation', getGroupsForCapacityReservation_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.
GetGroupsForCapacityReservation, getGroupsForCapacityReservation_nextToken - The token to use to retrieve the next page of results.
GetGroupsForCapacityReservation, getGroupsForCapacityReservation_capacityReservationId - The ID of the Capacity Reservation.
Request Lenses
getGroupsForCapacityReservation_dryRun :: Lens' GetGroupsForCapacityReservation (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
getGroupsForCapacityReservation_maxResults :: Lens' GetGroupsForCapacityReservation (Maybe Natural) 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.
getGroupsForCapacityReservation_nextToken :: Lens' GetGroupsForCapacityReservation (Maybe Text) Source #
The token to use to retrieve the next page of results.
getGroupsForCapacityReservation_capacityReservationId :: Lens' GetGroupsForCapacityReservation Text Source #
The ID of the Capacity Reservation.
Destructuring the Response
data GetGroupsForCapacityReservationResponse Source #
See: newGetGroupsForCapacityReservationResponse smart constructor.
Constructors
| GetGroupsForCapacityReservationResponse' | |
Fields
| |
Instances
newGetGroupsForCapacityReservationResponse Source #
Arguments
| :: Int | |
| -> GetGroupsForCapacityReservationResponse |
Create a value of GetGroupsForCapacityReservationResponse 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:capacityReservationGroups:GetGroupsForCapacityReservationResponse', getGroupsForCapacityReservationResponse_capacityReservationGroups - Information about the resource groups to which the Capacity Reservation
has been added.
GetGroupsForCapacityReservation, getGroupsForCapacityReservationResponse_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:GetGroupsForCapacityReservationResponse', getGroupsForCapacityReservationResponse_httpStatus - The response's http status code.
Response Lenses
getGroupsForCapacityReservationResponse_capacityReservationGroups :: Lens' GetGroupsForCapacityReservationResponse (Maybe [CapacityReservationGroup]) Source #
Information about the resource groups to which the Capacity Reservation has been added.
getGroupsForCapacityReservationResponse_nextToken :: Lens' GetGroupsForCapacityReservationResponse (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.
getGroupsForCapacityReservationResponse_httpStatus :: Lens' GetGroupsForCapacityReservationResponse Int Source #
The response's http status code.