Network.AWS.GameLift.ListFleets

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet-related operations include:

• CreateFleet
• ListFleets
• DeleteFleet
• Describe fleets:
• DescribeFleetAttributes
• DescribeFleetCapacity
• DescribeFleetPortSettings
• DescribeFleetUtilization
• DescribeRuntimeConfiguration
• DescribeEC2InstanceLimits
• DescribeFleetEvents
• Update fleets:
• UpdateFleetAttributes
• UpdateFleetCapacity
• UpdateFleetPortSettings
• UpdateRuntimeConfiguration
• Manage fleet actions:
• StartFleetActions
• StopFleetActions

Creating a Request

listFleets :: ListFleets

Creates a value of ListFleets with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lfBuildId - Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.
• lfNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
• lfLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

data ListFleets

Represents the input for a request action.

See: listFleets smart constructor.

Instances

Eq ListFleets

Methods

(==) :: ListFleets -> ListFleets -> Bool

(/=) :: ListFleets -> ListFleets -> Bool

Data ListFleets

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFleets -> c ListFleets

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFleets

toConstr :: ListFleets -> Constr

dataTypeOf :: ListFleets -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListFleets)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFleets)

gmapT :: (forall b. Data b => b -> b) -> ListFleets -> ListFleets

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFleets -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFleets -> r

gmapQ :: (forall d. Data d => d -> u) -> ListFleets -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFleets -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFleets -> m ListFleets

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFleets -> m ListFleets

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFleets -> m ListFleets

Read ListFleets

Methods

readsPrec :: Int -> ReadS ListFleets

readList :: ReadS [ListFleets]

readPrec :: ReadPrec ListFleets

readListPrec :: ReadPrec [ListFleets]

Show ListFleets

Methods

showsPrec :: Int -> ListFleets -> ShowS

show :: ListFleets -> String

showList :: [ListFleets] -> ShowS

Generic ListFleets

Associated Types

type Rep ListFleets :: * -> *

Methods

from :: ListFleets -> Rep ListFleets x

to :: Rep ListFleets x -> ListFleets

Hashable ListFleets

Methods

hashWithSalt :: Int -> ListFleets -> Int

hash :: ListFleets -> Int

ToJSON ListFleets

Methods

toJSON :: ListFleets -> Value

toEncoding :: ListFleets -> Encoding

toJSONList :: [ListFleets] -> Value

toEncodingList :: [ListFleets] -> Encoding

NFData ListFleets

Methods

rnf :: ListFleets -> ()

AWSRequest ListFleets

Associated Types

type Rs ListFleets :: *

Methods

request :: ListFleets -> Request ListFleets

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListFleets -> ClientResponse -> m (Response ListFleets)

ToHeaders ListFleets

Methods

toHeaders :: ListFleets -> [Header]

ToPath ListFleets

Methods

toPath :: ListFleets -> ByteString

ToQuery ListFleets

Methods

toQuery :: ListFleets -> QueryString

type Rep ListFleets

type Rep ListFleets = D1 * (MetaData "ListFleets" "Network.AWS.GameLift.ListFleets" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "ListFleets'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfBuildId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lfLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs ListFleets

type Rs ListFleets = ListFleetsResponse

Request Lenses

lfBuildId :: Lens' ListFleets (Maybe Text)

Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

lfNextToken :: Lens' ListFleets (Maybe Text)

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

lfLimit :: Lens' ListFleets (Maybe Natural)

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

Destructuring the Response

listFleetsResponse

Arguments

:: Int

lfrsResponseStatus

-> ListFleetsResponse

Creates a value of ListFleetsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lfrsNextToken - Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
• lfrsFleetIds - Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes , DescribeFleetCapacity , or DescribeFleetUtilization .
• lfrsResponseStatus - -- | The response status code.

data ListFleetsResponse

Represents the returned data in response to a request action.

See: listFleetsResponse smart constructor.

Instances

Eq ListFleetsResponse

Methods

(==) :: ListFleetsResponse -> ListFleetsResponse -> Bool

(/=) :: ListFleetsResponse -> ListFleetsResponse -> Bool

Data ListFleetsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFleetsResponse -> c ListFleetsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFleetsResponse

toConstr :: ListFleetsResponse -> Constr

dataTypeOf :: ListFleetsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListFleetsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFleetsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListFleetsResponse -> ListFleetsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFleetsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFleetsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListFleetsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFleetsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFleetsResponse -> m ListFleetsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFleetsResponse -> m ListFleetsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFleetsResponse -> m ListFleetsResponse

Read ListFleetsResponse

Methods

readsPrec :: Int -> ReadS ListFleetsResponse

readList :: ReadS [ListFleetsResponse]

readPrec :: ReadPrec ListFleetsResponse

readListPrec :: ReadPrec [ListFleetsResponse]

Show ListFleetsResponse

Methods

showsPrec :: Int -> ListFleetsResponse -> ShowS

show :: ListFleetsResponse -> String

showList :: [ListFleetsResponse] -> ShowS

Generic ListFleetsResponse

Associated Types

type Rep ListFleetsResponse :: * -> *

Methods

from :: ListFleetsResponse -> Rep ListFleetsResponse x

to :: Rep ListFleetsResponse x -> ListFleetsResponse

NFData ListFleetsResponse

Methods

rnf :: ListFleetsResponse -> ()

type Rep ListFleetsResponse

type Rep ListFleetsResponse = D1 * (MetaData "ListFleetsResponse" "Network.AWS.GameLift.ListFleets" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "ListFleetsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfrsFleetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Text)))) (S1 * (MetaSel (Just Symbol "_lfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lfrsNextToken :: Lens' ListFleetsResponse (Maybe Text)

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

lfrsFleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text))

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

lfrsResponseStatus :: Lens' ListFleetsResponse Int

• - | The response status code.