Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.ListFleets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a collection of fleet resources in an AWS Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

This operation can be used in the following ways:

To get a list of all fleets in a Region, don't provide a build or script identifier.
To get a list of all fleets where a specific custom game build is deployed, provide the build ID.
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.

Fleet resources are not listed in a particular order.

Learn more

Setting up GameLift fleets

Related actions

This operation returns paginated results.

Synopsis

data ListFleets = ListFleets' {
- buildId :: Maybe Text
- nextToken :: Maybe Text
- scriptId :: Maybe Text
- limit :: Maybe Natural
}
newListFleets :: ListFleets
listFleets_buildId :: Lens' ListFleets (Maybe Text)
listFleets_nextToken :: Lens' ListFleets (Maybe Text)
listFleets_scriptId :: Lens' ListFleets (Maybe Text)
listFleets_limit :: Lens' ListFleets (Maybe Natural)
data ListFleetsResponse = ListFleetsResponse' {
- nextToken :: Maybe Text
- fleetIds :: Maybe (NonEmpty Text)
- httpStatus :: Int
}
newListFleetsResponse :: Int -> ListFleetsResponse
listFleetsResponse_nextToken :: Lens' ListFleetsResponse (Maybe Text)
listFleetsResponse_fleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text))
listFleetsResponse_httpStatus :: Lens' ListFleetsResponse Int

Creating a Request

data ListFleets Source #

Represents the input for a request operation.

See: newListFleets smart constructor.

Constructors

ListFleets'

Fields

buildId :: Maybe Text
A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.
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.
scriptId :: Maybe Text
A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Instances

Instances details

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

newListFleets :: ListFleets Source #

Create a value of ListFleets 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:buildId:ListFleets', listFleets_buildId - A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

$sel:nextToken:ListFleets', listFleets_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.

$sel:scriptId:ListFleets', listFleets_scriptId - A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

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

Request Lenses

listFleets_buildId :: Lens' ListFleets (Maybe Text) Source #

A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

listFleets_nextToken :: Lens' ListFleets (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.

listFleets_scriptId :: Lens' ListFleets (Maybe Text) Source #

A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

listFleets_limit :: Lens' ListFleets (Maybe Natural) Source #

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

Destructuring the Response

data ListFleetsResponse Source #

Represents the returned data in response to a request operation.

See: newListFleetsResponse smart constructor.

Constructors

ListFleetsResponse'

Fields

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.
fleetIds :: Maybe (NonEmpty Text)
A set of fleet IDs that match the list request. You can retrieve additional information about all returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization call.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListFleetsResponse Source #

Arguments

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

Create a value of ListFleetsResponse 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:nextToken:ListFleets', listFleetsResponse_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:fleetIds:ListFleetsResponse', listFleetsResponse_fleetIds - A set of fleet IDs that match the list request. You can retrieve additional information about all returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization call.

$sel:httpStatus:ListFleetsResponse', listFleetsResponse_httpStatus - The response's http status code.

Response Lenses

listFleetsResponse_nextToken :: Lens' ListFleetsResponse (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.

listFleetsResponse_fleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text)) Source #

A set of fleet IDs that match the list request. You can retrieve additional information about all returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization call.

listFleetsResponse_httpStatus :: Lens' ListFleetsResponse Int Source #

The response's http status code.