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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations.

This operation can be used in the following ways:

To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.

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. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.

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

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Related actions

This operation returns paginated results.

Synopsis

data DescribeFleetCapacity = DescribeFleetCapacity' {
- nextToken :: Maybe Text
- limit :: Maybe Natural
- fleetIds :: Maybe (NonEmpty Text)
}
newDescribeFleetCapacity :: DescribeFleetCapacity
describeFleetCapacity_nextToken :: Lens' DescribeFleetCapacity (Maybe Text)
describeFleetCapacity_limit :: Lens' DescribeFleetCapacity (Maybe Natural)
describeFleetCapacity_fleetIds :: Lens' DescribeFleetCapacity (Maybe (NonEmpty Text))
data DescribeFleetCapacityResponse = DescribeFleetCapacityResponse' {
- nextToken :: Maybe Text
- fleetCapacity :: Maybe [FleetCapacity]
- httpStatus :: Int
}
newDescribeFleetCapacityResponse :: Int -> DescribeFleetCapacityResponse
describeFleetCapacityResponse_nextToken :: Lens' DescribeFleetCapacityResponse (Maybe Text)
describeFleetCapacityResponse_fleetCapacity :: Lens' DescribeFleetCapacityResponse (Maybe [FleetCapacity])
describeFleetCapacityResponse_httpStatus :: Lens' DescribeFleetCapacityResponse Int

Creating a Request

data DescribeFleetCapacity Source #

Represents the input for a request operation.

See: newDescribeFleetCapacity smart constructor.

Constructors

DescribeFleetCapacity'

Fields

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. This parameter is ignored when the request specifies one or a list of fleet IDs.
limit :: Maybe Natural
The 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.
fleetIds :: Maybe (NonEmpty Text)
A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

Instances

Instances details

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

newDescribeFleetCapacity :: DescribeFleetCapacity Source #

Create a value of DescribeFleetCapacity 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:DescribeFleetCapacity', describeFleetCapacity_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. This parameter is ignored when the request specifies one or a list of fleet IDs.

$sel:limit:DescribeFleetCapacity', describeFleetCapacity_limit - The 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.

$sel:fleetIds:DescribeFleetCapacity', describeFleetCapacity_fleetIds - A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

Request Lenses

describeFleetCapacity_nextToken :: Lens' DescribeFleetCapacity (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. This parameter is ignored when the request specifies one or a list of fleet IDs.

describeFleetCapacity_limit :: Lens' DescribeFleetCapacity (Maybe Natural) Source #

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

describeFleetCapacity_fleetIds :: Lens' DescribeFleetCapacity (Maybe (NonEmpty Text)) Source #

A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

Destructuring the Response

data DescribeFleetCapacityResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeFleetCapacityResponse smart constructor.

Constructors

DescribeFleetCapacityResponse'

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.
fleetCapacity :: Maybe [FleetCapacity]
A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeFleetCapacityResponse Source #

Arguments

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

Create a value of DescribeFleetCapacityResponse 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:DescribeFleetCapacity', describeFleetCapacityResponse_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:fleetCapacity:DescribeFleetCapacityResponse', describeFleetCapacityResponse_fleetCapacity - A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist.

$sel:httpStatus:DescribeFleetCapacityResponse', describeFleetCapacityResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetCapacityResponse_nextToken :: Lens' DescribeFleetCapacityResponse (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.

describeFleetCapacityResponse_fleetCapacity :: Lens' DescribeFleetCapacityResponse (Maybe [FleetCapacity]) Source #

A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist.

describeFleetCapacityResponse_httpStatus :: Lens' DescribeFleetCapacityResponse Int Source #

The response's http status code.