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.GameLift.ListCompute

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCompute Source #

See: newListCompute smart constructor.

Constructors

ListCompute'

Fields

limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
location :: Maybe Text
The name of the custom location that the compute resources are assigned to.
nextToken :: Maybe Text
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
fleetId :: Text
A unique identifier for the fleet the compute resources are registered to.

Instances

Instances details

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

newListCompute Source #

Arguments

:: Text	`ListCompute`
-> ListCompute

Create a value of ListCompute 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:limit:ListCompute', listCompute_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

ListCompute, listCompute_location - The name of the custom location that the compute resources are assigned to.

ListCompute, listCompute_nextToken - A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

ListCompute, listCompute_fleetId - A unique identifier for the fleet the compute resources are registered to.

Request Lenses

listCompute_limit :: Lens' ListCompute (Maybe Natural) Source #

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

listCompute_location :: Lens' ListCompute (Maybe Text) Source #

The name of the custom location that the compute resources are assigned to.

listCompute_nextToken :: Lens' ListCompute (Maybe Text) Source #

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

listCompute_fleetId :: Lens' ListCompute Text Source #

A unique identifier for the fleet the compute resources are registered to.

Destructuring the Response

data ListComputeResponse Source #

See: newListComputeResponse smart constructor.

Constructors

ListComputeResponse'
Fields computeList :: Maybe [Compute] A list of compute resources registered to the fleet you specified. nextToken :: Maybe Text A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListComputeResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListComputeResponse'`
-> ListComputeResponse

Create a value of ListComputeResponse 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:computeList:ListComputeResponse', listComputeResponse_computeList - A list of compute resources registered to the fleet you specified.

ListCompute, listComputeResponse_nextToken - A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

$sel:httpStatus:ListComputeResponse', listComputeResponse_httpStatus - The response's http status code.

Response Lenses

listComputeResponse_computeList :: Lens' ListComputeResponse (Maybe [Compute]) Source #

A list of compute resources registered to the fleet you specified.

listComputeResponse_nextToken :: Lens' ListComputeResponse (Maybe Text) Source #

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

listComputeResponse_httpStatus :: Lens' ListComputeResponse Int Source #

The response's http status code.