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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the resource groups to which a Capacity Reservation has been added.

This operation returns paginated results.

Synopsis

Creating a Request

data GetGroupsForCapacityReservation Source #

See: newGetGroupsForCapacityReservation smart constructor.

Constructors

GetGroupsForCapacityReservation'

Fields

dryRun :: Maybe Bool
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.
maxResults :: Maybe Natural
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.
capacityReservationId :: Text
The ID of the Capacity Reservation.

Instances

Instances details

ToHeaders GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods toHeaders :: GetGroupsForCapacityReservation -> [Header] #
ToPath GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods toPath :: GetGroupsForCapacityReservation -> ByteString #
ToQuery GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods toQuery :: GetGroupsForCapacityReservation -> QueryString #
AWSPager GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods page :: GetGroupsForCapacityReservation -> AWSResponse GetGroupsForCapacityReservation -> Maybe GetGroupsForCapacityReservation #
AWSRequest GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Associated Types type AWSResponse GetGroupsForCapacityReservation # Methods request :: (Service -> Service) -> GetGroupsForCapacityReservation -> Request GetGroupsForCapacityReservation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetGroupsForCapacityReservation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetGroupsForCapacityReservation))) #
Generic GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Associated Types type Rep GetGroupsForCapacityReservation :: Type -> Type # Methods from :: GetGroupsForCapacityReservation -> Rep GetGroupsForCapacityReservation x # to :: Rep GetGroupsForCapacityReservation x -> GetGroupsForCapacityReservation #
Read GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods readsPrec :: Int -> ReadS GetGroupsForCapacityReservation # readList :: ReadS [GetGroupsForCapacityReservation] # readPrec :: ReadPrec GetGroupsForCapacityReservation # readListPrec :: ReadPrec [GetGroupsForCapacityReservation] #
Show GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods showsPrec :: Int -> GetGroupsForCapacityReservation -> ShowS # show :: GetGroupsForCapacityReservation -> String # showList :: [GetGroupsForCapacityReservation] -> ShowS #
NFData GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods rnf :: GetGroupsForCapacityReservation -> () #
Eq GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods (==) :: GetGroupsForCapacityReservation -> GetGroupsForCapacityReservation -> Bool # (/=) :: GetGroupsForCapacityReservation -> GetGroupsForCapacityReservation -> Bool #
Hashable GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods hashWithSalt :: Int -> GetGroupsForCapacityReservation -> Int # hash :: GetGroupsForCapacityReservation -> Int #
type AWSResponse GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation type AWSResponse GetGroupsForCapacityReservation = GetGroupsForCapacityReservationResponse
type Rep GetGroupsForCapacityReservation Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation type Rep GetGroupsForCapacityReservation = D1 ('MetaData "GetGroupsForCapacityReservation" "Amazonka.EC2.GetGroupsForCapacityReservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetGroupsForCapacityReservation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capacityReservationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetGroupsForCapacityReservation Source #

Arguments

:: Text	`GetGroupsForCapacityReservation`
-> GetGroupsForCapacityReservation

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 capacityReservationGroups :: Maybe [CapacityReservationGroup] Information about the resource groups to which the Capacity Reservation has been added. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetGroupsForCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Associated Types type Rep GetGroupsForCapacityReservationResponse :: Type -> Type # Methods from :: GetGroupsForCapacityReservationResponse -> Rep GetGroupsForCapacityReservationResponse x # to :: Rep GetGroupsForCapacityReservationResponse x -> GetGroupsForCapacityReservationResponse #
Read GetGroupsForCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods readsPrec :: Int -> ReadS GetGroupsForCapacityReservationResponse # readList :: ReadS [GetGroupsForCapacityReservationResponse] # readPrec :: ReadPrec GetGroupsForCapacityReservationResponse # readListPrec :: ReadPrec [GetGroupsForCapacityReservationResponse] #
Show GetGroupsForCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods showsPrec :: Int -> GetGroupsForCapacityReservationResponse -> ShowS # show :: GetGroupsForCapacityReservationResponse -> String # showList :: [GetGroupsForCapacityReservationResponse] -> ShowS #
NFData GetGroupsForCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods rnf :: GetGroupsForCapacityReservationResponse -> () #
Eq GetGroupsForCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation Methods (==) :: GetGroupsForCapacityReservationResponse -> GetGroupsForCapacityReservationResponse -> Bool # (/=) :: GetGroupsForCapacityReservationResponse -> GetGroupsForCapacityReservationResponse -> Bool #
type Rep GetGroupsForCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.GetGroupsForCapacityReservation type Rep GetGroupsForCapacityReservationResponse = D1 ('MetaData "GetGroupsForCapacityReservationResponse" "Amazonka.EC2.GetGroupsForCapacityReservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetGroupsForCapacityReservationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacityReservationGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityReservationGroup])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetGroupsForCapacityReservationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetGroupsForCapacityReservationResponse'`
-> 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.