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.ListLocations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all custom and Amazon Web Services locations.

This operation returns paginated results.

Creating a Request

data ListLocations Source #

See: newListLocations smart constructor.

Constructors

ListLocations'

Fields

filters :: Maybe (NonEmpty LocationFilter)
Filters the list for AWS or CUSTOM locations.
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.

Instances

Instances details

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

newListLocations :: ListLocations Source #

Create a value of ListLocations 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:filters:ListLocations', listLocations_filters - Filters the list for AWS or CUSTOM locations.

$sel:limit:ListLocations', listLocations_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

ListLocations, listLocations_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.

Request Lenses

listLocations_filters :: Lens' ListLocations (Maybe (NonEmpty LocationFilter)) Source #

Filters the list for AWS or CUSTOM locations.

listLocations_limit :: Lens' ListLocations (Maybe Natural) Source #

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

listLocations_nextToken :: Lens' ListLocations (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.

Destructuring the Response

data ListLocationsResponse Source #

See: newListLocationsResponse smart constructor.

Constructors

ListLocationsResponse'
Fields locations :: Maybe [LocationModel] A collection of locations. 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 ListLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.ListLocations Associated Types type Rep ListLocationsResponse :: Type -> Type # Methods from :: ListLocationsResponse -> Rep ListLocationsResponse x # to :: Rep ListLocationsResponse x -> ListLocationsResponse #
Read ListLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.ListLocations Methods readsPrec :: Int -> ReadS ListLocationsResponse # readList :: ReadS [ListLocationsResponse] # readPrec :: ReadPrec ListLocationsResponse # readListPrec :: ReadPrec [ListLocationsResponse] #
Show ListLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.ListLocations Methods showsPrec :: Int -> ListLocationsResponse -> ShowS # show :: ListLocationsResponse -> String # showList :: [ListLocationsResponse] -> ShowS #
NFData ListLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.ListLocations Methods rnf :: ListLocationsResponse -> () #
Eq ListLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.ListLocations Methods (==) :: ListLocationsResponse -> ListLocationsResponse -> Bool # (/=) :: ListLocationsResponse -> ListLocationsResponse -> Bool #
type Rep ListLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.ListLocations type Rep ListLocationsResponse = D1 ('MetaData "ListLocationsResponse" "Amazonka.GameLift.ListLocations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "ListLocationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocationModel])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListLocationsResponse Source #

Arguments

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

Create a value of ListLocationsResponse 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:locations:ListLocationsResponse', listLocationsResponse_locations - A collection of locations.

ListLocations, listLocationsResponse_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:ListLocationsResponse', listLocationsResponse_httpStatus - The response's http status code.

Response Lenses

listLocationsResponse_locations :: Lens' ListLocationsResponse (Maybe [LocationModel]) Source #

A collection of locations.

listLocationsResponse_nextToken :: Lens' ListLocationsResponse (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.

listLocationsResponse_httpStatus :: Lens' ListLocationsResponse Int Source #

The response's http status code.