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 all 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

Data DescribeFleetCapacity

Read DescribeFleetCapacity

Show DescribeFleetCapacity

Generic DescribeFleetCapacity

ToJSON DescribeFleetCapacity

Hashable DescribeFleetCapacity

AWSRequest DescribeFleetCapacity

ToPath DescribeFleetCapacity

ToHeaders DescribeFleetCapacity

ToQuery DescribeFleetCapacity

type Rep 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. You can 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.

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

Data DescribeFleetCapacityResponse

Read DescribeFleetCapacityResponse

Show DescribeFleetCapacityResponse

Generic DescribeFleetCapacityResponse

type Rep DescribeFleetCapacityResponse

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.