Network.AWS.GameLift.DescribeFleetCapacity

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Creating a Request

describeFleetCapacity :: DescribeFleetCapacity

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

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

• dfcNextToken
• dfcLimit
• dfcFleetIds

data DescribeFleetCapacity

Represents the input for a request action.

See: describeFleetCapacity smart constructor.

Instances

Eq DescribeFleetCapacity

Methods

(==) :: DescribeFleetCapacity -> DescribeFleetCapacity -> Bool

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

Data DescribeFleetCapacity

Methods

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

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

toConstr :: DescribeFleetCapacity -> Constr

dataTypeOf :: DescribeFleetCapacity -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeFleetCapacity

Methods

readsPrec :: Int -> ReadS DescribeFleetCapacity

readList :: ReadS [DescribeFleetCapacity]

readPrec :: ReadPrec DescribeFleetCapacity

readListPrec :: ReadPrec [DescribeFleetCapacity]

Show DescribeFleetCapacity

Methods

showsPrec :: Int -> DescribeFleetCapacity -> ShowS

show :: DescribeFleetCapacity -> String

showList :: [DescribeFleetCapacity] -> ShowS

Generic DescribeFleetCapacity

Associated Types

type Rep DescribeFleetCapacity :: * -> *

Methods

from :: DescribeFleetCapacity -> Rep DescribeFleetCapacity x

to :: Rep DescribeFleetCapacity x -> DescribeFleetCapacity

Hashable DescribeFleetCapacity

Methods

hashWithSalt :: Int -> DescribeFleetCapacity -> Int

hash :: DescribeFleetCapacity -> Int

NFData DescribeFleetCapacity

Methods

rnf :: DescribeFleetCapacity -> ()

AWSRequest DescribeFleetCapacity

Associated Types

type Rs DescribeFleetCapacity :: *

Methods

request :: DescribeFleetCapacity -> Request DescribeFleetCapacity

response :: MonadResource m => Logger -> Service -> Proxy * DescribeFleetCapacity -> ClientResponse -> m (Response DescribeFleetCapacity)

ToPath DescribeFleetCapacity

Methods

toPath :: DescribeFleetCapacity -> ByteString

ToHeaders DescribeFleetCapacity

Methods

toHeaders :: DescribeFleetCapacity -> [Header]

ToQuery DescribeFleetCapacity

Methods

toQuery :: DescribeFleetCapacity -> QueryString

ToJSON DescribeFleetCapacity

Methods

toJSON :: DescribeFleetCapacity -> Value

toEncoding :: DescribeFleetCapacity -> Encoding

type Rep DescribeFleetCapacity

type Rep DescribeFleetCapacity = D1 (MetaData "DescribeFleetCapacity" "Network.AWS.GameLift.DescribeFleetCapacity" "amazonka-gamelift-1.4.4-DPfJmtllByT7OdD35vBDe5" False) (C1 (MetaCons "DescribeFleetCapacity'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dfcLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dfcFleetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))))))

type Rs DescribeFleetCapacity

type Rs DescribeFleetCapacity = DescribeFleetCapacityResponse

Request Lenses

dfcNextToken :: Lens' DescribeFleetCapacity (Maybe Text)

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

dfcLimit :: Lens' DescribeFleetCapacity (Maybe Natural)

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

dfcFleetIds :: Lens' DescribeFleetCapacity (Maybe (NonEmpty Text))

Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

Destructuring the Response

describeFleetCapacityResponse

Arguments

:: Int

dfcrsResponseStatus

-> DescribeFleetCapacityResponse

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

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

• dfcrsNextToken
• dfcrsFleetCapacity
• dfcrsResponseStatus

data DescribeFleetCapacityResponse

Represents the returned data in response to a request action.

See: describeFleetCapacityResponse smart constructor.

Instances

Eq DescribeFleetCapacityResponse

Methods

(==) :: DescribeFleetCapacityResponse -> DescribeFleetCapacityResponse -> Bool

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

Data DescribeFleetCapacityResponse

Methods

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

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

toConstr :: DescribeFleetCapacityResponse -> Constr

dataTypeOf :: DescribeFleetCapacityResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeFleetCapacityResponse

Methods

readsPrec :: Int -> ReadS DescribeFleetCapacityResponse

readList :: ReadS [DescribeFleetCapacityResponse]

readPrec :: ReadPrec DescribeFleetCapacityResponse

readListPrec :: ReadPrec [DescribeFleetCapacityResponse]

Show DescribeFleetCapacityResponse

Methods

showsPrec :: Int -> DescribeFleetCapacityResponse -> ShowS

show :: DescribeFleetCapacityResponse -> String

showList :: [DescribeFleetCapacityResponse] -> ShowS

Generic DescribeFleetCapacityResponse

Associated Types

type Rep DescribeFleetCapacityResponse :: * -> *

Methods

from :: DescribeFleetCapacityResponse -> Rep DescribeFleetCapacityResponse x

to :: Rep DescribeFleetCapacityResponse x -> DescribeFleetCapacityResponse

NFData DescribeFleetCapacityResponse

Methods

rnf :: DescribeFleetCapacityResponse -> ()

type Rep DescribeFleetCapacityResponse

type Rep DescribeFleetCapacityResponse = D1 (MetaData "DescribeFleetCapacityResponse" "Network.AWS.GameLift.DescribeFleetCapacity" "amazonka-gamelift-1.4.4-DPfJmtllByT7OdD35vBDe5" False) (C1 (MetaCons "DescribeFleetCapacityResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dfcrsFleetCapacity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FleetCapacity]))) (S1 (MetaSel (Just Symbol "_dfcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dfcrsNextToken :: Lens' DescribeFleetCapacityResponse (Maybe Text)

Token indicating 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.

If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.

dfcrsFleetCapacity :: Lens' DescribeFleetCapacityResponse [FleetCapacity]

Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.

dfcrsResponseStatus :: Lens' DescribeFleetCapacityResponse Int

The response status code.